OperationSpec interface

Pacote:

@azure/core-http

Uma especificação que define como executar uma determinada operação de serviço através de HTTP, incluindo como serializar corretamente as informações do pedido para e anular a serialização das informações de resposta num payload de objeto devolvido pelo ServiceClient.

Propriedades

baseUrl	O URL fornecido na especificação do serviço. Esta ação continuará a ter todas as variáveis de modelo de URL. Se isto não for fornecido quando o OperationSpec for criado, será preenchido por uma propriedade "baseUri" no ServiceClient.
contentType	O tipo de conteúdo do corpo do pedido. Este valor será utilizado como o cabeçalho "Content-Type", se for fornecido.
formDataParameters	Os parâmetros para o método de operação que serão utilizados para criar um corpo de formdata para o pedido HTTP da operação.
headerParameters	Os parâmetros para o método de operação que serão convertidos em cabeçalhos no pedido HTTP da operação.
httpMethod	O método HTTP que deve ser utilizado pelos pedidos para esta operação.
isXML	Se esta operação utiliza ou não o pedido XML e os corpos de resposta.
mediaType	O tipo de suporte de dados do corpo do pedido. Este valor pode ser utilizado para ajudar na serialização, se for fornecido.
path	O caminho fixo para o URL desta operação. Esta ação continuará a ter todas as variáveis de modelo de URL.
queryParameters	Os parâmetros do método de operação que serão adicionados à consulta do URL construído.
requestBody	O parâmetro que será utilizado para construir o corpo do pedido HTTP.
responses	Os diferentes tipos de respostas que esta operação pode devolver com base no código de estado devolvido.
serializer	O serializador a utilizar nesta operação.
urlParameters	Os parâmetros para o método de operação que serão substituídos pelo URL construído.

Detalhes de Propriedade

baseUrl

O URL fornecido na especificação do serviço. Esta ação continuará a ter todas as variáveis de modelo de URL. Se isto não for fornecido quando o OperationSpec for criado, será preenchido por uma propriedade "baseUri" no ServiceClient.

baseUrl?: string

Valor de Propriedade

string

contentType

O tipo de conteúdo do corpo do pedido. Este valor será utilizado como o cabeçalho "Content-Type", se for fornecido.

contentType?: string

Valor de Propriedade

string

formDataParameters

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

formDataParameters?: readonly OperationParameter[]

Valor de Propriedade

readonly OperationParameter[]

headerParameters

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

headerParameters?: readonly OperationParameter[]

Valor de Propriedade

readonly OperationParameter[]

httpMethod

O método HTTP que deve ser utilizado pelos pedidos para esta operação.

httpMethod: HttpMethods

Valor de Propriedade

HttpMethods

isXML

Se esta operação utiliza ou não o pedido XML e os corpos de resposta.

isXML?: boolean

Valor de Propriedade

boolean

mediaType

O tipo de suporte de dados do corpo do pedido. Este valor pode ser utilizado para ajudar na serialização, se for fornecido.

mediaType?: string

Valor de Propriedade

string

path

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

path?: string

Valor de Propriedade

string

queryParameters

Os parâmetros do método de operação que serão adicionados à consulta do URL construído.

queryParameters?: readonly OperationQueryParameter[]

Valor de Propriedade

readonly OperationQueryParameter[]

requestBody

O parâmetro que será utilizado para construir o corpo do pedido HTTP.

requestBody?: OperationParameter

Valor de Propriedade

OperationParameter

responses

Os diferentes tipos de respostas que esta operação pode devolver com base no código de estado devolvido.

responses: {[responseCode: string]: OperationResponse}

Valor de Propriedade

{[responseCode: string]: OperationResponse}

serializer

O serializador a utilizar nesta operação.

serializer: Serializer

Valor de Propriedade

Serializer

urlParameters

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

urlParameters?: readonly OperationURLParameter[]

Valor de Propriedade

readonly OperationURLParameter[]