Share via

OperationSpec interface

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

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

Свойства

baseUrl

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

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

Параметры метода операции, которые будут использоваться для создания тела formdata для 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

Параметры метода операции, которые будут использоваться для создания тела formdata для 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[]