New-PSUApiResponse

SINOPSIS

Devuelve una respuesta de API personalizada desde una API REST de PowerShell Universal.

SINTAXIS

Body (Predeterminado)

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>]

DESCRIPCIÓN

Devuelve una respuesta de API personalizada desde una API REST de PowerShell Universal. Este cmdlet debe llamarse dentro del bloque de script -Endpoint definido en New-PSUEndpoint.

EJEMPLOS

Ejemplo 1

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

Devuelve un código de estado 404 desde el endpoint /hello cuando se llama al método GET. Esto también especifica un cuerpo personalizado.

PARÁMETROS

-Body

El cuerpo de la respuesta que se enviará de vuelta desde la solicitud al endpoint.

Type: String
Parameter Sets: Body
Aliases:

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

-ContentType

La cabecera content-type que se establecerá en la respuesta del endpoint.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cookies

Una tabla hash de cookies que se establecerán en la respuesta HTTP.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Data

Datos binarios que se devolverán desde el endpoint. Esto puede utilizarse para enviar ficheros binarios de vuelta al usuario.

Type: Byte[]
Parameter Sets: Data
Aliases:

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

-StatusCode

El código de estado HTTP que se establecerá para esta respuesta. El valor predeterminado es 200.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Headers

Una tabla hash de cabeceras que se devolverán desde la solicitud a la API.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable y -ProgressAction. Para más información, consulte about_CommonParameters.

ENTRADAS

Ninguna

SALIDAS

System.Object

NOTAS

VÍNCULOS RELACIONADOS

New-PSUEndpoint