Compartilhar via

BlobDownloadOptions interface

  • Referência
Pacote:
@azure/storage-blob

Opções para configurar a <xref:BlobClient.download> operação.

Extends
CommonOptions

Propriedades

abortSignal

Uma implementação da AbortSignalLike interface para sinalizar a solicitação para cancelar a operação. Por exemplo, use o @azure/abort-controller para criar um AbortSignal.
conditions

Condições a serem atendidos ao baixar blobs.
customerProvidedKey

Informações de chave fornecidas pelo cliente.
maxRetryRequests

Opcional. DISPONÍVEL APENAS EM NODE.JS. Quantas repetições serão executadas quando o fluxo de download do corpo original for encerrado inesperadamente. O tipo acima de extremidades não disparará a política de repetição definida em um pipeline, pois elas não emitem erros de rede.

Com essa opção, cada repetição adicional significa que uma solicitação adicional FileClient.download() será feita a partir do ponto quebrado, até que o intervalo solicitado tenha sido baixado com êxito ou maxRetryRequests seja atingido.

O valor padrão é 5, defina um valor maior ao carregar arquivos grandes na rede ruim.
onProgress

Chame de volta para receber eventos sobre o andamento da operação de download.
rangeGetContentCrc64

Quando isso é definido como true e o intervalo de download do blob, o serviço retorna o hash CRC64 para o intervalo, desde que o intervalo seja menor ou igual a 4 MB de tamanho. rangeGetContentCrc64 e rangeGetContentMD5 não podem ser definidos ao mesmo tempo.
rangeGetContentMD5

Quando isso é definido como true e o intervalo de download de blob, o serviço retorna o hash MD5 para o intervalo, desde que o intervalo seja menor ou igual a 4 MB de tamanho. rangeGetContentCrc64 e rangeGetContentMD5 não podem ser definidos ao mesmo tempo.
snapshot

Um valor opaco de cadeia de caracteres DateTime que, quando presente, especifica o instantâneo de blob a ser recuperado.
tracingOptions

Opções para configurar intervalos criados quando o rastreamento está habilitado.

Detalhes da propriedade

abortSignal

Uma implementação da AbortSignalLike interface para sinalizar a solicitação para cancelar a operação. Por exemplo, use o @azure/abort-controller para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

conditions

Condições a serem atendidos ao baixar blobs.

conditions?: BlobRequestConditions

Valor da propriedade

BlobRequestConditions

customerProvidedKey

Informações de chave fornecidas pelo cliente.

customerProvidedKey?: CpkInfo

Valor da propriedade

CpkInfo

maxRetryRequests

Opcional. DISPONÍVEL APENAS EM NODE.JS. Quantas repetições serão executadas quando o fluxo de download do corpo original for encerrado inesperadamente. O tipo acima de extremidades não disparará a política de repetição definida em um pipeline, pois elas não emitem erros de rede.

Com essa opção, cada repetição adicional significa que uma solicitação adicional FileClient.download() será feita a partir do ponto quebrado, até que o intervalo solicitado tenha sido baixado com êxito ou maxRetryRequests seja atingido.

O valor padrão é 5, defina um valor maior ao carregar arquivos grandes na rede ruim.

maxRetryRequests?: number

Valor da propriedade

number

onProgress

Chame de volta para receber eventos sobre o andamento da operação de download.

onProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

rangeGetContentCrc64

Quando isso é definido como true e o intervalo de download do blob, o serviço retorna o hash CRC64 para o intervalo, desde que o intervalo seja menor ou igual a 4 MB de tamanho. rangeGetContentCrc64 e rangeGetContentMD5 não podem ser definidos ao mesmo tempo.

rangeGetContentCrc64?: boolean

Valor da propriedade

boolean

rangeGetContentMD5

Quando isso é definido como true e o intervalo de download de blob, o serviço retorna o hash MD5 para o intervalo, desde que o intervalo seja menor ou igual a 4 MB de tamanho. rangeGetContentCrc64 e rangeGetContentMD5 não podem ser definidos ao mesmo tempo.

rangeGetContentMD5?: boolean

Valor da propriedade

boolean

snapshot

Um valor opaco de cadeia de caracteres DateTime que, quando presente, especifica o instantâneo de blob a ser recuperado.

snapshot?: string

Valor da propriedade

string

tracingOptions

Opções para configurar intervalos criados quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions