Remove-RDMSessionDocumentation

Synopsis

Supprimer la documentation d'une session.

Syntaxe

NamePage (Default)

Remove-RDMSessionDocumentation [[-Name] <string>] [-Page] <string> [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

IDAll

Remove-RDMSessionDocumentation [-ID] <guid> -All [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

NameAll

Remove-RDMSessionDocumentation [[-Name] <string>] -All [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

SessionAll

Remove-RDMSessionDocumentation [-Session] <PSConnection> -All [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

IDHandbook

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

NameHandbook

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

SessionHandbook

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

IDPage

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

SessionPage

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

Description

Vous devez disposer du droit de suppression. Trois possibilités existent pour supprimer la documentation d'une session. Le commutateur All permet de supprimer toute la documentation. Le paramètre Handbook utilise la documentation récupérée via la cmdlet Get-RDMDocumentation. Le paramètre Name permet de supprimer toutes les pages portant le nom saisi. L'utilisateur sera invité à confirmer la suppression.

Exemples

Exemple 1

PS C:\> Get-RDMRootSession | Remove-RDMSessionDocumentation -All

Supprimer toute la documentation dans la session racine de l'espace de travail actuel. L'utilisateur sera invité à confirmer.

Exemple 2

PS C:\> Remove-RDMSessionDocumentation -Name "ASession" -Page "APage" -Force

Supprimer la page de documentation « APage » de la session « ASession » sans inviter l'utilisateur à confirmer.

Exemple 3

PS C:\ $id = [Guid]"00000000-0000-0000-0000-000000000000"; $doc = Get-RDMSessionDocumentation -ID $id; $doc.Pages = ($doc.Pages | Where-Object { $_.Default -ne $true }); Remove-RDMSessionDocumentation -ID $id -Handbook $doc -Refresh

Supprimer toutes les pages de documentation à l'exception de la page par défaut de la session dont l'ID est 00000000-0000-0000-0000-000000000000 dans l'espace de travail actuel. L'utilisateur sera invité à confirmer avant la suppression de chaque page.

Paramètres

-All

Supprimer toute la documentation existante de la session.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: IDAll
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: NameAll
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: SessionAll
  Position: Named
  IsRequired: true
  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: ''

-Force

Supprimer 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

Commutateur à utiliser avec prudence. Il répondra automatiquement aux invites posant des questions oui/non, oui/non/annuler ou ok/annuler. En cas d'invites multiples, plusieurs valeurs peuvent être passées à ce paramètre. Voici les valeurs acceptées :

• Yes : Accepter l'invite. Couvre les valeurs OK et Automatic.
• No : Refuser l'invite oui/non/annuler. « Cancel » est l'option de repli s'il n'existe pas d'option « No ».
• Cancel : Annuler l'invite oui/non/annuler. « No » est l'option de repli s'il n'existe 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écifie la documentation à supprimer.

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 dont la documentation doit être supprimée.

Type: System.Nullable`1[System.Guid]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: IDAll
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IDHandbook
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IDPage
  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 dont la documentation doit être extraite.

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

-Page

Spécifie la page de documentation à supprimer.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: IDPage
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: NamePage
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: SessionPage
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  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 dont la documentation sera supprimée.

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

-WhatIf

Indique 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 Remove-RDMSessionDocumentation -detailed ». Pour des informations techniques, tapez « Get-Help Remove-RDMSessionDocumentation -full ».