Поделиться через

OperationSpec interface

  • Ссылка
Пакет:
@azure/core-http

Спецификация, определяющая выполнение определенной операции службы по протоколу HTTP, в том числе способ правильной сериализации сведений запроса в сведения о ответе и десериализации сведений об ответе в полезные данные объекта, возвращаемые ServiceClient.

Свойства

baseUrl

URL-адрес, предоставленный в спецификации службы. Это по-прежнему будет содержать все переменные шаблона URL-адреса. Если это не указано при создании OperationSpec, оно будет заполнено свойством baseUri в ServiceClient.
contentType

Тип контента текста запроса. Это значение будет использоваться в качестве заголовка Content-Type, если он указан.
formDataParameters

Параметры метода операции, который будет использоваться для создания текста формы для HTTP-запроса операции.
headerParameters

Параметры метода операции, которые будут преобразованы в заголовки http-запроса операции.
httpMethod

Метод HTTP, который должен использоваться запросами для этой операции.
isXML

Независимо от того, используется ли эта операция XML-запросы и тела ответа.
mediaType

Тип носителя текста запроса. Это значение можно использовать для помощника в сериализации, если он указан.
path

Фиксированный путь для URL-адреса этой операции. Это по-прежнему будет содержать все переменные шаблона URL-адреса.
queryParameters

Параметры метода операции, которые будут добавлены в запрос созданного URL-адреса.
requestBody

Параметр, который будет использоваться для создания текста HTTP-запроса.
responses

Различные типы ответов, которые эта операция может возвращать в зависимости от возвращаемого кода состояния.
serializer

Сериализатор, используемый в этой операции.
urlParameters

Параметры метода операции, которые будут заменены на созданный URL-адрес.

Сведения о свойстве

baseUrl

URL-адрес, предоставленный в спецификации службы. Это по-прежнему будет содержать все переменные шаблона URL-адреса. Если это не указано при создании OperationSpec, оно будет заполнено свойством baseUri в ServiceClient.

baseUrl?: string

Значение свойства

string

contentType

Тип контента текста запроса. Это значение будет использоваться в качестве заголовка Content-Type, если он указан.

contentType?: string

Значение свойства

string

formDataParameters

Параметры метода операции, который будет использоваться для создания текста формы для HTTP-запроса операции.

formDataParameters?: readonly OperationParameter[]

Значение свойства

readonly OperationParameter[]

headerParameters

Параметры метода операции, которые будут преобразованы в заголовки http-запроса операции.

headerParameters?: readonly OperationParameter[]

Значение свойства

readonly OperationParameter[]

httpMethod

Метод HTTP, который должен использоваться запросами для этой операции.

httpMethod: HttpMethods

Значение свойства

HttpMethods

isXML

Независимо от того, используется ли эта операция XML-запросы и тела ответа.

isXML?: boolean

Значение свойства

boolean

mediaType

Тип носителя текста запроса. Это значение можно использовать для помощника в сериализации, если он указан.

mediaType?: string

Значение свойства

string

path

Фиксированный путь для URL-адреса этой операции. Это по-прежнему будет содержать все переменные шаблона URL-адреса.

path?: string

Значение свойства

string

queryParameters

Параметры метода операции, которые будут добавлены в запрос созданного URL-адреса.

queryParameters?: readonly OperationQueryParameter[]

Значение свойства

readonly OperationQueryParameter[]

requestBody

Параметр, который будет использоваться для создания текста HTTP-запроса.

requestBody?: OperationParameter

Значение свойства

OperationParameter

responses

Различные типы ответов, которые эта операция может возвращать в зависимости от возвращаемого кода состояния.

responses: {[responseCode: string]: OperationResponse}

Значение свойства

{[responseCode: string]: OperationResponse}

serializer

Сериализатор, используемый в этой операции.

serializer: Serializer

Значение свойства

Serializer

urlParameters

Параметры метода операции, которые будут заменены на созданный URL-адрес.

urlParameters?: readonly OperationURLParameter[]

Значение свойства

readonly OperationURLParameter[]