OperationSpec interface

  • Referência
Pacote:
@azure/ms-rest-js

Uma especificação que define uma operação.

Propriedades

baseUrl

A URL fornecida na especificação do serviço. Isso ainda terá todas as variáveis de modelo de URL nela. Se isso não for fornecido quando o OperationSpec for criado, ele será preenchido por uma propriedade "baseUri" no ServiceClient.
contentType

O tipo de conteúdo do corpo da solicitação. Esse valor será usado como o cabeçalho "Tipo de Conteúdo" se for fornecido.
formDataParameters

Os parâmetros para o método de operação que serão usados para criar um corpo formdata para a solicitação HTTP da operação.
headerParameters

Os parâmetros para o método de operação que serão convertidos em cabeçalhos na solicitação HTTP da operação.
httpMethod

O método HTTP que deve ser usado por solicitações para essa operação.
isXML

Se essa operação usa ou não corpos de solicitação e resposta XML.
path

O caminho fixo para a URL desta operação. Isso ainda terá todas as variáveis de modelo de URL nela.
queryParameters

Os parâmetros para o método de operação que será adicionado à consulta da URL construída.
requestBody

O parâmetro que será usado para construir o corpo da solicitação HTTP.
responses

Os diferentes tipos de respostas que essa operação pode retornar com base em qual código de status é retornado.
serializer

O serializador a ser usado nesta operação.
urlParameters

Os parâmetros para o método de operação que será substituído na URL construída.

Detalhes da propriedade

baseUrl

A URL fornecida na especificação do serviço. Isso ainda terá todas as variáveis de modelo de URL nela. Se isso não for fornecido quando o OperationSpec for criado, ele será preenchido por uma propriedade "baseUri" no ServiceClient.

baseUrl?: string

Valor da propriedade

string

contentType

O tipo de conteúdo do corpo da solicitação. Esse valor será usado como o cabeçalho "Tipo de Conteúdo" se for fornecido.

contentType?: string

Valor da propriedade

string

formDataParameters

Os parâmetros para o método de operação que serão usados para criar um corpo formdata para a solicitação HTTP da operação.

formDataParameters?: readonly OperationParameter[]

Valor da propriedade

readonly OperationParameter[]

headerParameters

Os parâmetros para o método de operação que serão convertidos em cabeçalhos na solicitação HTTP da operação.

headerParameters?: readonly OperationParameter[]

Valor da propriedade

readonly OperationParameter[]

httpMethod

O método HTTP que deve ser usado por solicitações para essa operação.

httpMethod: HttpMethods

Valor da propriedade

HttpMethods

isXML

Se essa operação usa ou não corpos de solicitação e resposta XML.

isXML?: boolean

Valor da propriedade

boolean

path

O caminho fixo para a URL desta operação. Isso ainda terá todas as variáveis de modelo de URL nela.

path?: string

Valor da propriedade

string

queryParameters

Os parâmetros para o método de operação que será adicionado à consulta da URL construída.

queryParameters?: readonly OperationQueryParameter[]

Valor da propriedade

readonly OperationQueryParameter[]

requestBody

O parâmetro que será usado para construir o corpo da solicitação HTTP.

requestBody?: OperationParameter

Valor da propriedade

OperationParameter

responses

Os diferentes tipos de respostas que essa operação pode retornar com base em qual código de status é retornado.

responses: {[responseCode: string]: OperationResponse}

Valor da propriedade

{[responseCode: string]: OperationResponse}

serializer

O serializador a ser usado nesta operação.

serializer: Serializer

Valor da propriedade

Serializer

urlParameters

Os parâmetros para o método de operação que será substituído na URL construída.

urlParameters?: readonly OperationURLParameter[]

Valor da propriedade

readonly OperationURLParameter[]