Partilhar via

RequestPrepareOptions interface

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

Propriedades

abortSignal
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
headers

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

  • ContentType tem de ser fornecido com o nome da chave como "Content-Type". 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 true
mappers

Um dicionário de mapeadores que podem ser utilizados durante a [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
onUploadProgress
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 "string" 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 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" é o "query-parameter-name" e o "valor" é o "query-parameter-value". O "query-parameter-value" pode ser do tipo "string" 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 denominada 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.
redirectLimit

Limite o número de redirecionamentos seguidos para este pedido. Se estiver definido como 0, os redirecionamentos não serão seguidos. Se não for definido, será aplicado o comportamento de redirecionamento predefinido do node_fetch subjacente.
serializationMapper

Fornece informações sobre como serializar o corpo do pedido.
streamResponseBody
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 

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?: object

Valor de Propriedade

object

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 

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 é o "header-name" e o valor é o "header-value". O valor do cabeçalho TEM de ser do tipo cadeia.

  • ContentType tem de ser fornecido com o nome da chave como "Content-Type". 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 true
headers?: {[key: string]: any}

Valor de Propriedade

{[key: string]: any}

mappers

Um dicionário de mapeadores que podem ser utilizados durante a [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 

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 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 "string" 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 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" é o "query-parameter-name" e o "valor" é o "query-parameter-value". O "query-parameter-value" pode ser do tipo "string" 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 denominada 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}

redirectLimit

Limite o número de redirecionamentos seguidos para este pedido. Se estiver definido como 0, os redirecionamentos não serão seguidos. Se não for definido, será aplicado o comportamento de redirecionamento predefinido do node_fetch subjacente.

redirectLimit?: number

Valor de Propriedade

number

serializationMapper

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

serializationMapper?: Mapper

Valor de Propriedade

Mapper

streamResponseBody 

streamResponseBody?: boolean

Valor de Propriedade

boolean

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