OperationSpec interface

Paket:

@azure/core-client

En specifikation som definierar en åtgärd.

Egenskaper

baseUrl	Url:en som angavs i tjänstens specifikation. Detta kommer fortfarande att ha alla URL-mallvariabler i den. Om detta inte anges när OperationSpec skapas fylls den i av en "baseUri"-egenskap på ServiceClient.
contentType	Innehållstypen för begärandetexten. Det här värdet används som "Content-Type"-huvudet om det anges.
formDataParameters	Parametrarna till den åtgärdsmetod som ska användas för att skapa en formulärdatatext för åtgärdens HTTP-begäran.
headerParameters	Parametrarna till den åtgärdsmetod som ska konverteras till rubriker i åtgärdens HTTP-begäran.
httpMethod	DEN HTTP-metod som ska användas av begäranden för den här åtgärden.
isXML	Oavsett om den här åtgärden använder XML-begäranden och svarskroppar eller inte.
mediaType	Medietypen för begärandetexten. Det här värdet kan användas för att hjälpa till med serialisering om det anges.
path	Den fasta sökvägen för den här åtgärdens URL. Detta kommer fortfarande att ha alla URL-mallvariabler i den.
queryParameters	Parametrarna till den åtgärdsmetod som ska läggas till i den konstruerade URL:ens fråga.
requestBody	Parametern som ska användas för att konstruera HTTP-begärandetexten.
responses	De olika typer av svar som den här åtgärden kan returnera baserat på vilken statuskod som returneras.
serializer	Serialiseraren som ska användas i den här åtgärden.
urlParameters	Parametrarna till den åtgärdsmetod som ska ersättas med den konstruerade URL:en.

Egenskapsinformation

baseUrl

Url:en som angavs i tjänstens specifikation. Detta kommer fortfarande att ha alla URL-mallvariabler i den. Om detta inte anges när OperationSpec skapas fylls den i av en "baseUri"-egenskap på ServiceClient.

baseUrl?: string

Egenskapsvärde

string

contentType

Innehållstypen för begärandetexten. Det här värdet används som "Content-Type"-huvudet om det anges.

contentType?: string

Egenskapsvärde

string

formDataParameters

Parametrarna till den åtgärdsmetod som ska användas för att skapa en formulärdatatext för åtgärdens HTTP-begäran.

formDataParameters?: readonly OperationParameter[]

Egenskapsvärde

readonly OperationParameter[]

headerParameters

Parametrarna till den åtgärdsmetod som ska konverteras till rubriker i åtgärdens HTTP-begäran.

headerParameters?: readonly OperationParameter[]

Egenskapsvärde

readonly OperationParameter[]

httpMethod

DEN HTTP-metod som ska användas av begäranden för den här åtgärden.

httpMethod: HttpMethods

Egenskapsvärde

HttpMethods

isXML

Oavsett om den här åtgärden använder XML-begäranden och svarskroppar eller inte.

isXML?: boolean

Egenskapsvärde

boolean

mediaType

Medietypen för begärandetexten. Det här värdet kan användas för att hjälpa till med serialisering om det anges.

mediaType?: string

Egenskapsvärde

string

path

Den fasta sökvägen för den här åtgärdens URL. Detta kommer fortfarande att ha alla URL-mallvariabler i den.

path?: string

Egenskapsvärde

string

queryParameters

Parametrarna till den åtgärdsmetod som ska läggas till i den konstruerade URL:ens fråga.

queryParameters?: readonly OperationQueryParameter[]

Egenskapsvärde

readonly OperationQueryParameter[]

requestBody

Parametern som ska användas för att konstruera HTTP-begärandetexten.

requestBody?: OperationParameter

Egenskapsvärde

OperationParameter

responses

De olika typer av svar som den här åtgärden kan returnera baserat på vilken statuskod som returneras.

responses: {[responseCode: string]: OperationResponseMap}

Egenskapsvärde

{[responseCode: string]: OperationResponseMap}

serializer

Serialiseraren som ska användas i den här åtgärden.

serializer: Serializer

Egenskapsvärde

Serializer

urlParameters

Parametrarna till den åtgärdsmetod som ska ersättas med den konstruerade URL:en.

urlParameters?: readonly OperationURLParameter[]

Egenskapsvärde

readonly OperationURLParameter[]