OperationSpec interface

Pakiet:

@azure/core-http

Specyfikacja definiująca sposób wykonywania określonej operacji usługi za pośrednictwem protokołu HTTP, w tym sposób prawidłowego serializowania informacji o żądaniu i deserializacji informacji o odpowiedzi do ładunku obiektu zwracanego przez klienta ServiceClient.

Właściwości

baseUrl	Adres URL podany w specyfikacji usługi. Nadal będzie ona zawierać wszystkie zmienne szablonu adresu URL. Jeśli nie zostanie to podane podczas tworzenia elementu 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 podany.
formDataParameters	Parametry metody operacji, która zostanie użyta do utworzenia treści formularza 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	Niezależnie od tego, czy ta operacja używa treści żądania XML i odpowiedzi.
mediaType	Typ nośnika treści żądania. Ta wartość może służyć do pomocy w serializacji, jeśli zostanie podana.
path	Stała ścieżka adresu URL tej operacji. Nadal będzie ona zawierać wszystkie zmienne szablonu adresu URL.
queryParameters	Parametry metody operacji, która zostanie dodana do skonstruowanego zapytania 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 zwracanego kodu stanu.
serializer	Serializator do użycia w tej operacji.
urlParameters	Parametry metody operacji, która zostanie zastąpiona w skonstruowanym adresie URL.

Szczegóły właściwości

baseUrl

Adres URL podany w specyfikacji usługi. Nadal będzie ona zawierać wszystkie zmienne szablonu adresu URL. Jeśli nie zostanie to podane podczas tworzenia elementu 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 podany.

contentType?: string

Wartość właściwości

string

formDataParameters

Parametry metody operacji, która zostanie użyta do utworzenia treści formularza 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

Niezależnie od tego, czy ta operacja używa treści żądania XML i odpowiedzi.

isXML?: boolean

Wartość właściwości

boolean

mediaType

Typ nośnika treści żądania. Ta wartość może służyć do pomocy w serializacji, jeśli zostanie podana.

mediaType?: string

Wartość właściwości

string

path

Stała ścieżka adresu URL tej operacji. Nadal będzie ona zawierać wszystkie zmienne szablonu adresu URL.

path?: string

Wartość właściwości

string

queryParameters

Parametry metody operacji, która zostanie dodana do skonstruowanego zapytania 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 zwracanego kodu stanu.

responses: {[responseCode: string]: OperationResponse}

Wartość właściwości

{[responseCode: string]: OperationResponse}

serializer

Serializator do użycia w tej operacji.

serializer: Serializer

Wartość właściwości

Serializer

urlParameters

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

urlParameters?: readonly OperationURLParameter[]

Wartość właściwości

readonly OperationURLParameter[]