Remove-RDMSessionDocumentation
Übersicht
Entfernt die Dokumentation einer Sitzung.
Syntax
NamePage (Standard)
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
NameHandbook
SessionHandbook
IDPage
SessionPage
Beschreibung
Sie müssen über das Recht zum Löschen verfügen. Es gibt drei Möglichkeiten, die Dokumentation einer Sitzung zu entfernen. Der Schalter All wird verwendet, um die gesamte Dokumentation zu entfernen. Der Parameter Handbook verwendet die über das Cmdlet Get-RDMDocumentation abgerufene Dokumentation. Der Parameter Name ermöglicht das Löschen aller Seiten mit dem eingegebenen Namen. Der Benutzer wird aufgefordert, das Löschen zu bestätigen.
Beispiele
Beispiel 1
Entfernt die gesamte Dokumentation in der Root-Sitzung der aktuellen Datenquelle. Der Benutzer wird zur Bestätigung aufgefordert.
Beispiel 2
Entfernt die Dokumentationsseite "APage" aus der Sitzung "ASession", ohne den Benutzer zur Bestätigung aufzufordern.
Beispiel 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
Entfernt alle Dokumentationsseiten außer der Standardseite aus der Sitzung mit der ID = 00000000-0000-0000-0000-000000000000 der aktuellen Datenquelle. Der Benutzer wird vor dem Löschen einer Seite zur Bestätigung aufgefordert.
Parameter
-All
Löscht die gesamte vorhandene Dokumentation der Sitzung.
-Confirm
Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.
-Force
Löscht die Dokumentation ohne Bestätigung.
-ForcePromptAnswer
Schalter, der mit Vorsicht verwendet werden sollte. Er beantwortet automatisch Eingabeaufforderungen mit Ja/Nein-, Ja/Nein/Abbrechen- oder OK/Abbrechen-Fragen. Bei mehreren Eingabeaufforderungen können mehrere Werte an diesen Parameter übergeben werden. Folgende Werte werden akzeptiert:
Yes: Nimmt die Eingabeaufforderung an. Deckt die Werte OK und Automatic ab.
No: Lehnt die Ja/Nein/Abbrechen-Eingabeaufforderung ab. "Cancel" ist die Ausweichoption, wenn keine "No"-Option vorhanden ist.
Cancel: Bricht die Ja/Nein/Abbrechen-Eingabeaufforderung ab. "No" ist die Ausweichoption, wenn keine "Cancel"-Option vorhanden ist.
-Handbook
Gibt die zu löschende Dokumentation an.
-ID
ID der Sitzung der aktuellen Datenquelle, aus der die Dokumentation gelöscht werden soll.
-Name
Name der Sitzung der aktuellen Datenquelle, aus der die Dokumentation extrahiert werden soll.
-Page
Gibt die zu löschende Dokumentationsseite an.
-Refresh
Sendet eine Aktualisierungsbenachrichtigung an die Anwendung Remote Desktop Manager.
-Session
Sitzung, in der die Dokumentation gelöscht wird.
-WhatIf
Zeigt, was geschehen würde, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
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.
Hinweise
Für weitere Informationen geben Sie "Get-Help Remove-RDMSessionDocumentation -detailed" ein. Für technische Informationen geben Sie "Get-Help Remove-RDMSessionDocumentation -full" ein.
Zuletzt aktualisiert
War das hilfreich?