Get-DSEntryDocumentation

Synopsis

Retourner la documentation pour une entrée donnée ou la connexion racine d'un coffre.

Syntaxe

Name (Default)

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>]

Description

Retourne la documentation pour une entrée donnée ou la connexion racine d'un coffre.

Exemples

Exemple 1

PS C:\> Get-DSEntryDocumentation $entryId

Obtenir la documentation pour l'entrée identifiée par $entryId.

Exemple 2

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

Obtenir une page de documentation spécifique d'une entrée, filtrée par son nom.

Exemple 3

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

Obtenir la page de documentation par défaut d'une entrée.

Exemple 4

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

Obtenir la documentation pour la connexion racine du coffre identifié par $vaultId.

Paramètres

-AsLegacyResponse

Dans les versions antérieures à 2024.2, de nombreuses cmdlets DS retournaient un objet ServerResponse. L'activation de ce commutateur de compatibilité ascendante permet aux scripts développés pour les versions antérieures de fonctionner correctement.

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

Le filtrage sera sensible à la casse.

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

Filtrer les pages du manuel par leur contenu.

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

Obtenir uniquement la page par défaut. Maximum une page par défaut par entrée.

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 de l'entrée ou de la connexion racine du coffre.

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

Filtrer les pages du manuel par leur nom. Aucun caractère n'est interprété comme caractère générique.

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

Filtrer les pages du manuel par leur nom.

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

Cette cmdlet prend en charge les paramètres communs : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d'informations, consultez about_CommonParameters.

Entrées

System.Guid

Sortie

Devolutions.RemoteDesktopManager.Business.ConnectionHandbookPage

Notes

Pour plus d'informations, tapez "Get-Help Get-DSEntryDocumentation -detailed". Pour des informations techniques, tapez "Get-Help Get-DSEntryDocumentation -full".