New-PSUApiResponse

ÜBERSICHT

Gibt eine benutzerdefinierte API-Antwort von einer PowerShell Universal REST-API zurück.

SYNTAX

Body (Standard)

New-PSUApiResponse [-StatusCode <Int32>] [-Body <String>] [-Cookies <Hashtable>] [-ContentType <String>]
 [-Headers <Hashtable>] [<CommonParameters>]

Data

New-PSUApiResponse [-StatusCode <Int32>] [-Cookies <Hashtable>] [-Data <Byte[]>] [-ContentType <String>]
 [-Headers <Hashtable>] [<CommonParameters>]

BESCHREIBUNG

Gibt eine benutzerdefinierte API-Antwort von einer PowerShell Universal REST-API zurück. Dieses Cmdlet sollte innerhalb des in New-PSUEndpoint definierten -Endpoint-Skriptblocks aufgerufen werden.

BEISPIELE

Beispiel 1

New-PSUEndpoint -Url '/hello' -Method "GET" -Endpoint {
    New-PSUApiResponse -StatusCode 404 -Body "Not found!"
}

Gibt einen 404-Statuscode vom /hello-Endpunkt zurück, wenn die GET-Methode aufgerufen wird. Hier wird auch ein benutzerdefinierter Body angegeben.

PARAMETER

-Body

Der Body der Antwort, die von der Endpunktanfrage zurückgesendet wird.

Type: String
Parameter Sets: Body
Aliases:

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

-ContentType

Der Content-Type-Header, der für die Antwort des Endpunkts gesetzt wird.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cookies

Eine Hashtabelle mit Cookies, die in der HTTP-Antwort gesetzt werden.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Data

Binärdaten, die vom Endpunkt zurückgegeben werden. Damit können Binärdateien an den Benutzer zurückgesendet werden.

Type: Byte[]
Parameter Sets: Data
Aliases:

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

-StatusCode

Der HTTP-Statuscode, der für diese Antwort gesetzt wird. Der Standardwert ist 200.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Headers

Eine Hashtabelle mit Headern, die von der API-Anfrage zurückgegeben werden.

Type: Hashtable
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.