Compartilhar 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, espera-se que você forneça a URL completa.
body

O corpo da solicitação. 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 upload de arquivo).
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" como um novo Guid().
disableJsonStringifyOnBody

Indica se esse método deve ser 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 "cabeçalho-nome" e o valor é o "cabeçalho-valor". O cabeçalho-valor DEVE ser do tipo cadeia de caracteres.

  • ContentType deve ser fornecido com o nome da chave como "Content-Type". Valor padrão "application/json; charset=utf-8".
  • "Transfer-Encoding" será definido como "agrupado" 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 mapeados que podem ser usados durante [de]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 é "path-parameter-name" e o valor é "path-parameter-value". O "path-parameter-value" pode ser do tipo "string" ou pode ser do tipo "object". O formato "object" deve ser usado quando você deseja 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 no formato "string": { "path-parameter-name": "path-parameter-value" }.
pathTemplate

O modelo de caminho da URL de solicitação. Forneça a "URL" ou forneça o "pathTemplate" no objeto options. 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 serem acrescentados à URL, em que a "chave" é o "query-parameter-name" e o "value" é o "query-parameter-value". O "query-parameter-value" pode ser do tipo "string" ou pode ser do tipo "object". O formato "object" deve ser usado quando você deseja 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 no formato "string": { "query-parameter-name": "query-parameter-value"}. Observação: "Se options.url já tiver alguns parâmetros de consulta, o valor fornecido em options.queryParameters será acrescentado à URL.
redirectLimit

Limite o número de redirecionamentos seguidos para essa solicitação. Se definido como 0, os redirecionamentos não serão seguidos. Se deixado indefinido, o comportamento de redirecionamento padrão da node_fetch subjacente será aplicado.
serializationMapper

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

A URL da solicitação. Ele pode ou não ter parâmetros de consulta. Forneça a "URL" ou forneça o "pathTemplate" no objeto options. Ambas as opções são mutuamente exclusivas.

Detalhes da propriedade

abortSignal 

abortSignal?: AbortSignalLike

Valor da 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, espera-se que você forneça a URL completa.

baseUrl?: string

Valor da propriedade

string

body

O corpo da solicitação. Pode ser de qualquer tipo. Esse valor será serializado se não for um fluxo.

body?: any

Valor da propriedade

any

bodyIsStream

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

bodyIsStream?: boolean

Valor da propriedade

boolean

deserializationMapper

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

deserializationMapper?: object

Valor da propriedade

object

disableClientRequestId

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

disableClientRequestId?: boolean

Valor da propriedade

boolean

disableJsonStringifyOnBody

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

disableJsonStringifyOnBody?: boolean

Valor da propriedade

boolean

formData 

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

Valor da propriedade

{[key: string]: any}

headers

Um dicionário de cabeçalhos de solicitação que precisam ser aplicados à solicitação. Aqui, a chave é o "cabeçalho-nome" e o valor é o "cabeçalho-valor". O cabeçalho-valor DEVE ser do tipo cadeia de caracteres.

  • ContentType deve ser fornecido com o nome da chave como "Content-Type". Valor padrão "application/json; charset=utf-8".
  • "Transfer-Encoding" será definido como "agrupado" 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 da propriedade

{[key: string]: any}

mappers

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

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

Valor da 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 da propriedade

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da 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 é "path-parameter-name" e o valor é "path-parameter-value". O "path-parameter-value" pode ser do tipo "string" ou pode ser do tipo "object". O formato "object" deve ser usado quando você deseja 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 no formato "string": { "path-parameter-name": "path-parameter-value" }.
pathParameters?: {[key: string]: any | ParameterValue}

Valor da propriedade

{[key: string]: any | ParameterValue}

pathTemplate

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

pathTemplate?: string

Valor da propriedade

string

queryParameters

Um dicionário de parâmetros de consulta a serem acrescentados à URL, em que a "chave" é o "query-parameter-name" e o "value" é o "query-parameter-value". O "query-parameter-value" pode ser do tipo "string" ou pode ser do tipo "object". O formato "object" deve ser usado quando você deseja 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 no formato "string": { "query-parameter-name": "query-parameter-value"}. Observação: "Se options.url já tiver alguns parâmetros de consulta, o valor fornecido em options.queryParameters será acrescentado à URL.
queryParameters?: {[key: string]: any | ParameterValue}

Valor da propriedade

{[key: string]: any | ParameterValue}

redirectLimit

Limite o número de redirecionamentos seguidos para essa solicitação. Se definido como 0, os redirecionamentos não serão seguidos. Se deixado indefinido, o comportamento de redirecionamento padrão da node_fetch subjacente será aplicado.

redirectLimit?: number

Valor da propriedade

number

serializationMapper

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

serializationMapper?: Mapper

Valor da propriedade

Mapper

streamResponseBody 

streamResponseBody?: boolean

Valor da propriedade

boolean

url

A URL da solicitação. Ele pode ou não ter parâmetros de consulta. Forneça a "URL" ou forneça o "pathTemplate" no objeto options. Ambas as opções são mutuamente exclusivas.

url?: string

Valor da propriedade

string