New-PSUEndpointDocumentation

ÜBERSICHT

Erstellt eine neue Endpunkt-Dokumentationsdefinition.

SYNTAX

New-PSUEndpointDocumentation -Name <String> [-Description <String>] [-Authentication] [-Role <String[]>]
 [-Definition <ScriptBlock>] -Url <String> [-ContactName <String>] [-ContactEmail <String>]
 [-ContactUrl <String>] [-Version <String>] [-LicenseUrl <String>] [-LicenseName <String>]
 [-TermsOfServiceUrl <String>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

BESCHREIBUNG

Erstellt eine neue Endpunkt-Dokumentationsdefinition.

BEISPIELE

Beispiel 1

PS C:\> New-PSUEndpointDocumentation -Name 'PSUHelp' -Url '/psuhelp'

Erstellt eine Hilfedefinition unter /psuhelp.

PARAMETER

-AppToken

Ein App-Token für den Zugriff auf die UA-API.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Authentication

Ob eine Authentifizierung für den Zugriff auf diese Dokumentationsdefinition erforderlich ist.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Die HTTP-Adresse des UA REST-API-Servers.

Type: String
Parameter Sets: (All)
Aliases: Uri

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Definition

Klassen, die für Eingabe- und Ausgabetypen dieser Endpunkt-Dokumentation definiert sind.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Eine Beschreibung der Dokumentation.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Integrated

Führt den Befehl intern aus, anstatt die Management-API zu verwenden. Funktioniert nur, wenn das Skript innerhalb von PowerShell Universal ausgeführt wird.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name dieser Dokumentationsdefinition.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Role

Rollen, die diese Dokumentation anzeigen dürfen.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Url

Die URL, über die auf diese Dokumentation zugegriffen wird.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseDefaultCredentials

Standard-Anmeldeinformationen bei der Verbindung mit der Management-API verwenden

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Anmeldeinformationen für die Anmeldung an der PowerShell Universal Management-API.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrustCertificate

Ob das Cmdlet Zertifikatsprobleme ignorieren soll.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContactEmail

Gibt die in der API-Dokumentation angezeigte Kontakt-E-Mail-Adresse an.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContactName

Gibt den in der API-Dokumentation angezeigten Kontaktnamen an.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContactUrl

Gibt die URL für die API-Kontaktinformationen an.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LicenseName

Gibt den in der API-Dokumentation angezeigten Lizenznamen an.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LicenseUrl

Gibt die in der API-Dokumentation angezeigte Lizenz-URL an.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TermsOfServiceUrl

Gibt die URL des Nutzungsbedingungsdokuments an.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Version

Gibt den Versionswert für die Ressource an.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Cookies

Verwendet und speichert Authentifizierungscookies für die aktuelle PowerShell-Sitzung.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable und -ProgressAction. Weitere Informationen finden Sie unter about_CommonParameters.