Share via

BlobDownloadOptions interface

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

Opções para configurar a operação de transferência .

Extends
CommonOptions

Propriedades

abortSignal

Uma implementação da AbortSignalLike interface para sinalizar o pedido para cancelar a operação. Por exemplo, utilize o controlador @azure/abortar para criar um AbortSignal.
conditions

Condições a cumprir ao transferir 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 transferência do corpo original terminar inesperadamente. O tipo de extremidades acima não irá acionar a política de repetição definida num pipeline, porque não emitem erros de rede.

Com esta opção, cada repetição adicional significa que será feito um pedido adicional FileClient.download() a partir do ponto danificado, até que o intervalo pedido tenha sido transferido com êxito ou que maxRetryRequests seja atingido.

O valor predefinido é 5. Defina um valor maior ao carregar ficheiros grandes numa rede fraca.
onProgress

Chame de volta para receber eventos sobre o progresso da operação de transferência.
rangeGetContentCrc64

Quando estiver definido como verdadeiro e transferir o intervalo de blobs, o serviço devolve 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 estiver definido como verdadeiro e transferir o intervalo de blobs, o serviço devolve 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 de cadeia DateTime opaco que, quando presente, especifica o instantâneo de blob a obter.

Propriedades Herdadas

tracingOptions

Opções para configurar intervalos criados quando o rastreio está ativado.

Detalhes de Propriedade

abortSignal

Uma implementação da AbortSignalLike interface para sinalizar o pedido para cancelar a operação. Por exemplo, utilize o controlador @azure/abortar para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

conditions

Condições a cumprir ao transferir blobs.

conditions?: BlobRequestConditions

Valor de Propriedade

BlobRequestConditions

customerProvidedKey

Informações de Chave Fornecidas pelo Cliente.

customerProvidedKey?: CpkInfo

Valor de Propriedade

CpkInfo

maxRetryRequests

Opcional. DISPONÍVEL APENAS EM NODE.JS.

Quantas repetições serão executadas quando o fluxo de transferência do corpo original terminar inesperadamente. O tipo de extremidades acima não irá acionar a política de repetição definida num pipeline, porque não emitem erros de rede.

Com esta opção, cada repetição adicional significa que será feito um pedido adicional FileClient.download() a partir do ponto danificado, até que o intervalo pedido tenha sido transferido com êxito ou que maxRetryRequests seja atingido.

O valor predefinido é 5. Defina um valor maior ao carregar ficheiros grandes numa rede fraca.

maxRetryRequests?: number

Valor de Propriedade

number

onProgress

Chame de volta para receber eventos sobre o progresso da operação de transferência.

onProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

rangeGetContentCrc64

Quando estiver definido como verdadeiro e transferir o intervalo de blobs, o serviço devolve 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 de Propriedade

boolean

rangeGetContentMD5

Quando estiver definido como verdadeiro e transferir o intervalo de blobs, o serviço devolve 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 de Propriedade

boolean

snapshot

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

snapshot?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

tracingOptions

Opções para configurar intervalos criados quando o rastreio está ativado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

Herdado deCommonOptions.tracingOptions