Remove-DSEntryDocumentation

Synopsis

Removes a documentation page.

Syntax

__AllParameterSets

Remove-DSEntryDocumentation [-ID] <guid> [-AsLegacyResponse] [<CommonParameters>]

Description

Removes a documentation page.

Examples

Example 1

1

PS C:\> Remove-DSEntryDocumentation $pageId

Remove a documentation page identified by $pageId.

Example 2

2

PS C:\> Get-DSEntryDocumentation -ID $entryId -Name "DocToDelete" | Select-Object -ExpandProperty ID | Remove-DSEntryDocumentation

Remove a given documentation page for the entry identified by $entryId.

Parameters

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

-ID

ID of the documentation page to remove.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  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

System.Guid

Notes

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