New-PSUApiResponse

SYNOPSIS

Retourne une réponse d'API personnalisée à partir d'une API REST PowerShell Universal.

SYNTAXE

Body (par défaut)

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

DESCRIPTION

Retourne une réponse d'API personnalisée à partir d'une API REST PowerShell Universal. Cette applet de commande doit être appelée dans le bloc de script -Endpoint défini dans New-PSUEndpoint.

EXEMPLES

Exemple 1

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

Retourne un code de statut 404 depuis le terminal /hello lorsque la méthode GET est appelée. Ceci spécifie également un corps personnalisé.

PARAMÈTRES

-Body

Le corps de la réponse à renvoyer à partir de la requête du terminal.

Type: String
Parameter Sets: Body
Aliases:

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

-ContentType

L'en-tête content-type à définir sur la réponse du terminal.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cookies

Une table de hachage de témoins à définir dans la réponse HTTP.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Data

Données binaires à retourner à partir du terminal. Ceci peut être utilisé pour renvoyer des fichiers binaires à l'utilisateur.

Type: Byte[]
Parameter Sets: Data
Aliases:

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

-StatusCode

Le code de statut HTTP à définir pour cette réponse. La valeur par défaut est 200.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Headers

Une table de hachage d'en-têtes à retourner à partir de la requête d'API.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

CommonParameters

Cette applet de commande prend en charge les paramètres communs : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable et -ProgressAction. Pour plus d'informations, consultez about_CommonParameters.

ENTRÉES

Aucune

SORTIES

System.Object

NOTES

LIENS CONNEXES

New-PSUEndpoint