OperationSpec interface

Balíček:

@azure/core-http

Specifikace, která definuje, jak provést konkrétní operaci služby přes HTTP, včetně toho, jak správně serializovat informace o požadavcích do a deserializovat informace odpovědi do datové části objektu, kterou může vrátit ServiceClient.

Vlastnosti

baseUrl	Adresa URL, která byla poskytnuta ve specifikaci služby. Zůstane v něm všechny proměnné šablony adresy URL. Pokud není tato možnost zadána při vytvoření OperationSpec, pak bude naplněna vlastností "baseUri" na ServiceClient.
contentType	Typ obsahu textu požadavku. Tato hodnota se použije jako hlavička Content-Type, pokud je k dispozici.
formDataParameters	Parametry metody operace, které se použijí k vytvoření těla formdata pro požadavek HTTP operace.
headerParameters	Parametry metody operace, které budou převedeny na hlavičky v požadavku HTTP operace.
httpMethod	Metoda HTTP, kterou by měly používat požadavky na tuto operaci.
isXML	Určuje, jestli tato operace používá těla požadavků XML a odpovědí.
mediaType	Typ média v textu požadavku. Tuto hodnotu lze použít k odpojetí při serializaci, pokud je k dispozici.
path	Pevná cesta pro adresu URL této operace. Zůstane v něm všechny proměnné šablony adresy URL.
queryParameters	Parametry metody operace, které budou přidány do dotazu vytvořené adresy URL.
requestBody	Parametr, který se použije k vytvoření textu požadavku HTTP.
responses	Různé typy odpovědí, které tato operace může vrátit na základě vráceného stavového kódu.
serializer	Serializátor, který se má použít v této operaci.
urlParameters	Parametry metody operace, které budou nahrazeny vytvořenou adresou URL.

Podrobnosti vlastnosti

baseUrl

Adresa URL, která byla poskytnuta ve specifikaci služby. Zůstane v něm všechny proměnné šablony adresy URL. Pokud není tato možnost zadána při vytvoření OperationSpec, pak bude naplněna vlastností "baseUri" na ServiceClient.

baseUrl?: string

Hodnota vlastnosti

string

contentType

Typ obsahu textu požadavku. Tato hodnota se použije jako hlavička Content-Type, pokud je k dispozici.

contentType?: string

Hodnota vlastnosti

string

formDataParameters

Parametry metody operace, které se použijí k vytvoření těla formdata pro požadavek HTTP operace.

formDataParameters?: readonly OperationParameter[]

Hodnota vlastnosti

readonly OperationParameter[]

headerParameters

Parametry metody operace, které budou převedeny na hlavičky v požadavku HTTP operace.

headerParameters?: readonly OperationParameter[]

Hodnota vlastnosti

readonly OperationParameter[]

httpMethod

Metoda HTTP, kterou by měly používat požadavky na tuto operaci.

httpMethod: HttpMethods

Hodnota vlastnosti

HttpMethods

isXML

Určuje, jestli tato operace používá těla požadavků XML a odpovědí.

isXML?: boolean

Hodnota vlastnosti

boolean

mediaType

Typ média v textu požadavku. Tuto hodnotu lze použít k odpojetí při serializaci, pokud je k dispozici.

mediaType?: string

Hodnota vlastnosti

string

path

Pevná cesta pro adresu URL této operace. Zůstane v něm všechny proměnné šablony adresy URL.

path?: string

Hodnota vlastnosti

string

queryParameters

Parametry metody operace, které budou přidány do dotazu vytvořené adresy URL.

queryParameters?: readonly OperationQueryParameter[]

Hodnota vlastnosti

readonly OperationQueryParameter[]

requestBody

Parametr, který se použije k vytvoření textu požadavku HTTP.

requestBody?: OperationParameter

Hodnota vlastnosti

OperationParameter

responses

Různé typy odpovědí, které tato operace může vrátit na základě vráceného stavového kódu.

responses: {[responseCode: string]: OperationResponse}

Hodnota vlastnosti

{[responseCode: string]: OperationResponse}

serializer

Serializátor, který se má použít v této operaci.

serializer: Serializer

Hodnota vlastnosti

Serializer

urlParameters

Parametry metody operace, které budou nahrazeny vytvořenou adresou URL.

urlParameters?: readonly OperationURLParameter[]

Hodnota vlastnosti

readonly OperationURLParameter[]