FileDownloadOptions interface
- Extends
Propriedades
abort |
Uma implementação da interface |
lease |
Condições de acesso à locação. |
max |
Opcional. DISPONÍVEL APENAS EM NODE.JS. Quantas tentativas serão executadas quando o fluxo de download do corpo original terminar inesperado. O tipo de extremidades acima não acionará a política de repetição definida em um pipeline, porque eles não emitem erros de rede. Com essa opção, cada nova tentativa adicional significa que uma solicitação adicional ShareFileClient.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 em uma rede ruim. |
on |
Faça o download do manipulador de eventos de atualização de progresso. |
range |
Quando esse cabeçalho é definido como true e especificado junto com o cabeçalho Range, o serviço retorna o hash MD5 para o intervalo, desde que o intervalo seja menor ou igual a 4 MB de tamanho. |
Propriedades Herdadas
tracing |
Detalhes de Propriedade
abortSignal
Uma implementação da interface AbortSignalLike
para sinalizar o pedido de cancelamento da operação.
Por exemplo, use o controlador @azure/abort para criar um AbortSignal
.
abortSignal?: AbortSignalLike
Valor de Propriedade
leaseAccessConditions
Condições de acesso à locação.
leaseAccessConditions?: LeaseAccessConditions
Valor de Propriedade
maxRetryRequests
Opcional. DISPONÍVEL APENAS EM NODE.JS.
Quantas tentativas serão executadas quando o fluxo de download do corpo original terminar inesperado. O tipo de extremidades acima não acionará a política de repetição definida em um pipeline, porque eles não emitem erros de rede.
Com essa opção, cada nova tentativa adicional significa que uma solicitação adicional ShareFileClient.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 em uma rede ruim.
maxRetryRequests?: number
Valor de Propriedade
number
onProgress
Faça o download do manipulador de eventos de atualização de progresso.
onProgress?: (progress: TransferProgressEvent) => void
Valor de Propriedade
(progress: TransferProgressEvent) => void
rangeGetContentMD5
Quando esse cabeçalho é definido como true e especificado junto com o cabeçalho Range, o serviço retorna o hash MD5 para o intervalo, desde que o intervalo seja menor ou igual a 4 MB de tamanho.
rangeGetContentMD5?: boolean
Valor de Propriedade
boolean
Detalhes da Propriedade Herdada
tracingOptions
tracingOptions?: OperationTracingOptions
Valor de Propriedade
herdado deCommonOptions.tracingOptions