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 abortado. Pode ser usado para anular o envio de uma solicitação de rede e a espera por uma resposta.
agent	SOMENTE NODEJS Uma opção somente nó para fornecer um http.Agent/https.Agentpersonalizado. NOTA: normalmente esta deve ser uma instância partilhada por vários pedidos para que a ligação subjacente ao serviço possa ser reutilizada. Não faz nada ao executar no navegador.
body	O conteúdo do corpo HTTP da solicitação.
decompressResponse	Descompactar ou não a resposta de acordo com Accept-Encoding cabeçalho (somente busca de nó)
formData	Dados do formulário, usados para construir 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 reutilizada.
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 carregamento.
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 e rastreamento.
requestOverrides	Opções adicionais para definir na solicitação. Isso fornece uma maneira de substituir as existentes ou fornecer propriedades de solicitação que não são declaradas. Para obter possíveis propriedades válidas, consulte Opções NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback Navegador RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit AVISO: As opções especificadas aqui substituirão quaisquer propriedades de mesmo nome quando a solicitação for enviada pela <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 levar antes de ser encerrada automaticamente. Se a solicitação for encerrada, uma AbortError será lançada.
url	O URL que está sendo acessado pela solicitação.
withCredentials	Se as credenciais (cookies) devem ser enviadas durante um XHR.

Métodos

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

Detalhes de Propriedade

abortSignal

Sinal de um controlador abortado. Pode ser usado para anular o envio de uma solicitação de rede e a espera por uma resposta.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

agent

SOMENTE NODEJS

Uma opção somente nó para fornecer um http.Agent/https.Agentpersonalizado. NOTA: normalmente esta deve ser uma instância partilhada por vários pedidos para que a ligação subjacente ao serviço possa ser reutilizada. Não faz nada ao executar no navegador.

agent?: Agent

Valor de Propriedade

Agent

body

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

body?: any

Valor de Propriedade

any

decompressResponse

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

decompressResponse?: boolean

Valor de Propriedade

boolean

formData

Dados do formulário, usados para construir o corpo da solicitação.

formData?: any

Valor de Propriedade

any

headers

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

headers: HttpHeadersLike

Valor de Propriedade

HttpHeaders

keepAlive

Se a conexão deve ser reutilizada.

keepAlive?: boolean

Valor de Propriedade

boolean

method

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

method: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

proxySettings

Configuração de proxy.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

query

Uma cadeia de caracteres de consulta representada como um objeto.

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

Valor de Propriedade

{[key: string]: any}

requestId

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

requestId: string

Valor de Propriedade

string

requestOverrides

Opções adicionais para definir na solicitação. Isso fornece uma maneira de substituir as existentes ou fornecer propriedades de solicitação que não são declaradas.

Para obter possíveis propriedades válidas, consulte

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

AVISO: As opções especificadas aqui substituirão quaisquer propriedades de mesmo nome quando a solicitação for enviada pela <xref:HttpClient>.

requestOverrides?: Record<string, unknown>

Valor de Propriedade

Record<string, unknown>

streamResponseBody

Aviso

Esta API foi preterida.

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

Valor de 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 de Propriedade

Set<number>

timeout

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

timeout: number

Valor de Propriedade

number

url

O URL que está sendo acessado pela solicitação.

url: string

Valor de Propriedade

string

withCredentials

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

withCredentials: boolean

Valor de Propriedade

boolean

Detalhes de Método

clone()

Clone este objeto de solicitação.

function clone(): WebResourceLike

Devoluções

WebResource

prepare(unknown)

Este é um no-op para fins de compat e lançará se chamado.

function prepare(options: unknown): WebResourceLike

Parâmetros

options

unknown

Devoluções

WebResource

validateRequestProperties()

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

function validateRequestProperties()