Partilhar via

RequestPrepareOptions interface

  • Referência
Pacote:
@azure/core-http

Opções para preparar um pedido HTTP enviado.

Propriedades

abortSignal

Sinal de um controlador abortar. Pode ser utilizado para abortar o envio de um pedido de rede e aguardar uma resposta.
baseUrl

O URL base do pedido. O valor predefinido é: "https://management.azure.com". Isto só é aplicável com pathTemplate. Se estiver a fornecer options.url, espera-se que forneça o URL completo.
body

O corpo do pedido. Pode ser de qualquer tipo. Este valor será serializado se não for um fluxo.
bodyIsStream

Indica se o corpo do pedido é um fluxo (útil para cenários de carregamento de ficheiros).
deserializationMapper

Fornece informações sobre como anular a serialização do corpo da resposta.
disableClientRequestId

Quando definido como verdadeiro, instrui o cliente a não definir o cabeçalho "x-ms-client-request-id" para um novo Guid().
disableJsonStringifyOnBody

Indica se este método deve JSON.stringify() o corpo do pedido. Valor predefinido: falso.
formData

Dados de formulário, utilizados para criar o corpo do pedido.
headers

Um dicionário de cabeçalhos de pedido que têm de ser aplicados ao pedido. Aqui a chave é "header-name" e o valor é "header-value". O valor do cabeçalho TEM de ser do tipo cadeia.

  • ContentType tem de ser fornecido com o nome da chave como "Tipo de Conteúdo". Valor predefinido "application/json; charset=utf-8".
  • "Transfer-Encoding" está definido como "segmentado" por predefinição se "options.bodyIsStream" estiver definido como verdadeiro.
  • "Content-Type" está definido como "application/octet-stream" por predefinição se "options.bodyIsStream" estiver definido como verdadeiro.
  • "accept-language" por predefinição está definido como "en-US"
  • Por predefinição, "x-ms-client-request-id" está definido para um novo Guid. Para não gerar um guid para o pedido, defina options.disableClientRequestId como verdadeiro
mappers

Um dicionário de mapeadores que podem ser utilizados enquanto [de]serialização.
method

O método de pedido HTTP. Os valores válidos são "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" ou "PATCH".
onDownloadProgress

Permite controlar o progresso da transferência da resposta recebida.
onUploadProgress

Permite controlar o progresso do carregamento do pedido de envio.
pathParameters

Um dicionário de parâmetros de caminho que têm de ser substituídos por valores reais no pathTemplate. Aqui a chave é "path-parameter-name" e o valor é "path-parameter-value". O "path-parameter-value" pode ser do tipo "cadeia" ou pode ser do tipo "objeto". O formato "objeto" deve ser utilizado quando pretender ignorar a codificação de URL. Ao utilizar o formato do objeto, o objeto tem de ter uma propriedade denominada valor que forneça o "path-parameter-value". Exemplo:

  • path-parameter-value no formato "object": { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value no formato "string": { "path-parameter-name": "path-parameter-value" }.
pathTemplate

O modelo de caminho do URL do pedido. Forneça o "url" ou forneça o "pathTemplate" no objeto de opções. Ambas as opções são mutuamente exclusivas. Exemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters

Um dicionário de parâmetros de consulta a acrescentar ao URL, em que a "chave" é "query-parameter-name" e o "valor" é "query-parameter-value". O "query-parameter-value" pode ser do tipo "cadeia" ou pode ser do tipo "objeto". O formato "objeto" deve ser utilizado quando pretender ignorar a codificação de URL. Ao utilizar o formato de objeto, o objeto tem de ter uma propriedade com o nome valor que forneça o "query-parameter-value". Exemplo:

  • query-parameter-value no formato "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value no formato "string": { "query-parameter-name": "query-parameter-value"}. Nota: "Se options.url já tiver alguns parâmetros de consulta, o valor fornecido em options.queryParameters será acrescentado ao URL.
serializationMapper

Fornece informações sobre como serializar o corpo do pedido.
spanOptions

Rastreio: opções utilizadas para criar um intervalo quando o rastreio está ativado.
tracingContext

Rastreio: contexto utilizado ao criar intervalos.
url

O URL do pedido. Pode ou não ter parâmetros de consulta. Forneça o "url" ou forneça o "pathTemplate" no objeto de opções. Ambas as opções são mutuamente exclusivas.

Detalhes de Propriedade

abortSignal

Sinal de um controlador abortar. Pode ser utilizado para abortar o envio de um pedido de rede e aguardar uma resposta.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

baseUrl

O URL base do pedido. O valor predefinido é: "https://management.azure.com". Isto só é aplicável com pathTemplate. Se estiver a fornecer options.url, espera-se que forneça o URL completo.

baseUrl?: string

Valor de Propriedade

string

body

O corpo do pedido. Pode ser de qualquer tipo. Este valor será serializado se não for um fluxo.

body?: any

Valor de Propriedade

any

bodyIsStream

Indica se o corpo do pedido é um fluxo (útil para cenários de carregamento de ficheiros).

bodyIsStream?: boolean

Valor de Propriedade

boolean

deserializationMapper

Fornece informações sobre como anular a serialização do corpo da resposta.

deserializationMapper?: Record<string, unknown>

Valor de Propriedade

Record<string, unknown>

disableClientRequestId

Quando definido como verdadeiro, instrui o cliente a não definir o cabeçalho "x-ms-client-request-id" para um novo Guid().

disableClientRequestId?: boolean

Valor de Propriedade

boolean

disableJsonStringifyOnBody

Indica se este método deve JSON.stringify() o corpo do pedido. Valor predefinido: falso.

disableJsonStringifyOnBody?: boolean

Valor de Propriedade

boolean

formData

Dados de formulário, utilizados para criar o corpo do pedido.

formData?: {[key: string]: any}

Valor de Propriedade

{[key: string]: any}

headers

Um dicionário de cabeçalhos de pedido que têm de ser aplicados ao pedido. Aqui a chave é "header-name" e o valor é "header-value". O valor do cabeçalho TEM de ser do tipo cadeia.

  • ContentType tem de ser fornecido com o nome da chave como "Tipo de Conteúdo". Valor predefinido "application/json; charset=utf-8".
  • "Transfer-Encoding" está definido como "segmentado" por predefinição se "options.bodyIsStream" estiver definido como verdadeiro.
  • "Content-Type" está definido como "application/octet-stream" por predefinição se "options.bodyIsStream" estiver definido como verdadeiro.
  • "accept-language" por predefinição está definido como "en-US"
  • Por predefinição, "x-ms-client-request-id" está definido para um novo Guid. Para não gerar um guid para o pedido, defina options.disableClientRequestId como verdadeiro
headers?: {[key: string]: any}

Valor de Propriedade

{[key: string]: any}

mappers

Um dicionário de mapeadores que podem ser utilizados enquanto [de]serialização.

mappers?: {[x: string]: any}

Valor de Propriedade

{[x: string]: any}

method

O método de pedido HTTP. Os valores válidos são "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" ou "PATCH".

method: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress

Permite controlar o progresso da transferência da resposta recebida.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Permite controlar o progresso do carregamento do pedido de envio.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

pathParameters

Um dicionário de parâmetros de caminho que têm de ser substituídos por valores reais no pathTemplate. Aqui a chave é "path-parameter-name" e o valor é "path-parameter-value". O "path-parameter-value" pode ser do tipo "cadeia" ou pode ser do tipo "objeto". O formato "objeto" deve ser utilizado quando pretender ignorar a codificação de URL. Ao utilizar o formato do objeto, o objeto tem de ter uma propriedade denominada valor que forneça o "path-parameter-value". Exemplo:

  • path-parameter-value no formato "object": { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value no formato "string": { "path-parameter-name": "path-parameter-value" }.
pathParameters?: {[key: string]: any | ParameterValue}

Valor de Propriedade

{[key: string]: any | ParameterValue}

pathTemplate

O modelo de caminho do URL do pedido. Forneça o "url" ou forneça o "pathTemplate" no objeto de opções. Ambas as opções são mutuamente exclusivas. Exemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

Valor de Propriedade

string

queryParameters

Um dicionário de parâmetros de consulta a acrescentar ao URL, em que a "chave" é "query-parameter-name" e o "valor" é "query-parameter-value". O "query-parameter-value" pode ser do tipo "cadeia" ou pode ser do tipo "objeto". O formato "objeto" deve ser utilizado quando pretender ignorar a codificação de URL. Ao utilizar o formato de objeto, o objeto tem de ter uma propriedade com o nome valor que forneça o "query-parameter-value". Exemplo:

  • query-parameter-value no formato "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value no formato "string": { "query-parameter-name": "query-parameter-value"}. Nota: "Se options.url já tiver alguns parâmetros de consulta, o valor fornecido em options.queryParameters será acrescentado ao URL.
queryParameters?: {[key: string]: any | ParameterValue}

Valor de Propriedade

{[key: string]: any | ParameterValue}

serializationMapper

Fornece informações sobre como serializar o corpo do pedido.

serializationMapper?: Mapper

Valor de Propriedade

Mapper

spanOptions

Rastreio: opções utilizadas para criar um intervalo quando o rastreio está ativado.

spanOptions?: SpanOptions

Valor de Propriedade

@azure/core-tracing.SpanOptions

tracingContext

Rastreio: contexto utilizado ao criar intervalos.

tracingContext?: Context

Valor de Propriedade

@azure/core-tracing.Context

url

O URL do pedido. Pode ou não ter parâmetros de consulta. Forneça o "url" ou forneça o "pathTemplate" no objeto de opções. Ambas as opções são mutuamente exclusivas.

url?: string

Valor de Propriedade

string