OperationSpec interface

Pakiet:

@azure/ms-rest-js

Specyfikacja, która definiuje operację.

Właściwości

baseUrl	Adres URL podany w specyfikacji usługi. Nadal będą w nim znajdować się wszystkie zmienne szablonu adresu URL. Jeśli nie zostanie to podane podczas tworzenia obiektu OperationSpec, zostanie on wypełniony przez właściwość "baseUri" w obiekcie ServiceClient.
contentType	Typ zawartości treści żądania. Ta wartość będzie używana jako nagłówek "Content-Type", jeśli zostanie podana.
formDataParameters	Parametry metody operacji, która zostanie użyta do utworzenia treści formdata dla żądania HTTP operacji.
headerParameters	Parametry metody operacji, która zostanie przekonwertowana na nagłówki w żądaniu HTTP operacji.
httpMethod	Metoda HTTP, która powinna być używana przez żądania dla tej operacji.
isXML	Bez względu na to, czy ta operacja używa treści żądania i odpowiedzi XML.
path	Stała ścieżka adresu URL tej operacji. Nadal będą w nim znajdować się wszystkie zmienne szablonu adresu URL.
queryParameters	Parametry metody operacji, która zostanie dodana do zapytania skonstruowanego adresu URL.
requestBody	Parametr, który będzie używany do konstruowania treści żądania HTTP.
responses	Różne typy odpowiedzi, które ta operacja może zwrócić na podstawie zwróconego kodu stanu.
serializer	Serializator używany w tej operacji.
urlParameters	Parametry metody operacji, która zostanie zastąpiona skonstruowanym adresem URL.

Szczegóły właściwości

baseUrl

Adres URL podany w specyfikacji usługi. Nadal będą w nim znajdować się wszystkie zmienne szablonu adresu URL. Jeśli nie zostanie to podane podczas tworzenia obiektu OperationSpec, zostanie on wypełniony przez właściwość "baseUri" w obiekcie ServiceClient.

baseUrl?: string

Wartość właściwości

string

contentType

Typ zawartości treści żądania. Ta wartość będzie używana jako nagłówek "Content-Type", jeśli zostanie podana.

contentType?: string

Wartość właściwości

string

formDataParameters

Parametry metody operacji, która zostanie użyta do utworzenia treści formdata dla żądania HTTP operacji.

formDataParameters?: readonly OperationParameter[]

Wartość właściwości

readonly OperationParameter[]

headerParameters

Parametry metody operacji, która zostanie przekonwertowana na nagłówki w żądaniu HTTP operacji.

headerParameters?: readonly OperationParameter[]

Wartość właściwości

readonly OperationParameter[]

httpMethod

Metoda HTTP, która powinna być używana przez żądania dla tej operacji.

httpMethod: HttpMethods

Wartość właściwości

HttpMethods

isXML

Bez względu na to, czy ta operacja używa treści żądania i odpowiedzi XML.

isXML?: boolean

Wartość właściwości

boolean

path

Stała ścieżka adresu URL tej operacji. Nadal będą w nim znajdować się wszystkie zmienne szablonu adresu URL.

path?: string

Wartość właściwości

string

queryParameters

Parametry metody operacji, która zostanie dodana do zapytania skonstruowanego adresu URL.

queryParameters?: readonly OperationQueryParameter[]

Wartość właściwości

readonly OperationQueryParameter[]

requestBody

Parametr, który będzie używany do konstruowania treści żądania HTTP.

requestBody?: OperationParameter

Wartość właściwości

OperationParameter

responses

Różne typy odpowiedzi, które ta operacja może zwrócić na podstawie zwróconego kodu stanu.

responses: {[responseCode: string]: OperationResponse}

Wartość właściwości

{[responseCode: string]: OperationResponse}

serializer

Serializator używany w tej operacji.

serializer: Serializer

Wartość właściwości

Serializer

urlParameters

Parametry metody operacji, która zostanie zastąpiona skonstruowanym adresem URL.

urlParameters?: readonly OperationURLParameter[]

Wartość właściwości

readonly OperationURLParameter[]