Update-DSEntryDocumentation

Synopsis

Updates a documentation page.

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

Description

Updates a documentation page. Takes either a combination of entry and page IDs, or an input object (fetched with Get-DSEntryDocumentation).

Examples

Example 1

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

Update an existing documentation page's data.

Example 2

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

Update an existing documentation page's data, with the page being fetched with Get-DSEntryDocumentation.

Example 3

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

Update an existing documentation page's data, with the page being fetched with Get-DSEntryDocumentation and its fields being manually edited.

Parameters

-AsLastPage

Set the page as the last one.

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 versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

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

Set the page as the new default one.

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

Content of the documentation page.

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 of the entry.

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

Documentation page obtained from Get-DSEntryDocumentation.

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 of the documentation page.

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 of the documentation page.

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

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Devolutions.RemoteDesktopManager.Business.ConnectionHandbookPage

Outputs

Devolutions.RemoteDesktopManager.Business.ConnectionHandbookPage

Notes

For more information, type "Get-Help Update-DSEntryDocumentation -detailed". For technical information, type "Get-Help Update-DSEntryDocumentation -full".