New-PSUEndpoint

SYNOPSIS

Erstellt einen neuen REST-API-Endpunkt.

SYNTAX

Endpunkt

New-PSUEndpoint [-Method <String[]>] -Url <String> [-Description <String>] -Endpoint <ScriptBlock>
 [-Path <String>] [-Authentication] [-Role <String[]>] [-RegEx] [-Tag <Tag[]>] [-Timeout <Int32>]
 [-Environment <String>] [-PersistentLog] [-Documentation <String>] [-Module <String>] [-Command <String>]
 [-Credential <String>] [-ComputerGroup <String[]>] [-AvailableInBranch <String[]>] [-Disabled]
 [-ExecutionRole <String[]>] [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
 [-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]

Pfad

New-PSUEndpoint [-Method <String[]>] -Url <String> [-Description <String>] -Path <String> [-Authentication]
 [-Role <String[]>] [-RegEx] [-Tag <Tag[]>] [-Timeout <Int32>] [-Environment <String>] [-PersistentLog]
 [-Documentation <String>] [-Module <String>] [-Command <String>] [-Credential <String>]
 [-ComputerGroup <String[]>] [-AvailableInBranch <String[]>] [-Disabled] [-ExecutionRole <String[]>]
 [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
 [-Cookies] [<CommonParameters>]

Modul

New-PSUEndpoint [-Method <String[]>] -Url <String> [-Description <String>] [-Authentication] [-Role <String[]>]
 [-RegEx] [-Tag <Tag[]>] [-Timeout <Int32>] [-Environment <String>] [-PersistentLog] [-Documentation <String>]
 -Module <String> -Command <String> [-Credential <String>] [-ComputerGroup <String[]>]
 [-AvailableInBranch <String[]>] [-Disabled] [-ExecutionRole <String[]>] [-ComputerName <String>]
 [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

BESCHREIBUNG

Erstellt einen neuen REST-API-Endpunkt.

Dieses Cmdlet ist ein Konfigurations-Cmdlet. Sie können es mit dem Konfigurationssystem von PowerShell Universal sowie mit der PowerShell Universal Management-API verwenden. Endpunkte werden in der Datei ./universal/endpoints.ps1 gespeichert.

BEISPIELE

Beispiel 1

New-PSUEndpoint -Url "/hello" -Method GET -Endpoint {
    "Hello"
}
PS C:\> Invoke-RestMethod http://localhost:5000/hello

Erstellt einen REST-API-Endpunkt, der "Hello" zurückgibt, wenn der Benutzer ihn über die HTTP-Methode GET aufruft.

Beispiel 2

New-PSUEndpoint -Url "/hello/:variable" -Method GET -Endpoint {
    $Variable
}

PS C:\> Invoke-RestMethod http://localhost:5000/hello/world

Erstellt eine REST-API, die Variablen verwendet. Variablen ermöglichen es Benutzern, Daten an die REST-API zu übergeben. Sie erscheinen als PowerShell-Variablen innerhalb des Endpunkt-Skriptblocks.

Beispiel 3

New-PSUEndpoint -Url "/hello/" -Method GET -Endpoint {
    "Hello authenticated user"
} -Authentication -Role 'Administrators'

PS C:\> Invoke-RestMethod http://localhost:5000/hello/world -Headers @{ Authorization = "Bearer appTokenGoesHere" }

Erstellt eine REST-API, die Authentifizierung und Autorisierung erfordert. Nur Benutzer mit einem gültigen AppToken können auf diesen Endpunkt zugreifen und nur Benutzer, die die Rolle Administrators innehaben.

Beispiel 4

New-PSUEndpoint -Url "/hello/" -Method GET -Endpoint {
    "Hello user"
} -ComputerName http://localhost:5000 -AppToken 'appToken'

PS C:\> Invoke-RestMethod http://localhost:5000/hello/world -Headers @{ Authorization = "Bearer appTokenGoesHere" }

Erstellt eine REST-API mit der PowerShell Universal Management-API. Beim Aufrufen der Management-API müssen Sie den Computernamen und das App-Token definieren, um die API erfolgreich aufzurufen.

PARAMETER

-AppToken

Das AppToken, das für den Aufruf der PowerShell Universal Management-API verwendet wird. Sie können auch Connect-PSUServer vor dem Aufruf dieses Cmdlets aufrufen, um das AppToken für die gesamte Sitzung festzulegen.

Type: String
Parameter Sets: (All)
Aliases:

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

-Authentication

Gibt an, ob dieser Endpunkt Authentifizierung erfordert. Authentifizierung erfordert eine API-Lizenz.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ComputerName

Gibt den Computernamen oder die URL an, die beim Zugriff auf die PowerShell Universal Management-API aufgerufen werden soll. Sie können auch Connect-PSUServer vor dem Aufruf dieses Cmdlets verwenden, um den Computernamen für die gesamte Sitzung festzulegen.

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

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

-Endpoint

Der Inhalt des Endpunkts. Dies ist das PowerShell-Skript, das aufgerufen wird, wenn die REST-API ausgeführt wird.

Type: ScriptBlock
Parameter Sets: Endpoint
Aliases:

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

-Method

Die HTTP-Methoden, die für den Aufruf dieses Endpunkts erforderlich sind.

Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: GET, POST, PUT, DELETE, OPTIONS

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

-RegEx

Gibt an, ob die angegebene URL als RegEx-Zeichenfolge und nicht als literale URL verarbeitet werden soll.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Role

Gibt die Rolle an, die für den Zugriff auf diesen Endpunkt erforderlich ist. Der Parameter -Authentication sollte ebenfalls angegeben werden, wenn der Parameter -Role verwendet wird. Rollen erfordern eine API-Lizenz.

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

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

-Url

Die URL des Endpunkts. Diese URL kann ein RegEx-Ausdruck sein, wenn Sie den Switch-Parameter -RegEx angeben. Diese URL kann auch Variablen mit dem Doppelpunkt-Präfix (:) enthalten.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

Eine Beschreibung für den Endpunkt, die in der Konsole angezeigt wird.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
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

-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

-Tag

Tags für diesen Endpunkt.

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

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

-Timeout

Das Timeout in Sekunden für diesen API-Endpunkt. 0 oder nicht definiert bedeutet kein Timeout.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Path

Der Pfad zu einer PS1-Datei, die den Inhalt dieses Endpunkts enthält.

Type: String
Parameter Sets: Endpoint
Aliases:

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

Type: String
Parameter Sets: Path
Aliases:

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

-Environment

Die Umgebung, in der dieser Endpunkt ausgeführt wird.

Type: String
Parameter Sets: (All)
Aliases:

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

-PersistentLog

Ob das Protokoll für diesen Endpunkt in der Datenbank gespeichert werden soll.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Documentation

Die Dokumentationsdefinition, mit der dieser Endpunkt verknüpft werden soll.

Type: String
Parameter Sets: (All)
Aliases:

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

-Command

Der Befehl, der den Inhalt dieses Endpunkts definiert.

Type: String
Parameter Sets: Endpoint, Path
Aliases:

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

Type: String
Parameter Sets: Module
Aliases:

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

-Module

Das Modul, das den Befehl enthält, der den Inhalt dieses Endpunkts definiert.

Type: String
Parameter Sets: Endpoint, Path
Aliases:

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

Type: String
Parameter Sets: Module
Aliases:

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

-ComputerGroup

Die Computergruppe, auf der dieser Endpunkt ausgeführt werden soll.

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

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

-AvailableInBranch

Wenn angegeben, ist der Endpunkt nur in den angegebenen Branches verfügbar.

Type: String[]
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: String
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

-Disabled

Deaktiviert den Endpunkt. Der Endpunkt ist nicht verfügbar, bis er aktiviert wird.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Cookies

Verwendet und speichert Authentifizierungs-Cookies 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

-ExecutionRole

Gibt eine oder mehrere Rollen an, die die Ressource ausführen können.

Type: String[]
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.