Partilhar via

RequestPrepareOptions interface

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

Propriedades

abortSignal
baseUrl

A url base da solicitação. O valor padrão é: "https://management.azure.com". Isso é aplicável somente com pathTemplate. Se você estiver fornecendo options.url, então espera-se que você forneça o url completo.
body

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

Indica se o corpo da solicitação é um fluxo (útil para cenários de carregamento de arquivos).
deserializationMapper

Fornece informações sobre como desserializar o corpo da resposta.
disableClientRequestId

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

Indica se esse método deve JSON.stringify() o corpo da solicitação. Valor padrão: false.
formData
headers

Um dicionário de cabeçalhos de solicitação que precisam ser aplicados à solicitação. Aqui a chave é o "header-name" e o valor é o "header-value". O valor do cabeçalho DEVE ser do tipo string.

  • ContentType deve ser fornecido com o nome da chave como "Content-Type". Valor padrão "application/json; charset=utf-8".
  • "Transfer-Encoding" é definido como "chunked" por padrão se "options.bodyIsStream" estiver definido como true.
  • "Content-Type" é definido como "application/octet-stream" por padrão se "options.bodyIsStream" estiver definido como true.
  • "accept-language" por padrão é definido como "en-US"
  • "x-ms-client-request-id" por padrão é definido como um novo Guid. Para não gerar um guid para a solicitação, defina options.disableClientRequestId como true
mappers

Um dicionário de mapeadores que podem ser usados durante a [des]serialização.
method

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

Um dicionário de parâmetros de caminho que precisam ser substituídos por valores reais no pathTemplate. Aqui a chave é o "path-parameter-name" e o valor é o "path-parameter-value". O "path-parameter-value" pode ser do tipo "string" ou do tipo "object". O formato "objeto" deve ser usado quando você quiser ignorar a codificação de url. Ao usar o formato de objeto, o objeto deve ter uma propriedade chamada value que fornece o "path-parameter-value". Exemplo:

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

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

Um dicionário de parâmetros de consulta a ser anexado à url, onde a "chave" é o "query-parameter-name" e o "value" é o "query-parameter-value". O "query-parameter-value" pode ser do tipo "string" ou do tipo "object". O formato "objeto" deve ser usado quando você quiser ignorar a codificação de url. Ao usar o formato de objeto, o objeto deve ter uma propriedade chamada value que fornece o "query-parameter-value". Exemplo:

  • query-parameter-value no formato "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value em 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á anexado ao url.
redirectLimit

Limite o número de redirecionamentos seguidos para esta solicitação. Se definido como 0, os redirecionamentos não serão seguidos. Se não for definido, aplicar-se-á o comportamento de redirecionamento predefinido do node_fetch subjacente.
serializationMapper

Fornece informações sobre como serializar o corpo da solicitação.
streamResponseBody
url

O url da solicitação. Ele pode ou não ter parâmetros de consulta nele. Forneça o "url" ou forneça o "pathTemplate" no objeto options. Ambas as opções se excluem mutuamente.

Detalhes de Propriedade

abortSignal 

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

baseUrl

A url base da solicitação. O valor padrão é: "https://management.azure.com". Isso é aplicável somente com pathTemplate. Se você estiver fornecendo options.url, então espera-se que você forneça o url completo.

baseUrl?: string

Valor de Propriedade

string

body

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

body?: any

Valor de Propriedade

any

bodyIsStream

Indica se o corpo da solicitação é um fluxo (útil para cenários de carregamento de arquivos).

bodyIsStream?: boolean

Valor de Propriedade

boolean

deserializationMapper

Fornece informações sobre como desserializar o corpo da resposta.

deserializationMapper?: object

Valor de Propriedade

object

disableClientRequestId

Quando definido como true, 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 esse método deve JSON.stringify() o corpo da solicitação. Valor padrão: false.

disableJsonStringifyOnBody?: boolean

Valor de Propriedade

boolean

formData 

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

Valor de Propriedade

{[key: string]: any}

headers

Um dicionário de cabeçalhos de solicitação que precisam ser aplicados à solicitação. Aqui a chave é o "header-name" e o valor é o "header-value". O valor do cabeçalho DEVE ser do tipo string.

  • ContentType deve ser fornecido com o nome da chave como "Content-Type". Valor padrão "application/json; charset=utf-8".
  • "Transfer-Encoding" é definido como "chunked" por padrão se "options.bodyIsStream" estiver definido como true.
  • "Content-Type" é definido como "application/octet-stream" por padrão se "options.bodyIsStream" estiver definido como true.
  • "accept-language" por padrão é definido como "en-US"
  • "x-ms-client-request-id" por padrão é definido como um novo Guid. Para não gerar um guid para a solicitação, defina options.disableClientRequestId como true
headers?: {[key: string]: any}

Valor de Propriedade

{[key: string]: any}

mappers

Um dicionário de mapeadores que podem ser usados durante a [des]serialização.

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

Valor de Propriedade

{[x: string]: any}

method

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

method: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

pathParameters

Um dicionário de parâmetros de caminho que precisam ser substituídos por valores reais no pathTemplate. Aqui a chave é o "path-parameter-name" e o valor é o "path-parameter-value". O "path-parameter-value" pode ser do tipo "string" ou do tipo "object". O formato "objeto" deve ser usado quando você quiser ignorar a codificação de url. Ao usar o formato de objeto, o objeto deve ter uma propriedade chamada value que fornece o "path-parameter-value". Exemplo:

  • path-parameter-value no formato "object": { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value em 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 da URL da solicitação. Forneça o "url" ou forneça o "pathTemplate" no objeto options. Ambas as opções se excluem mutuamente. 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 ser anexado à url, onde a "chave" é o "query-parameter-name" e o "value" é o "query-parameter-value". O "query-parameter-value" pode ser do tipo "string" ou do tipo "object". O formato "objeto" deve ser usado quando você quiser ignorar a codificação de url. Ao usar o formato de objeto, o objeto deve ter uma propriedade chamada value que fornece o "query-parameter-value". Exemplo:

  • query-parameter-value no formato "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value em 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á anexado ao url.
queryParameters?: {[key: string]: any | ParameterValue}

Valor de Propriedade

{[key: string]: any | ParameterValue}

redirectLimit

Limite o número de redirecionamentos seguidos para esta solicitação. Se definido como 0, os redirecionamentos não serão seguidos. Se não for definido, aplicar-se-á o comportamento de redirecionamento predefinido do node_fetch subjacente.

redirectLimit?: number

Valor de Propriedade

number

serializationMapper

Fornece informações sobre como serializar o corpo da solicitação.

serializationMapper?: Mapper

Valor de Propriedade

Mapper

streamResponseBody 

streamResponseBody?: boolean

Valor de Propriedade

boolean

url

O url da solicitação. Ele pode ou não ter parâmetros de consulta nele. Forneça o "url" ou forneça o "pathTemplate" no objeto options. Ambas as opções se excluem mutuamente.

url?: string

Valor de Propriedade

string