OperationSpec interface

Csomag:

@azure/core-http

Egy specifikáció, amely meghatározza, hogyan hajthat végre egy adott szolgáltatásműveletet HTTP-en keresztül, beleértve a kérésadatok megfelelő szerializálását és a válaszinformációk deszerializálását a ServiceClient által visszaadható objektum hasznos adatává.

Tulajdonságok

baseUrl	A szolgáltatás specifikációjában megadott URL-cím. Ez továbbra is tartalmazza az URL-sablon összes változóját. Ha ez nem történik meg az OperationSpec létrehozásakor, akkor a ServiceClient "baseUri" tulajdonsága tölti ki.
contentType	A kérelem törzsének tartalomtípusa. Ez az érték "Content-Type" fejlécként lesz használva, ha meg van adva.
formDataParameters	A műveletmetódus paraméterei, amelyek a művelet HTTP-kérésének űrlapadattörzsének létrehozásához lesznek felhasználva.
headerParameters	A művelet metódusának paraméterei, amelyek fejlécekké lesznek konvertálva a művelet HTTP-kérésében.
httpMethod	A művelet kérései által használandó HTTP-metódus.
isXML	Azt jelzi, hogy ez a művelet XML-kérés- és választörzseket használ-e.
mediaType	A kérelemtörzs médiatípusa. Ez az érték a szerializálásban való segédkezésre használható, ha meg van adva.
path	A művelet URL-címének rögzített elérési útja. Ez továbbra is tartalmazza az URL-sablon összes változóját.
queryParameters	A műveletmetódus paraméterei, amelyeket a rendszer hozzáad a létrehozott URL-lekérdezéshez.
requestBody	A HTTP-kérelem törzsének létrehozásához használt paraméter.
responses	A művelet által visszaadott különböző típusú válaszok a visszaadott állapotkód alapján.
serializer	Az ebben a műveletben használni kívánt szerializáló.
urlParameters	A műveletmetódus paraméterei, amelyeket a rendszer a létrehozott URL-címmel helyettesít.

Tulajdonság adatai

baseUrl

A szolgáltatás specifikációjában megadott URL-cím. Ez továbbra is tartalmazza az URL-sablon összes változóját. Ha ez nem történik meg az OperationSpec létrehozásakor, akkor a ServiceClient "baseUri" tulajdonsága tölti ki.

baseUrl?: string

Tulajdonság értéke

string

contentType

A kérelem törzsének tartalomtípusa. Ez az érték "Content-Type" fejlécként lesz használva, ha meg van adva.

contentType?: string

Tulajdonság értéke

string

formDataParameters

A műveletmetódus paraméterei, amelyek a művelet HTTP-kérésének űrlapadattörzsének létrehozásához lesznek felhasználva.

formDataParameters?: readonly OperationParameter[]

Tulajdonság értéke

readonly OperationParameter[]

headerParameters

A művelet metódusának paraméterei, amelyek fejlécekké lesznek konvertálva a művelet HTTP-kérésében.

headerParameters?: readonly OperationParameter[]

Tulajdonság értéke

readonly OperationParameter[]

httpMethod

A művelet kérései által használandó HTTP-metódus.

httpMethod: HttpMethods

Tulajdonság értéke

HttpMethods

isXML

Azt jelzi, hogy ez a művelet XML-kérés- és választörzseket használ-e.

isXML?: boolean

Tulajdonság értéke

boolean

mediaType

A kérelemtörzs médiatípusa. Ez az érték a szerializálásban való segédkezésre használható, ha meg van adva.

mediaType?: string

Tulajdonság értéke

string

path

A művelet URL-címének rögzített elérési útja. Ez továbbra is tartalmazza az URL-sablon összes változóját.

path?: string

Tulajdonság értéke

string

queryParameters

A műveletmetódus paraméterei, amelyeket a rendszer hozzáad a létrehozott URL-lekérdezéshez.

queryParameters?: readonly OperationQueryParameter[]

Tulajdonság értéke

readonly OperationQueryParameter[]

requestBody

A HTTP-kérelem törzsének létrehozásához használt paraméter.

requestBody?: OperationParameter

Tulajdonság értéke

OperationParameter

responses

A művelet által visszaadott különböző típusú válaszok a visszaadott állapotkód alapján.

responses: {[responseCode: string]: OperationResponse}

Tulajdonság értéke

{[responseCode: string]: OperationResponse}

serializer

Az ebben a műveletben használni kívánt szerializáló.

serializer: Serializer

Tulajdonság értéke

Serializer

urlParameters

A műveletmetódus paraméterei, amelyeket a rendszer a létrehozott URL-címmel helyettesít.

urlParameters?: readonly OperationURLParameter[]

Tulajdonság értéke

readonly OperationURLParameter[]