WebResource interface

Pacote:

@azure/storage-blob

Uma descrição de uma solicitação HTTP a ser feita a um servidor remoto.

Propriedades

abortSignal	Sinal de um controlador de anulação. Pode ser usado para anular o envio de uma solicitação de rede e aguardar uma resposta.
agent	SOMENTE NODEJS Uma opção somente nó para fornecer um http.Agent/https.Agentpersonalizado. OBSERVAÇÃO: geralmente essa deve ser uma instância compartilhada por várias solicitações para que a conexão subjacente com o serviço possa ser reutilizado. Não faz nada ao executar no navegador.
body	O conteúdo do corpo HTTP da solicitação.
decompressResponse	Se a resposta deve ou não ser descompactada de acordo com Accept-Encoding cabeçalho (somente busca de nó)
formData	Dados de formulário, usados para criar o corpo da solicitação.
headers	Os cabeçalhos HTTP a serem usados ao fazer a solicitação.
keepAlive	Se a conexão deve ser reutilizado.
method	O método HTTP a ser usado ao fazer a solicitação.
onDownloadProgress	Retorno de chamada que é acionado após o progresso do download.
onUploadProgress	Retorno de chamada que é acionado após o progresso do upload.
proxySettings	Configuração de proxy.
query	Uma cadeia de caracteres de consulta representada como um objeto.
requestId	Um identificador exclusivo para a solicitação. Usado para registro em log e rastreamento.
requestOverrides	Opções adicionais a serem definidas na solicitação. Isso fornece uma maneira de substituir os existentes ou fornecer propriedades de solicitação que não são declaradas. Para possíveis propriedades válidas, consulte Opções de https.request do NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback RequestInit do navegador: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit AVISO: As opções especificadas aqui substituirão quaisquer propriedades com os mesmos nomes quando a solicitação for enviada pelo <xref:HttpClient>.
streamResponseBody	Se o corpo do HttpOperationResponse deve ou não ser tratado como um fluxo.
streamResponseStatusCodes	Uma lista de códigos de status de resposta cujo corpo HttpOperationResponse correspondente deve ser tratado como um fluxo.
timeout	O número de milissegundos que uma solicitação pode fazer antes de ser encerrada automaticamente. Se a solicitação for encerrada, um AbortError será gerado.
url	A URL que está sendo acessada pela solicitação.
withCredentials	Se as credenciais (cookies) devem ser enviadas durante um XHR.

Métodos

clone()	Clone esse objeto de solicitação.
prepare(unknown)	Este é um no-op para fins de compatibilidade e será lançado se chamado.
validateRequestProperties()	Valida se as propriedades necessárias, como método, url, cabeçalhos["Content-Type"], headers["accept-language"] são definidas. Ele gerará um erro se uma das propriedades mencionadas acima não estiver definida. Observação: este é um no-op para fins de compatibilidade.

Detalhes da propriedade

abortSignal

Sinal de um controlador de anulação. Pode ser usado para anular o envio de uma solicitação de rede e aguardar uma resposta.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

agent

SOMENTE NODEJS

Uma opção somente nó para fornecer um http.Agent/https.Agentpersonalizado. OBSERVAÇÃO: geralmente essa deve ser uma instância compartilhada por várias solicitações para que a conexão subjacente com o serviço possa ser reutilizado. Não faz nada ao executar no navegador.

agent?: Agent

Valor da propriedade

Agent

body

O conteúdo do corpo HTTP da solicitação.

body?: any

Valor da propriedade

any

decompressResponse

Se a resposta deve ou não ser descompactada de acordo com Accept-Encoding cabeçalho (somente busca de nó)

decompressResponse?: boolean

Valor da propriedade

boolean

formData

Dados de formulário, usados para criar o corpo da solicitação.

formData?: any

Valor da propriedade

any

headers

Os cabeçalhos HTTP a serem usados ao fazer a solicitação.

headers: HttpHeadersLike

Valor da propriedade

HttpHeaders

keepAlive

Se a conexão deve ser reutilizado.

keepAlive?: boolean

Valor da propriedade

boolean

method

O método HTTP a ser usado ao fazer a solicitação.

method: HttpMethods

Valor da propriedade

HttpMethods

onDownloadProgress

Retorno de chamada que é acionado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Retorno de chamada que é acionado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

proxySettings

Configuração de proxy.

proxySettings?: ProxySettings

Valor da propriedade

ProxySettings

query

Uma cadeia de caracteres de consulta representada como um objeto.

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

Valor da propriedade

{[key: string]: any}

requestId

Um identificador exclusivo para a solicitação. Usado para registro em log e rastreamento.

requestId: string

Valor da propriedade

string

requestOverrides

Opções adicionais a serem definidas na solicitação. Isso fornece uma maneira de substituir os existentes ou fornecer propriedades de solicitação que não são declaradas.

Para possíveis propriedades válidas, consulte

• Opções de https.request do NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback
• RequestInit do navegador: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

AVISO: As opções especificadas aqui substituirão quaisquer propriedades com os mesmos nomes quando a solicitação for enviada pelo <xref:HttpClient>.

requestOverrides?: Record<string, unknown>

Valor da propriedade

Record<string, unknown>

streamResponseBody

Aviso

Essa API foi preterida.

Use streamResponseStatusCodes property instead.

Se o corpo do HttpOperationResponse deve ou não ser tratado como um fluxo.

streamResponseBody?: boolean

Valor da propriedade

boolean

streamResponseStatusCodes

Uma lista de códigos de status de resposta cujo corpo HttpOperationResponse correspondente deve ser tratado como um fluxo.

streamResponseStatusCodes?: Set<number>

Valor da propriedade

Set<number>

timeout

O número de milissegundos que uma solicitação pode fazer antes de ser encerrada automaticamente. Se a solicitação for encerrada, um AbortError será gerado.

timeout: number

Valor da propriedade

number

url

A URL que está sendo acessada pela solicitação.

url: string

Valor da propriedade

string

withCredentials

Se as credenciais (cookies) devem ser enviadas durante um XHR.

withCredentials: boolean

Valor da propriedade

boolean

Detalhes do método

clone()

Clone esse objeto de solicitação.

function clone(): WebResourceLike

Retornos

WebResource

prepare(unknown)

Este é um no-op para fins de compatibilidade e será lançado se chamado.

function prepare(options: unknown): WebResourceLike

Parâmetros

options

unknown

Retornos

WebResource

validateRequestProperties()

Valida se as propriedades necessárias, como método, url, cabeçalhos["Content-Type"], headers["accept-language"] são definidas. Ele gerará um erro se uma das propriedades mencionadas acima não estiver definida. Observação: este é um no-op para fins de compatibilidade.

function validateRequestProperties()