Get-RDMEntryDocumentation

Synopsis

Dokumentationsseiten von Einträgen abrufen

Syntax

Name (Standard)

Get-RDMEntryDocumentation [-InputObject] <PSConnection[]> [[-Name] <string[]>] [-Data <string[]>]
 [-CaseSensitive] [-Default] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Literal

Get-RDMEntryDocumentation [-InputObject] <PSConnection[]> [[-LiteralName] <string[]>]
 [-Data <string[]>] [-CaseSensitive] [-Default] [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

Beschreibung

Dokumentationsseiten von Einträgen abrufen. Die Einträge müssen mit Get-RDMEntry abgerufen werden. Es gibt zwei Möglichkeiten, die Seiten zu filtern: nach ihrem Namen und nach ihren Daten (Inhalt). Die Datenquelle muss die Dokumentationsfunktion unterstützen und online sein. Der Benutzer muss die Rechte haben, auf die Dokumentation zuzugreifen.

Beispiele

Beispiel 1

PS C:\> $page = Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Name PageA;
    $page.Data

Rufen Sie die Dokumentationsseite mit dem Namen 'PageA' des Eintrags mit dem Namen 'EntryA' ab und sehen Sie sich ihren Inhalt an.

Beispiel 2

PS C:\> $defaultPages = Get-RDMEntry -VaultMode Global | Get-RDMEntryDocumentation -Default;
    foreach ($defaultPage in $defaultPages) { $defaultPage.Default = $false }
    Set-RDMEntryDocumentation -InputObject $defaultPages

Entfernen Sie den Standardstatus der Standard-Dokumentationsseite jedes Eintrags im System-Tresor.

Beispiel 3

PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Data '*Temporary*' -CaseSensitive | Remove-RDMEntryDocumentation

Löschen Sie alle Dokumentationsseiten des Eintrags 'EntryA', die das Wort 'Temporary' enthalten

Parameter

-CaseSensitive

Die Filterung erfolgt unter Beachtung der Groß-/Kleinschreibung.

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

Filtern Sie die Handbuchseiten nach ihrem Inhalt.

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

-Default

Nur die Standardseite abrufen. Maximal eine Standardseite pro Eintrag.

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

Schalter, der mit Vorsicht zu verwenden ist. Er beantwortet automatisch Eingabeaufforderungen, die ja/nein-, ja/nein/abbrechen- oder ok/abbrechen-Fragen stellen. Im Fall mehrerer Eingabeaufforderungen können mehrere Werte an diesen Parameter übergeben werden. Hier sind die akzeptierten Werte:

• Yes: Akzeptiert die Eingabeaufforderung. Deckt die Werte OK und Automatic ab.
• No: Lehnt die ja/nein/abbrechen-Eingabeaufforderung ab. "Cancel" ist die Ausweichoption, wenn es keine "No"-Option gibt.
• Cancel: Bricht die ja/nein/abbrechen-Eingabeaufforderung ab. "No" ist die Ausweichoption, wenn es keine "Cancel"-Option gibt.

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

-InputObject

Eintrag, aus dem die Dokumentation extrahiert werden soll.

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

-LiteralName

Filtern Sie die Handbuchseiten nach ihrem Namen. Es werden keine Zeichen interpretiert als

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Literal
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Filtern Sie die Handbuchseiten nach ihrem Namen.

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

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

Einträge, die mit Get-RDMEntry abgerufen wurden und die Dokumentation enthalten.

Hinweise

Für weitere Informationen geben Sie "Get-Help Get-RDMEntryDocumentation -detailed" ein. Für technische Informationen geben Sie "Get-Help Get-RDMEntryDocumentation -full" ein.