Get-DSEntryDocumentation

Übersicht

Gibt die Dokumentation für einen bestimmten Eintrag oder eine Tresor-Root-Verbindung zurück.

Syntax

Name (Standard)

Get-DSEntryDocumentation [-ID] <guid> [[-Name] <string[]>] [-Data <string[]>] [-CaseSensitive]
 [-Default] [-AsLegacyResponse] [<CommonParameters>]

Literal

Get-DSEntryDocumentation [-ID] <guid> [[-LiteralName] <string[]>] [-Data <string[]>]
 [-CaseSensitive] [-Default] [-AsLegacyResponse] [<CommonParameters>]

Beschreibung

Gibt die Dokumentation für einen bestimmten Eintrag oder eine Tresor-Root-Verbindung zurück.

Beispiele

Beispiel 1

PS C:\> Get-DSEntryDocumentation $entryId

Ruft die Dokumentation für den durch $entryId identifizierten Eintrag ab.

Beispiel 2

PS C:\> Get-DSEntryDocumentation $entryId -Name "PageName"

Ruft eine bestimmte Dokumentationsseite aus einem Eintrag ab, gefiltert nach ihrem Namen.

Beispiel 3

PS C:\> Get-DSEntryDocumentation $entryId -Default

Ruft die Standard-Dokumentationsseite eines Eintrags ab.

Beispiel 4

PS C:\> Get-DSRootSession -VaultID $vaultId | Select-Object -ExpandProperty id | Get-DSEntryDocumentation

Ruft die Dokumentation für die Tresor-Root-Verbindung eines durch $vaultId identifizierten Tresors ab.

Parameter

-AsLegacyResponse

In Versionen vor 2024.2 gaben viele DS-Cmdlets ein ServerResponse-Objekt zurück. Das Aktivieren dieses Schalters für Rückwärtskompatibilität ermöglicht es, dass für frühere Versionen entwickelte Skripte korrekt funktionieren.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-CaseSensitive

Die Filterung erfolgt unter Beachtung der Groß- und Kleinschreibung.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Data

Filtert die Handbuchseiten nach ihrem Inhalt.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Default

Ruft nur die Standardseite ab. Maximal eine Standardseite pro Eintrag.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ID

ID des Eintrags oder der Tresor-Root-Verbindung.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-LiteralName

Filtert die Handbuchseiten nach ihrem Namen. Es werden keine Zeichen als Platzhalter interpretiert.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Literal
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Filtert die Handbuchseiten nach ihrem Namen.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen finden Sie unter about_CommonParameters.

Eingaben

System.Guid

Ausgaben

Devolutions.RemoteDesktopManager.Business.ConnectionHandbookPage

Hinweise

Weitere Informationen erhalten Sie mit "Get-Help Get-DSEntryDocumentation -detailed". Technische Informationen erhalten Sie mit "Get-Help Get-DSEntryDocumentation -full".