OperationSpec interface

Pakket:

@azure/core-http

Een specificatie die definieert hoe een bepaalde servicebewerking via HTTP moet worden uitgevoerd, inclusief het correct serialiseren van aanvraaggegevens in en het deserialiseren van antwoordgegevens in een nettolading van een object die kan worden geretourneerd door de ServiceClient-.

Eigenschappen

baseUrl	De URL die is opgegeven in de specificatie van de service. Hiermee worden nog steeds alle URL-sjabloonvariabelen erin opgenomen. Als dit niet wordt opgegeven wanneer de OperationSpec wordt gemaakt, wordt deze ingevuld door een 'baseUri'-eigenschap op de ServiceClient.
contentType	Het inhoudstype van de aanvraagbody. Deze waarde wordt gebruikt als de header 'Content-Type' als deze is opgegeven.
formDataParameters	De parameters voor de bewerkingsmethode die wordt gebruikt voor het maken van een formdata-hoofdtekst voor de HTTP-aanvraag van de bewerking.
headerParameters	De parameters voor de bewerkingsmethode die worden geconverteerd naar headers in de HTTP-aanvraag van de bewerking.
httpMethod	De HTTP-methode die moet worden gebruikt door aanvragen voor deze bewerking.
isXML	Of deze bewerking gebruikmaakt van XML-aanvraag- en antwoordteksten.
mediaType	Het mediatype van de aanvraagbody. Deze waarde kan worden gebruikt om te helpen bij serialisatie als deze wordt opgegeven.
path	Het vaste pad voor de URL van deze bewerking. Hiermee worden nog steeds alle URL-sjabloonvariabelen erin opgenomen.
queryParameters	De parameters voor de bewerkingsmethode die worden toegevoegd aan de query van de samengestelde URL.
requestBody	De parameter die wordt gebruikt om de hoofdtekst van de HTTP-aanvraag samen te stellen.
responses	De verschillende typen antwoorden die door deze bewerking kunnen worden geretourneerd op basis van de statuscode die wordt geretourneerd.
serializer	De serializer die in deze bewerking moet worden gebruikt.
urlParameters	De parameters voor de bewerkingsmethode die in de samengestelde URL worden vervangen.

Eigenschapdetails

baseUrl

De URL die is opgegeven in de specificatie van de service. Hiermee worden nog steeds alle URL-sjabloonvariabelen erin opgenomen. Als dit niet wordt opgegeven wanneer de OperationSpec wordt gemaakt, wordt deze ingevuld door een 'baseUri'-eigenschap op de ServiceClient.

baseUrl?: string

Waarde van eigenschap

string

contentType

Het inhoudstype van de aanvraagbody. Deze waarde wordt gebruikt als de header 'Content-Type' als deze is opgegeven.

contentType?: string

Waarde van eigenschap

string

formDataParameters

De parameters voor de bewerkingsmethode die wordt gebruikt voor het maken van een formdata-hoofdtekst voor de HTTP-aanvraag van de bewerking.

formDataParameters?: readonly OperationParameter[]

Waarde van eigenschap

readonly OperationParameter[]

headerParameters

De parameters voor de bewerkingsmethode die worden geconverteerd naar headers in de HTTP-aanvraag van de bewerking.

headerParameters?: readonly OperationParameter[]

Waarde van eigenschap

readonly OperationParameter[]

httpMethod

De HTTP-methode die moet worden gebruikt door aanvragen voor deze bewerking.

httpMethod: HttpMethods

Waarde van eigenschap

HttpMethods

isXML

Of deze bewerking gebruikmaakt van XML-aanvraag- en antwoordteksten.

isXML?: boolean

Waarde van eigenschap

boolean

mediaType

Het mediatype van de aanvraagbody. Deze waarde kan worden gebruikt om te helpen bij serialisatie als deze wordt opgegeven.

mediaType?: string

Waarde van eigenschap

string

path

Het vaste pad voor de URL van deze bewerking. Hiermee worden nog steeds alle URL-sjabloonvariabelen erin opgenomen.

path?: string

Waarde van eigenschap

string

queryParameters

De parameters voor de bewerkingsmethode die worden toegevoegd aan de query van de samengestelde URL.

queryParameters?: readonly OperationQueryParameter[]

Waarde van eigenschap

readonly OperationQueryParameter[]

requestBody

De parameter die wordt gebruikt om de hoofdtekst van de HTTP-aanvraag samen te stellen.

requestBody?: OperationParameter

Waarde van eigenschap

OperationParameter

responses

De verschillende typen antwoorden die door deze bewerking kunnen worden geretourneerd op basis van de statuscode die wordt geretourneerd.

responses: {[responseCode: string]: OperationResponse}

Waarde van eigenschap

{[responseCode: string]: OperationResponse}

serializer

De serializer die in deze bewerking moet worden gebruikt.

serializer: Serializer

Waarde van eigenschap

Serializer

urlParameters

De parameters voor de bewerkingsmethode die in de samengestelde URL worden vervangen.

urlParameters?: readonly OperationURLParameter[]

Waarde van eigenschap

readonly OperationURLParameter[]