Set-RDMSessionDocumentation

Synopsis

Définir la documentation d'une session.

Syntaxe

NameHandbook (Default)

Set-RDMSessionDocumentation [[-Name] <string>] [-Handbook] <PSHandbook> [-AsLastPage] [-Force]
 [-Refresh] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

IDHandbook

Set-RDMSessionDocumentation [-ID] <guid> [-Handbook] <PSHandbook> [-AsLastPage] [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

SessionHandbook

Set-RDMSessionDocumentation [-Session] <PSConnection> [-Handbook] <PSHandbook> [-AsLastPage]
 [-Force] [-Refresh] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

IDDefaultPage

Set-RDMSessionDocumentation [-ID] <guid> [[-DefaultPage] <string>] [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

NameDefaultPage

Set-RDMSessionDocumentation [[-Name] <string>] [[-DefaultPage] <string>] [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

SessionDefaultPage

Set-RDMSessionDocumentation [-Session] <PSConnection> [[-DefaultPage] <string>] [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Vous devez disposer du droit d'ajout et de modification. La documentation doit d'abord être récupérée via la cmdlet Get-RDMSessionDocumentation. Si la documentation provient d'une autre session, toutes les pages seront créées. L'utilisateur sera invité à confirmer uniquement avant la mise à jour des pages.

Exemples

Exemple 1

PS C:\> Get-RDMRootSession | Get-RDMSessionDocumentation | Set-RDMSessionDocumentation -Session (Get-RDMSession -Name "ASession")

Copier la documentation depuis la racine de l'espace de travail actuel vers la session « ASession ».

Exemple 2

PS C:\> $sess = Get-RDMSession -Name "ASession"; Get-RDMDataSource -Name "AnotherWorkspace" | Set-RDMCurrentDataSource; Get-RDMRootSession | Get-RDMSessionDocumentation | Set-RDMSessionDocumentation -Session $sess)

Copier la documentation depuis la session racine de « AnotherWorkspace » vers la session « ASession » de l'espace de travail précédent.

Exemple 3

PS C:\> Set-RDMSessionDocumentation -Name ASession -DefaultPage NewDefaultPage -Force)

Modifier la page de documentation par défaut de la session ASession en NewDefaultPage.

Paramètres

-AsLastPage

Ajouter les pages créées à la fin.

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

-Confirm

Vous invite à confirmer avant d'exécuter la cmdlet.

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

-DefaultPage

Définir une nouvelle page par défaut dans la documentation.

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

-Force

Mettre à jour la documentation sans confirmation.

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: ''

-ForcePromptAnswer

Paramètre à utiliser avec précaution. Il répondra automatiquement aux invites posant des questions oui/non, oui/non/annuler ou OK/annuler. En cas de plusieurs invites, plusieurs valeurs peuvent être transmises à ce paramètre. Voici les valeurs acceptées :

• Yes : Accepter l'invite. Couvre les valeurs OK et Automatique.
• No : Refuser l'invite oui/non/annuler. « Cancel » est l'option de repli s'il n'y a pas d'option « No ».
• Cancel : Annuler l'invite oui/non/annuler. « No » est l'option de repli s'il n'y a pas d'option « Cancel ».

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

-Handbook

Spécifier la documentation à définir.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSHandbook
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: IDHandbook
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: NameHandbook
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: SessionHandbook
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ID

ID de la session de l'espace de travail actuel où la documentation sera définie.

Type: System.Nullable`1[System.Guid]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: IDDefaultPage
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IDHandbook
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Nom de la session de l'espace de travail actuel où la documentation sera définie.

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

-Refresh

Envoyer une notification d'actualisation à l'application Remote Desktop Manager.

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: ''

-Session

Session où la documentation sera définie.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: SessionHandbook
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: SessionDefaultPage
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Affiche ce qui se passerait si la cmdlet s'exécutait. La cmdlet n'est pas exécutée.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  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.

Notes

Pour plus d'informations, tapez « Get-Help Set-RDMSessionDocumentation -detailed ». Pour des informations techniques, tapez « Get-Help Set-RDMSessionDocumentation -full ».