OperationSpec interface

  • Riferimento
Pacchetto:
@azure/ms-rest-js

Specifica che definisce un'operazione.

Proprietà

baseUrl

URL fornito nella specifica del servizio. Questa operazione includerà comunque tutte le variabili del modello di URL. Se non viene specificato quando viene creato OperationSpec, verrà popolato da una proprietà "baseUri" in ServiceClient.
contentType

Tipo di contenuto del corpo della richiesta. Questo valore verrà usato come intestazione "Content-Type" se specificato.
formDataParameters

Parametri per il metodo dell'operazione che verrà usato per creare un corpo formdata per la richiesta HTTP dell'operazione.
headerParameters

Parametri del metodo dell'operazione che verranno convertiti in intestazioni nella richiesta HTTP dell'operazione.
httpMethod

Metodo HTTP che deve essere utilizzato dalle richieste per questa operazione.
isXML

Indica se questa operazione utilizza o meno corpi di richiesta e risposta XML.
path

Percorso fisso per l'URL di questa operazione. Questa operazione includerà comunque tutte le variabili del modello di URL.
queryParameters

Parametri al metodo dell'operazione che verrà aggiunto alla query dell'URL costruito.
requestBody

Parametro che verrà usato per costruire il corpo della richiesta HTTP.
responses

I diversi tipi di risposte che questa operazione può restituire in base al codice di stato restituito.
serializer

Serializzatore da utilizzare in questa operazione.
urlParameters

Parametri del metodo dell'operazione che verranno sostituiti nell'URL costruito.

Dettagli proprietà

baseUrl

URL fornito nella specifica del servizio. Questa operazione includerà comunque tutte le variabili del modello di URL. Se non viene specificato quando viene creato OperationSpec, verrà popolato da una proprietà "baseUri" in ServiceClient.

baseUrl?: string

Valore della proprietà

string

contentType

Tipo di contenuto del corpo della richiesta. Questo valore verrà usato come intestazione "Content-Type" se specificato.

contentType?: string

Valore della proprietà

string

formDataParameters

Parametri per il metodo dell'operazione che verrà usato per creare un corpo formdata per la richiesta HTTP dell'operazione.

formDataParameters?: readonly OperationParameter[]

Valore della proprietà

readonly OperationParameter[]

headerParameters

Parametri del metodo dell'operazione che verranno convertiti in intestazioni nella richiesta HTTP dell'operazione.

headerParameters?: readonly OperationParameter[]

Valore della proprietà

readonly OperationParameter[]

httpMethod

Metodo HTTP che deve essere utilizzato dalle richieste per questa operazione.

httpMethod: HttpMethods

Valore della proprietà

HttpMethods

isXML

Indica se questa operazione utilizza o meno corpi di richiesta e risposta XML.

isXML?: boolean

Valore della proprietà

boolean

path

Percorso fisso per l'URL di questa operazione. Questa operazione includerà comunque tutte le variabili del modello di URL.

path?: string

Valore della proprietà

string

queryParameters

Parametri al metodo dell'operazione che verrà aggiunto alla query dell'URL costruito.

queryParameters?: readonly OperationQueryParameter[]

Valore della proprietà

readonly OperationQueryParameter[]

requestBody

Parametro che verrà usato per costruire il corpo della richiesta HTTP.

requestBody?: OperationParameter

Valore della proprietà

OperationParameter

responses

I diversi tipi di risposte che questa operazione può restituire in base al codice di stato restituito.

responses: {[responseCode: string]: OperationResponse}

Valore della proprietà

{[responseCode: string]: OperationResponse}

serializer

Serializzatore da utilizzare in questa operazione.

serializer: Serializer

Valore della proprietà

Serializer

urlParameters

Parametri del metodo dell'operazione che verranno sostituiti nell'URL costruito.

urlParameters?: readonly OperationURLParameter[]

Valore della proprietà

readonly OperationURLParameter[]