Update-DSEntryDocumentation

Übersicht

Aktualisiert eine Dokumentationsseite.

Syntax

InputObject

Update-DSEntryDocumentation [-InputObject] <ConnectionHandbookPage> [-Name <string>]
 [-Data <string>] [-AsLastPage] [-AsNewDefault] [-AsLegacyResponse] [<CommonParameters>]

EntryID

Update-DSEntryDocumentation [-EntryID] <guid> [-PageID] <guid> [-Name <string>] [-Data <string>]
 [-AsLastPage] [-AsNewDefault] [-AsLegacyResponse] [<CommonParameters>]

Beschreibung

Aktualisiert eine Dokumentationsseite. Nimmt entweder eine Kombination aus Eintrags- und Seiten-IDs oder ein Eingabeobjekt (abgerufen mit Get-DSEntryDocumentation).

Beispiele

Beispiel 1

PS C:\> Update-DSEntryDocumentation -EntryID $entryId -PageID $pageId -Data "My new documentation"

Aktualisieren der Daten einer bestehenden Dokumentationsseite.

Beispiel 2

PS C:\> Get-DSEntryDocumentation -ID $entryId -Name "DocToUpdate" | Update-DSEntryDocumentation -Data "My new documentation"

Aktualisieren der Daten einer bestehenden Dokumentationsseite, wobei die Seite mit Get-DSEntryDocumentation abgerufen wird.

Beispiel 3

PS C:\> $page = Get-DSEntryDocumentation -ID $entryId -Name "DocToUpdate";
    PS C:\> $page.Data = "My new documentation"
    PS C:\> Update-DSEntryDocumentation -InputObject $page

Aktualisieren der Daten einer bestehenden Dokumentationsseite, wobei die Seite mit Get-DSEntryDocumentation abgerufen und ihre Felder manuell bearbeitet werden.

Parameter

-AsLastPage

Setzt die Seite als letzte Seite.

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

-AsLegacyResponse

In Versionen vor 2024.2 gaben viele DS-Cmdlets ein ServerResponse-Objekt zurück. Die Aktivierung dieses Rückwärtskompatibilitäts-Schalters 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: ''

-AsNewDefault

Setzt die Seite als neue Standardseite.

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

Inhalt der Dokumentationsseite.

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

-EntryID

ID des Eintrags.

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

-InputObject

Dokumentationsseite, die mit Get-DSEntryDocumentation abgerufen wurde.

Type: Devolutions.RemoteDesktopManager.Business.ConnectionHandbookPage
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: InputObject
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Name der Dokumentationsseite.

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

-PageID

ID der Dokumentationsseite.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: EntryID
  Position: 1
  IsRequired: true
  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

Devolutions.RemoteDesktopManager.Business.ConnectionHandbookPage

Ausgaben

Devolutions.RemoteDesktopManager.Business.ConnectionHandbookPage

Hinweise

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