OperationSpec interface

  • Référence
Paquet:
@azure/core-client

Spécification qui définit une opération.

Propriétés

baseUrl

URL fournie dans la spécification du service. Il contient toujours toutes les variables de modèle d’URL. Si cela n’est pas fourni lors de la création de OperationSpec, il est rempli par une propriété « baseUri » sur le ServiceClient.
contentType

Type de contenu du corps de la demande. Cette valeur sera utilisée comme en-tête « Content-Type » si elle est fournie.
formDataParameters

Paramètres de la méthode d’opération qui sera utilisée pour créer un corps formdata pour la requête HTTP de l’opération.
headerParameters

Paramètres de la méthode d’opération qui seront convertis en en-têtes sur la requête HTTP de l’opération.
httpMethod

Méthode HTTP qui doit être utilisée par les requêtes pour cette opération.
isXML

Indique si cette opération utilise ou non des corps de requête et de réponse XML.
mediaType

Type de média du corps de la demande. Cette valeur peut être utilisée pour aider à la sérialisation si elle est fournie.
path

Chemin fixe de l’URL de cette opération. Il contient toujours toutes les variables de modèle d’URL.
queryParameters

Paramètres de la méthode d’opération qui seront ajoutés à la requête de l’URL construite.
requestBody

Paramètre qui sera utilisé pour construire le corps de la requête HTTP.
responses

Les différents types de réponses que cette opération peut retourner en fonction du code d’état retourné.
serializer

Sérialiseur à utiliser dans cette opération.
urlParameters

Paramètres de la méthode d’opération qui seront remplacés dans l’URL construite.

Détails de la propriété

baseUrl

URL fournie dans la spécification du service. Il contient toujours toutes les variables de modèle d’URL. Si cela n’est pas fourni lors de la création de OperationSpec, il est rempli par une propriété « baseUri » sur le ServiceClient.

baseUrl?: string

Valeur de propriété

string

contentType

Type de contenu du corps de la demande. Cette valeur sera utilisée comme en-tête « Content-Type » si elle est fournie.

contentType?: string

Valeur de propriété

string

formDataParameters

Paramètres de la méthode d’opération qui sera utilisée pour créer un corps formdata pour la requête HTTP de l’opération.

formDataParameters?: readonly OperationParameter[]

Valeur de propriété

readonly OperationParameter[]

headerParameters

Paramètres de la méthode d’opération qui seront convertis en en-têtes sur la requête HTTP de l’opération.

headerParameters?: readonly OperationParameter[]

Valeur de propriété

readonly OperationParameter[]

httpMethod

Méthode HTTP qui doit être utilisée par les requêtes pour cette opération.

httpMethod: HttpMethods

Valeur de propriété

HttpMethods

isXML

Indique si cette opération utilise ou non des corps de requête et de réponse XML.

isXML?: boolean

Valeur de propriété

boolean

mediaType

Type de média du corps de la demande. Cette valeur peut être utilisée pour aider à la sérialisation si elle est fournie.

mediaType?: string

Valeur de propriété

string

path

Chemin fixe de l’URL de cette opération. Il contient toujours toutes les variables de modèle d’URL.

path?: string

Valeur de propriété

string

queryParameters

Paramètres de la méthode d’opération qui seront ajoutés à la requête de l’URL construite.

queryParameters?: readonly OperationQueryParameter[]

Valeur de propriété

readonly OperationQueryParameter[]

requestBody

Paramètre qui sera utilisé pour construire le corps de la requête HTTP.

requestBody?: OperationParameter

Valeur de propriété

OperationParameter

responses

Les différents types de réponses que cette opération peut retourner en fonction du code d’état retourné.

responses: {[responseCode: string]: OperationResponseMap}

Valeur de propriété

{[responseCode: string]: OperationResponseMap}

serializer

Sérialiseur à utiliser dans cette opération.

serializer: Serializer

Valeur de propriété

Serializer

urlParameters

Paramètres de la méthode d’opération qui seront remplacés dans l’URL construite.

urlParameters?: readonly OperationURLParameter[]

Valeur de propriété

readonly OperationURLParameter[]