@azure/storage-blob package
Classes
AccountSASPermissions |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto AccountSASSignatureValues |
AccountSASResourceTypes |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa os recursos acessíveis por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá acesso a esse tipo de recurso. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de recursos em um objeto |
AccountSASServices |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa os serviços acessíveis por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá acesso a esse serviço. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de serviços em um objeto AccountSASSignatureValues |
AnonymousCredential |
AnonymousCredential fornece um membro credentialPolicyCreator usado para criar objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS). |
AnonymousCredentialPolicy |
AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS). |
AppendBlobClient |
AppendBlobClient define um conjunto de operações aplicáveis a blobs de apêndice. |
BaseRequestPolicy |
A classe base da qual derivam todas as políticas de solicitação. |
BlobBatch |
Um BlobBatch representa um conjunto agregado de operações em blobs.
Atualmente, apenas |
BlobBatchClient |
Um BlobBatchClient permite que você faça solicitações em lote para o serviço de Blob de Armazenamento do Azure. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
BlobClient |
Um BlobClient representa uma URL para um blob de Armazenamento do Azure; O blob pode ser um blob de bloco, blob de acréscimo ou blob de página. |
BlobLeaseClient |
Um cliente que gerencia concessões para um ContainerClient ou um BlobClient. |
BlobSASPermissions |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS a um blob. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto |
BlobServiceClient |
Um BlobServiceClient representa um Cliente para o serviço de Blob de Armazenamento do Azure, permitindo que você manipule contêineres de blob. |
BlockBlobClient |
BlockBlobClient define um conjunto de operações aplicáveis a blobs de bloco. |
ContainerClient |
Um ContainerClient representa uma URL para o contêiner de Armazenamento do Azure permitindo que você manipule seus blobs. |
ContainerSASPermissions |
Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS a um contêiner.
Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação.
Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto |
Credential |
Credential é uma classe abstrata para assinatura de solicitações HTTP do Armazenamento do Azure. Essa classe hospedará uma fábrica credentialPolicyCreator que gera CredentialPolicy. |
CredentialPolicy |
Política de credenciais usada para assinar solicitações HTTP(S) antes do envio. Esta é uma classe abstrata. |
PageBlobClient |
PageBlobClient define um conjunto de operações aplicáveis a blobs de página. |
Pipeline |
Uma classe Pipeline que contém políticas de solicitação HTTP. Você pode criar um Pipeline padrão chamando newPipeline. Ou você pode criar um Pipeline com suas próprias políticas pelo construtor de Pipeline. Consulte newPipeline e as políticas fornecidas antes de implementar seu Pipeline personalizado. |
RestError |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
SASQueryParameters |
Representa os componentes que compõem os parâmetros de consulta de um SAS de Armazenamento do Azure. Este tipo não é construído diretamente pelo usuário; ele é gerado apenas pelos AccountSASSignatureValues e tipos de BlobSASSignatureValues. Uma vez gerado, ele pode ser codificado em um toString() e anexado a uma URL diretamente (embora seja necessário ter cuidado aqui caso existam parâmetros de consulta existentes, o que pode afetar os meios apropriados de anexar esses parâmetros de consulta). Observação : instâncias dessa classe são imutáveis. |
StorageBrowserPolicy |
StorageBrowserPolicy lidará com as diferenças entre Node.js e o tempo de execução do navegador, incluindo:
|
StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageBrowserPolicy. |
StorageRetryPolicy |
Política de repetição com repetição exponencial e repetição linear implementada. |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar StorageRetryPolicy objetos. |
StorageSharedKeyCredential |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure. |
StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy é uma política usada para assinar solicitações HTTP com uma chave compartilhada. |
Interfaces
AccessPolicy |
Uma política de acesso |
AccountSASPermissionsLike |
Um tipo que se parece com uma permissão SAS de conta. Usado em AccountSASPermissions para analisar permissões SAS de objetos brutos. |
AccountSASSignatureValues |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. AccountSASSignatureValues é usado para gerar uma Assinatura de Acesso Compartilhado (SAS) para uma conta de Armazenamento do Azure. Uma vez que todos os valores aqui são definidos adequadamente, chame generateAccountSASQueryParameters para obter uma representação do SAS que pode realmente ser aplicado a urls de blob. Nota: que tanto esta classe como SASQueryParameters existir porque a primeira é mutável e uma representação lógica, enquanto a segunda é imutável e usada para gerar solicitações REST reais. Consulte https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obter mais informações conceituais sobre SAS Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas para obter descrições dos parâmetros, incluindo quais são necessários |
AppendBlobAppendBlockFromURLOptions |
Opções para configurar o operação de appendBlockFromURL. |
AppendBlobAppendBlockFromUrlHeaders |
Define cabeçalhos para AppendBlob_appendBlockFromUrl operação. |
AppendBlobAppendBlockHeaders |
Define cabeçalhos para AppendBlob_appendBlock operação. |
AppendBlobAppendBlockOptions |
Opções para configurar o operação appendBlock. |
AppendBlobCreateHeaders |
Define cabeçalhos para AppendBlob_create operação. |
AppendBlobCreateIfNotExistsOptions |
Opções para configurar createIfNotExists operação. |
AppendBlobCreateIfNotExistsResponse |
Contém dados de resposta para a operação <xref:appendBlobClient.createIfNotExists>. |
AppendBlobCreateOptions |
Opções para configurar criar operação. |
AppendBlobRequestConditions |
Condições a serem adicionadas à criação deste blob de acréscimo. |
AppendBlobSealOptions |
Opções para configurar selo operação. |
AppendPositionAccessConditions |
Grupo de parâmetros |
BatchSubRequest |
Uma solicitação associada a uma operação em lote. |
BatchSubResponse |
Os dados de resposta associados a uma única solicitação dentro de uma operação em lote. |
BlobAbortCopyFromURLHeaders |
Define cabeçalhos para Blob_abortCopyFromURL operação. |
BlobAbortCopyFromURLOptions |
Opções para configurar o operação abortCopyFromURL. |
BlobAcquireLeaseOptions |
Opções para configurar a operação Blob - Acquire Lease. |
BlobBatchSubmitBatchOptionalParams |
Opções para configurar o Serviço - Enviar Parâmetros Opcionais em Lote. |
BlobBeginCopyFromURLOptions |
Opções para configurar o operação beginCopyFromURL. |
BlobBeginCopyFromURLResponse |
Contém dados de resposta para o operação de beginCopyFromURL. |
BlobBeginCopyFromUrlPollState |
O estado usado pelo poller retornado de beginCopyFromURL. Esse estado é passado para o retorno de chamada |
BlobBreakLeaseOptions |
Opções para configurar a operação Blob - Break Lease. |
BlobChangeLeaseOptions |
Opções para configurar a operação Blob - Change Lease. |
BlobCopyFromURLHeaders |
Define cabeçalhos para Blob_copyFromURL operação. |
BlobCreateSnapshotHeaders |
Define cabeçalhos para Blob_createSnapshot operação. |
BlobCreateSnapshotOptions |
Opções para configurar o createSnapshot operação. |
BlobDeleteHeaders |
Define cabeçalhos para Blob_delete operação. |
BlobDeleteIfExistsResponse |
Contém dados de resposta para o operação deleteIfExists. |
BlobDeleteImmutabilityPolicyHeaders |
Define cabeçalhos para Blob_deleteImmutabilityPolicy operação. |
BlobDeleteImmutabilityPolicyOptions |
Opções para excluir a política de imutabilidade deleteImmutabilityPolicy operação. |
BlobDeleteOptions |
Opções para configurar o excluir operação. |
BlobDownloadHeaders |
Define cabeçalhos para Blob_download operação. |
BlobDownloadOptionalParams |
Parâmetros opcionais. |
BlobDownloadOptions |
Opções para configurar o download operação. |
BlobDownloadResponseParsed |
Contém dados de resposta para o download operação. |
BlobDownloadToBufferOptions |
Interface de opção para o operação de downloadToBuffer. |
BlobExistsOptions |
Opções para configurar o existe operação. |
BlobFlatListSegment |
Uma interface que representa BlobFlatListSegment. |
BlobFlatListSegmentModel | |
BlobGenerateSasUrlOptions |
Opções para configurar generateSasUrl operação. |
BlobGetAccountInfoHeaders |
Define cabeçalhos para Blob_getAccountInfo operação. |
BlobGetAccountInfoOptions |
Opções para configurar o operação de getAccountInfo. |
BlobGetPropertiesHeaders |
Define cabeçalhos para Blob_getProperties operação. |
BlobGetPropertiesOptions |
Opções para configurar o getProperties operação. |
BlobGetPropertiesResponse |
Contém dados de resposta para a operação |
BlobGetTagsHeaders |
Define cabeçalhos para Blob_getTags operação. |
BlobGetTagsOptions |
Opções para configurar o getTags operação. |
BlobHTTPHeaders |
Grupo de parâmetros |
BlobHierarchyListSegment |
Uma interface que representa BlobHierarchyListSegment. |
BlobHierarchyListSegmentModel | |
BlobImmutabilityPolicy |
Descreva a política imutável para blob. |
BlobItem |
Um blob de armazenamento do Azure |
BlobItemInternal |
Um blob de armazenamento do Azure |
BlobPrefix | |
BlobProperties |
Propriedades de um blob |
BlobQueryArrowConfiguration |
Opções para consultar blob com o formato de seta Apache. Válido apenas para outputTextConfiguration. |
BlobQueryArrowField |
Descreva um campo no BlobQueryArrowConfiguration. |
BlobQueryCsvTextConfiguration |
Opções para consultar blob com formato CSV. |
BlobQueryError |
Tipo de erro de consulta Blob. |
BlobQueryHeaders |
Define cabeçalhos para Blob_query operação. |
BlobQueryJsonTextConfiguration |
Opções para consultar blob com formato JSON. |
BlobQueryParquetConfiguration |
Opções para consultar blob com o formato Parquet. Válido apenas para inputTextConfiguration. |
BlobReleaseLeaseOptions |
Opções para configurar a operação Blob - Release Lease. |
BlobRenewLeaseOptions |
Opções para configurar a operação Blob - Renew Lease. |
BlobRequestConditions |
cabeçalhos condicionais HTTP padrão, condição de tags e condição de concessão |
BlobSASPermissionsLike |
Um tipo que se parece com uma permissão SAS de Blob. Usado em BlobSASPermissions para analisar permissões SAS de objetos brutos. |
BlobSASSignatureValues |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. BlobSASSignatureValues é usado para ajudar a gerar tokens SAS de serviço de Blob para contêineres ou blobs. |
BlobServiceProperties |
Propriedades do serviço de armazenamento. |
BlobServiceStatistics |
Estatísticas para o serviço de armazenamento. |
BlobSetHTTPHeadersHeaders |
Define cabeçalhos para Blob_setHttpHeaders operação. |
BlobSetHTTPHeadersOptions |
Opções para configurar o setHTTPHeaders operação. |
BlobSetImmutabilityPolicyHeaders |
Define cabeçalhos para Blob_setImmutabilityPolicy operação. |
BlobSetImmutabilityPolicyOptions |
Opções para definir a política de imutabilidade setImmutabilityPolicy operação. |
BlobSetLegalHoldHeaders |
Define cabeçalhos para Blob_setLegalHold operação. |
BlobSetLegalHoldOptions |
Opções para definir a retenção legal operação de setLegalHold. |
BlobSetMetadataHeaders |
Define cabeçalhos para Blob_setMetadata operação. |
BlobSetMetadataOptions |
Opções para configurar o setMetadata operação. |
BlobSetTagsHeaders |
Define cabeçalhos para Blob_setTags operação. |
BlobSetTagsOptions |
Opções para configurar o setTags operação. |
BlobSetTierHeaders |
Define cabeçalhos para Blob_setTier operação. |
BlobSetTierOptions |
Opções para configurar o operação de setAccessTier. |
BlobStartCopyFromURLHeaders |
Define cabeçalhos para Blob_startCopyFromURL operação. |
BlobStartCopyFromURLOptions |
Opções para configurar o operação beginCopyFromURL. |
BlobSyncCopyFromURLOptions |
Opções para configurar o operação de syncCopyFromURL. |
BlobTag | |
BlobTags |
Tags de Blob |
BlobUndeleteHeaders |
Define cabeçalhos para Blob_undelete operação. |
BlobUndeleteOptions |
Opções para configurar o undelete operação. |
Block |
Representa um único bloco em um blob de bloco. Descreve o ID e o tamanho do bloco. |
BlockBlobCommitBlockListHeaders |
Define cabeçalhos para BlockBlob_commitBlockList operação. |
BlockBlobCommitBlockListOptions |
Opções para configurar operação de commitBlockList. |
BlockBlobGetBlockListHeaders |
Define cabeçalhos para BlockBlob_getBlockList operação. |
BlockBlobGetBlockListOptions |
Opções para configurar operação de getBlockList. |
BlockBlobParallelUploadOptions |
Interface de opção para uploadFile e <xref:BlockBlobClient.uploadSeekableStream>. |
BlockBlobPutBlobFromUrlHeaders |
Define cabeçalhos para BlockBlob_putBlobFromUrl operação. |
BlockBlobQueryOptions |
Opções para configurar consulta operação. |
BlockBlobStageBlockFromURLHeaders |
Define cabeçalhos para BlockBlob_stageBlockFromURL operação. |
BlockBlobStageBlockFromURLOptions |
Opções para configurar operação de stageBlockFromURL. |
BlockBlobStageBlockHeaders |
Define cabeçalhos para BlockBlob_stageBlock operação. |
BlockBlobStageBlockOptions |
Opções para configurar stageBlock operação. |
BlockBlobSyncUploadFromURLOptions |
Opções para configurar operação de syncUploadFromURL. |
BlockBlobUploadHeaders |
Define cabeçalhos para BlockBlob_upload operação. |
BlockBlobUploadOptions |
Opções para configurar carregar operação. |
BlockBlobUploadStreamOptions |
Interface de opção para o operação de uploadStream. |
BlockList | |
ClearRange | |
CommonGenerateSasUrlOptions |
Opções comuns de BlobGenerateSasUrlOptions e ContainerGenerateSasUrlOptions. |
CommonOptions |
Uma interface para opções comuns a todas as operações remotas. |
ContainerAcquireLeaseOptions |
Opções para configurar a operação Container - Acquire Lease. |
ContainerBreakLeaseOptionalParams |
Parâmetros opcionais. |
ContainerBreakLeaseOptions |
Opções para configurar a operação Container - Break Lease. |
ContainerChangeLeaseOptions |
Opções para configurar a operação Container - Change Lease. |
ContainerCreateHeaders |
Define cabeçalhos para Container_create operação. |
ContainerCreateIfNotExistsResponse |
Contém dados de resposta para o operação createIfNotExists. |
ContainerCreateOptions |
Opções para configurar criar operação. |
ContainerDeleteBlobOptions |
Opções para configurar o operação de deleteBlob. |
ContainerDeleteHeaders |
Define cabeçalhos para Container_delete operação. |
ContainerDeleteIfExistsResponse |
Contém dados de resposta para o operação deleteIfExists. |
ContainerDeleteMethodOptions |
Opções para configurar excluir operação. |
ContainerEncryptionScope |
Grupo de parâmetros |
ContainerExistsOptions |
Opções para configurar existe operação. |
ContainerFilterBlobsHeaders |
Define cabeçalhos para Container_filterBlobs operação. |
ContainerFindBlobByTagsOptions |
Opções para configurar o findBlobsByTags operação. |
ContainerGenerateSasUrlOptions |
Opções para configurar generateSasUrl operação. |
ContainerGetAccessPolicyHeaders |
Define cabeçalhos para Container_getAccessPolicy operação. |
ContainerGetAccessPolicyOptions |
Opções para configurar operação getAccessPolicy. |
ContainerGetAccountInfoHeaders |
Define cabeçalhos para Container_getAccountInfo operação. |
ContainerGetAccountInfoOptions |
Opções para configurar o operação de getAccountInfo. |
ContainerGetPropertiesHeaders |
Define cabeçalhos para Container_getProperties operação. |
ContainerGetPropertiesOptions |
Opções para configurar operação getProperties. |
ContainerItem |
Um contêiner de Armazenamento do Azure |
ContainerListBlobFlatSegmentHeaders |
Define cabeçalhos para Container_listBlobFlatSegment operação. |
ContainerListBlobHierarchySegmentHeaders |
Define cabeçalhos para Container_listBlobHierarchySegment operação. |
ContainerListBlobsOptions |
Opções para configurar operações de Contêiner - Listar Blobs. Veja: |
ContainerProperties |
Propriedades de um recipiente |
ContainerReleaseLeaseOptions |
Opções para configurar a operação Container - Release Lease. |
ContainerRenameHeaders |
Define cabeçalhos para Container_rename operação. |
ContainerRenewLeaseOptions |
Opções para configurar a operação Container - Renew Lease. |
ContainerRequestConditions |
Condições a cumprir para o contentor. |
ContainerSASPermissionsLike |
Um tipo que se parece com uma permissão SAS de contêiner. Usado em ContainerSASPermissions para analisar permissões SAS de objetos brutos. |
ContainerSetAccessPolicyHeaders |
Define cabeçalhos para Container_setAccessPolicy operação. |
ContainerSetAccessPolicyOptions |
Opções para configurar setAccessPolicy operação. |
ContainerSetMetadataHeaders |
Define cabeçalhos para Container_setMetadata operação. |
ContainerSetMetadataOptions |
Opções para configurar setMetadata operação. |
ContainerUndeleteHeaders |
Define cabeçalhos para Container_restore operação. |
CorsRule |
O CORS é um recurso HTTP que permite que um aplicativo Web executado em um domínio acesse recursos em outro domínio. Os navegadores da Web implementam uma restrição de segurança conhecida como política de mesma origem que impede que uma página da Web chame APIs em um domínio diferente; O CORS fornece uma maneira segura de permitir que um domínio (o domínio de origem) chame APIs em outro domínio |
CpkInfo |
Grupo de parâmetros |
FilterBlobItem |
Informações de Blob de um findBlobsByTags |
FilterBlobItemModel |
Informações de Blob de uma chamada da API de Blobs de Filtro |
FilterBlobSegment |
Resposta de segmento de findBlobsByTags operação. |
FilterBlobSegmentModel |
O resultado de uma chamada à API de Blobs de Filtro |
GeoReplication |
Geo-Replication informações para o Serviço de Armazenamento Secundário |
HttpAuthorization |
Representa informações de autenticação em valores de cabeçalho Authorization, ProxyAuthorization, WWW-Authenticate e Proxy-Authenticate. |
HttpHeaders |
Uma coleção de pares chave/valor de cabeçalho HTTP. |
HttpOperationResponse |
Resposta Http compatível com o core-v1(core-http). |
HttpResponse |
Uma representação de uma resposta HTTP que inclui uma referência à solicitação que a originou. |
IHttpClient |
Uma interface compatível para políticas de solicitação core-http |
Lease |
Os detalhes de uma locação específica. |
LeaseAccessConditions |
Grupo de parâmetros |
LeaseOperationOptions |
Configura operações de locação. |
ListBlobsFlatSegmentResponse |
Uma enumeração de blobs |
ListBlobsFlatSegmentResponseModel |
Uma enumeração de blobs |
ListBlobsHierarchySegmentResponse |
Uma enumeração de blobs |
ListBlobsHierarchySegmentResponseModel |
Uma enumeração de blobs |
ListContainersSegmentResponse |
Uma enumeração de contêineres |
Logging |
Configurações de Log do Azure Analytics. |
MatchConditions |
Especifica opções HTTP para solicitações condicionais com base na correspondência ETag. |
Metadata |
Um mapa de pares nome-valor para associar ao recurso. |
Metrics |
um resumo das estatísticas de solicitação agrupadas pela API em agregações de hora ou minuto para blobs |
ModificationConditions |
Especifica opções HTTP para solicitações condicionais com base no tempo de modificação. |
ModifiedAccessConditions |
condição padrão de cabeçalhos e tags condicionais HTTP. |
ModifiedAccessConditionsModel |
Grupo de parâmetros |
ObjectReplicationPolicy |
Contém a ID da Política de Replicação de Objetos e a respetiva lista de ObjectReplicationRule. Isso é usado ao recuperar as Propriedades de Replicação de Objetos no blob de origem. A id de política para o blob de destino é definida em ObjectReplicationDestinationPolicyId das respetivas respostas do método (por exemplo, <xref:BlobProperties.ObjectReplicationDestinationPolicyId>. |
ObjectReplicationRule |
Contém a ID da Regra de Replicação de Objetos e ObjectReplicationStatus de um blob. Pode haver mais de um ObjectReplicationRule em um ObjectReplicationPolicy. |
PageBlobClearPagesHeaders |
Define cabeçalhos para PageBlob_clearPages operação. |
PageBlobClearPagesOptions |
Opções para configurar o operação de clearPages. |
PageBlobCopyIncrementalHeaders |
Define cabeçalhos para PageBlob_copyIncremental operação. |
PageBlobCreateHeaders |
Define cabeçalhos para PageBlob_create operação. |
PageBlobCreateIfNotExistsOptions |
Opções para configurar o createIfNotExists operação. |
PageBlobCreateIfNotExistsResponse |
Contém dados de resposta para o operação createIfNotExists. |
PageBlobCreateOptions |
Opções para configurar o criar operação. |
PageBlobGetPageRangesDiffHeaders |
Define cabeçalhos para PageBlob_getPageRangesDiff operação. |
PageBlobGetPageRangesDiffOptions |
Opções para configurar a operação <xref:PageBlobClient.getRangesDiff>. |
PageBlobGetPageRangesDiffResponse |
Contém dados de resposta para a operação getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions). |
PageBlobGetPageRangesHeaders |
Define cabeçalhos para PageBlob_getPageRanges operação. |
PageBlobGetPageRangesOptions |
Opções para configurar o getPageRanges operação. |
PageBlobGetPageRangesResponse |
Contém dados de resposta para a operação getPageRanges(number, number, PageBlobGetPageRangesOptions). |
PageBlobListPageRangesDiffOptions |
Opções para configurar o operação listPageRangesDiff. |
PageBlobListPageRangesOptions |
Opções para configurar o listPageRanges operação. |
PageBlobRequestConditions |
Condições para adicionar à criação deste blob de página. |
PageBlobResizeHeaders |
Define cabeçalhos para PageBlob_resize operação. |
PageBlobResizeOptions |
Opções para configurar redimensionar operação. |
PageBlobStartCopyIncrementalOptions |
Opções para configurar operação de startCopyIncremental. |
PageBlobUpdateSequenceNumberHeaders |
Define cabeçalhos para PageBlob_updateSequenceNumber operação. |
PageBlobUpdateSequenceNumberOptions |
Opções para configurar operação de updateSequenceNumber. |
PageBlobUploadPagesFromURLHeaders |
Define cabeçalhos para PageBlob_uploadPagesFromURL operação. |
PageBlobUploadPagesFromURLOptions |
Opções para configurar operação de uploadPagesFromURL. |
PageBlobUploadPagesHeaders |
Define cabeçalhos para PageBlob_uploadPages operação. |
PageBlobUploadPagesOptions |
Opções para configurar o uploadPages operação. |
PageList |
Lista de intervalos de páginas para um blob. |
PageListInternal |
a lista de páginas |
PageRange | |
PageRangeInfo | |
ParsedBatchResponse |
A resposta com várias partes/mista que contém a resposta para cada subsolicitação. |
PipelineLike |
Uma interface para a classe Consulte newPipeline e as políticas fornecidas antes de implementar seu Pipeline personalizado. |
PipelineOptions |
Interface de opção para o construtor Pipeline. |
PollOperationState |
PollOperationState contém uma lista opinativa do menor conjunto de propriedades necessárias para definir qualquer poller de operação de longa duração. Enquanto a classe Poller funciona como o mecanismo de controle local para iniciar o acionamento, aguardar e potencialmente cancelar uma operação de longa duração, o PollOperationState documenta o status da operação remota de longa duração. Ele deve ser atualizado pelo menos quando a operação for iniciada, quando for concluída e quando for cancelada. No entanto, as implementações podem ter qualquer outro número de propriedades que podem ser atualizadas por outros motivos. |
PollerLike |
Representação abstrata de um poller, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar. |
PollerLikeWithCancellation |
Representação abstrata de um poller, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar. |
Range |
Intervalo para operações de serviço de Blob. |
RequestPolicyFactory |
Uma interface para compatibilidade com RequestPolicyFactory do core-http |
RequestPolicyOptions |
Uma interface para compatibilidade com RequestPolicy |
ResponseLike |
Um objeto com uma propriedade _response simples. |
ResponseWithBody |
Um objeto com uma propriedade _response que tem corpo e cabeçalhos já analisados em tipos conhecidos. |
ResponseWithHeaders |
Um objeto com uma propriedade _response que tem cabeçalhos já analisados em um objeto tipado. |
RetentionPolicy |
a política de retenção que determina por quanto tempo os dados associados devem persistir |
SASQueryParametersOptions |
Opções para construir SASQueryParameters. |
SasIPRange |
Intervalo de IP permitido para uma SAS. |
SequenceNumberAccessConditions |
Grupo de parâmetros |
ServiceClientOptions |
Um subconjunto de |
ServiceFilterBlobsHeaders |
Define cabeçalhos para Service_filterBlobs operação. |
ServiceFindBlobByTagsOptions |
Opções para configurar o findBlobsByTags operação. |
ServiceGenerateAccountSasUrlOptions |
Opções para configurar generateAccountSasUrl operação. |
ServiceGetAccountInfoHeaders |
Define cabeçalhos para Service_getAccountInfo operação. |
ServiceGetAccountInfoOptions |
Opções para configurar o operação de getAccountInfo. |
ServiceGetPropertiesHeaders |
Define cabeçalhos para Service_getProperties operação. |
ServiceGetPropertiesOptions |
Opções para configurar o getProperties operação. |
ServiceGetStatisticsHeaders |
Define cabeçalhos para Service_getStatistics operação. |
ServiceGetStatisticsOptions |
Opções para configurar o operação de getStatistics. |
ServiceGetUserDelegationKeyHeaders |
Define cabeçalhos para Service_getUserDelegationKey operação. |
ServiceGetUserDelegationKeyOptions |
Opções para configurar o Serviço - Obter Chave de Delegação de Usuário. |
ServiceListContainersOptions |
Opções para configurar o listContainers operação. |
ServiceListContainersSegmentHeaders |
Define cabeçalhos para Service_listContainersSegment operação. |
ServiceRenameContainerOptions |
Opções para configurar <xref:BlobServiceClient.renameContainer> operação. |
ServiceSetPropertiesHeaders |
Define cabeçalhos para Service_setProperties operação. |
ServiceSetPropertiesOptions |
Opções para configurar o setProperties operação. |
ServiceSubmitBatchHeaders |
Define cabeçalhos para Service_submitBatch operação. |
ServiceSubmitBatchOptionalParamsModel |
Parâmetros opcionais. |
ServiceUndeleteContainerOptions |
Opções para configurar operação de undeleteContainer. |
SignedIdentifier |
Identificador assinado. |
SignedIdentifierModel |
identificador assinado |
StaticWebsite |
As propriedades que permitem que uma conta hospede um site estático |
StoragePipelineOptions |
Interface de opções para a função |
StorageRetryOptions |
Interface de opções de repetição de Blob de armazenamento. |
TagConditions |
Especifica opções HTTP para solicitações condicionais baseadas em tags blob. |
UserDelegationKey |
Uma chave de delegação de usuário. |
UserDelegationKeyModel |
Uma chave de delegação de usuário |
WebResource |
Uma descrição de uma solicitação HTTP a ser feita a um servidor remoto. |
Aliases de Tipo
AccessTier |
Define valores para AccessTier. |
AccountKind |
Define valores para AccountKind. |
AppendBlobAppendBlockFromUrlResponse |
Contém dados de resposta para a operação appendBlockFromUrl. |
AppendBlobAppendBlockResponse |
Contém dados de resposta para a operação appendBlock. |
AppendBlobCreateResponse |
Contém dados de resposta para a operação create. |
ArchiveStatus |
Define valores para ArchiveStatus. |
BlobAbortCopyFromURLResponse |
Contém dados de resposta para a operação abortCopyFromURL. |
BlobBatchDeleteBlobsResponse |
Contém dados de resposta para a operação deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions). |
BlobBatchSetBlobsAccessTierResponse |
Contém dados de resposta para a operação setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions). |
BlobBatchSubmitBatchResponse |
Contém dados de resposta para operações de lote de blob. |
BlobCopyFromURLResponse |
Contém dados de resposta para a operação copyFromURL. |
BlobCopySourceTags |
Define valores para BlobCopySourceTags. |
BlobCreateSnapshotResponse |
Contém dados de resposta para a operação createSnapshot. |
BlobDeleteImmutabilityPolicyResponse |
Contém dados de resposta para a operação deleteImmutabilityPolicy. |
BlobDeleteResponse |
Contém dados de resposta para a operação de exclusão. |
BlobDownloadResponseInternal |
Contém dados de resposta para a operação de download. |
BlobDownloadResponseModel |
Contém dados de resposta para a operação de download. |
BlobGetAccountInfoResponse |
Contém dados de resposta para a operação getAccountInfo. |
BlobGetPropertiesResponseModel |
Contém dados de resposta para a operação getProperties. |
BlobGetTagsResponse |
Contém dados de resposta para a operação |
BlobImmutabilityPolicyMode |
Define valores para BlobImmutabilityPolicyMode. |
BlobQueryArrowFieldType |
O tipo de um BlobQueryArrowField. |
BlobQueryResponseInternal |
Contém dados de resposta para a operação de consulta. |
BlobQueryResponseModel |
Contém dados de resposta para a operação de consulta. |
BlobSetHTTPHeadersResponse |
Contém dados de resposta para a operação setHttpHeaders. |
BlobSetImmutabilityPolicyResponse |
Contém dados de resposta para a operação setImmutabilityPolicy. |
BlobSetLegalHoldResponse |
Contém dados de resposta para a operação setLegalHold. |
BlobSetMetadataResponse |
Contém dados de resposta para a operação setMetadata. |
BlobSetTagsResponse |
Contém dados de resposta para a operação setTags. |
BlobSetTierResponse |
Contém dados de resposta para a operação setTier. |
BlobStartCopyFromURLResponse |
Contém dados de resposta para a operação startCopyFromURL. |
BlobType |
Define valores para BlobType. |
BlobUndeleteResponse |
Contém dados de resposta para a operação de undelete. |
BlobUploadCommonResponse |
Tipo de resposta para uploadFile, uploadStreame <xref:BlockBlobClient.uploadBrowserDate>. |
BlockBlobCommitBlockListResponse |
Contém dados de resposta para a operação commitBlockList. |
BlockBlobGetBlockListResponse |
Contém dados de resposta para a operação getBlockList. |
BlockBlobGetBlockListResponseInternal |
Contém dados de resposta para a operação getBlockList. |
BlockBlobPutBlobFromUrlResponse |
Contém dados de resposta para a operação putBlobFromUrl. |
BlockBlobStageBlockFromURLResponse |
Contém dados de resposta para a operação stageBlockFromURL. |
BlockBlobStageBlockResponse |
Contém dados de resposta para a operação stageBlock. |
BlockBlobUploadResponse |
Contém dados de resposta para a operação de carregamento. |
BlockListType |
Define valores para BlockListType. |
ContainerCreateResponse |
Contém dados de resposta para a operação create. |
ContainerDeleteResponse |
Contém dados de resposta para a operação de exclusão. |
ContainerFilterBlobsResponse |
Contém dados de resposta para a operação filterBlobs. |
ContainerFindBlobsByTagsSegmentResponse |
A resposta de findBlobsByTags operação. |
ContainerGetAccessPolicyResponse |
Contém dados de resposta para o operação getAccessPolicy. |
ContainerGetAccessPolicyResponseModel |
Contém dados de resposta para a operação getAccessPolicy. |
ContainerGetAccountInfoResponse |
Contém dados de resposta para a operação getAccountInfo. |
ContainerGetPropertiesResponse |
Contém dados de resposta para a operação getProperties. |
ContainerListBlobFlatSegmentResponse |
Contém dados de resposta para a operação listBlobFlatSegment. |
ContainerListBlobHierarchySegmentResponse |
Contém dados de resposta para a operação listBlobHierarchySegment. |
ContainerRenameResponse |
Contém dados de resposta para a operação de renomeação. |
ContainerSetAccessPolicyResponse |
Contém dados de resposta para a operação setAccessPolicy. |
ContainerSetMetadataResponse |
Contém dados de resposta para a operação setMetadata. |
ContainerUndeleteResponse |
Contém dados de resposta para a operação de restauração. |
CopyPollerBlobClient |
Define as operações de um BlobClient |
CopyStatusType |
Define valores para CopyStatusType. |
CredentialPolicyCreator |
Uma função de fábrica que cria uma nova CredentialPolicy que usa a nextPolicy fornecida. |
DeleteSnapshotsOptionType |
Define valores para DeleteSnapshotsOptionType. |
EncryptionAlgorithmType |
Define valores para EncryptionAlgorithmType. Valores conhecidos suportados pelo serviçoAES256 |
GeoReplicationStatusType |
Define valores para GeoReplicationStatusType. |
HttpRequestBody |
Tipos de organismos apoiados no pedido. NodeJS.ReadableStream e () => NodeJS.ReadableStream é somente Node. Blob, ReadableStream e () => ReadableStream são apenas navegadores. |
LeaseDurationType |
Define valores para LeaseDurationType. |
LeaseOperationResponse |
Contém os dados de resposta para operações que criam, modificam ou excluem uma concessão. Consulte BlobLeaseClient. |
LeaseStateType |
Define valores para LeaseStateType. |
LeaseStatusType |
Define valores para LeaseStatusType. |
ObjectReplicationStatus |
Especifica o Status de Replicação de um blob. Isso é usado quando uma conta de armazenamento tem políticas de replicação de objetos aplicadas. Consulte ObjectReplicationPolicy e ObjectReplicationRule. |
PageBlobClearPagesResponse |
Contém dados de resposta para a operação clearPages. |
PageBlobCopyIncrementalResponse |
Contém dados de resposta para a operação copyIncremental. |
PageBlobCreateResponse |
Contém dados de resposta para a operação create. |
PageBlobGetPageRangesDiffResponseInternal |
Contém dados de resposta para a operação getPageRangesDiff. |
PageBlobGetPageRangesDiffResponseModel |
Contém dados de resposta para a operação getPageRangesDiff. |
PageBlobGetPageRangesResponseInternal |
Contém dados de resposta para a operação getPageRanges. |
PageBlobGetPageRangesResponseModel |
Contém dados de resposta para a operação getPageRanges. |
PageBlobResizeResponse |
Contém dados de resposta para a operação de redimensionamento. |
PageBlobUpdateSequenceNumberResponse |
Contém dados de resposta para a operação updateSequenceNumber. |
PageBlobUploadPagesFromURLResponse |
Contém dados de resposta para a operação uploadPagesFromURL. |
PageBlobUploadPagesResponse |
Contém dados de resposta para a operação uploadPages. |
PublicAccessType |
Define valores para PublicAccessType. |
RehydratePriority |
Define valores para RehydratePriority. |
SequenceNumberActionType |
Define valores para SequenceNumberActionType. |
ServiceFindBlobsByTagsSegmentResponse |
A resposta de findBlobsByTags operação. |
ServiceGetAccountInfoResponse |
Contém dados de resposta para a operação getAccountInfo. |
ServiceGetPropertiesResponse |
Contém dados de resposta para a operação getProperties. |
ServiceGetPropertiesResponseInternal |
Contém dados de resposta para a operação getProperties. |
ServiceGetStatisticsResponse |
Contém dados de resposta para a operação getStatistics. |
ServiceGetStatisticsResponseInternal |
Contém dados de resposta para a operação getStatistics. |
ServiceGetUserDelegationKeyResponse |
Contém dados de resposta para a operação getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions). |
ServiceListContainersSegmentResponse |
Contém dados de resposta para a operação listContainersSegment. |
ServiceListContainersSegmentResponseInternal |
Contém dados de resposta para a operação listContainersSegment. |
ServiceSetPropertiesResponse |
Contém dados de resposta para a operação setProperties. |
ServiceSubmitBatchResponseInternal |
Contém dados de resposta para a operação submitBatch. |
ServiceSubmitBatchResponseModel |
Contém dados de resposta para a operação submitBatch. |
SkuName |
Define valores para SkuName. |
SyncCopyStatusType |
Define valores para SyncCopyStatusType. |
Tags |
Tags de blob. |
WithResponse |
Um tipo que representa um resultado de operação com uma propriedade _response conhecida. |
Enumerações
BlockBlobTier |
Representa a camada de acesso em um blob. Para obter informações detalhadas sobre a hierarquização em nível de blob de bloco, consulte Níveis de armazenamento quentes, frescos e de arquivamento. |
KnownEncryptionAlgorithmType |
Os valores conhecidos de EncryptionAlgorithmType que o serviço aceita. |
PremiumPageBlobTier |
Especifica a camada de blob de página para definir o blob. Isso só é aplicável a blobs de página em contas de armazenamento premium. Consulte aqui para obter informações detalhadas sobre o IOPS correspondente e a taxa de transferência por PageBlobTier. |
SASProtocol |
Protocolos para SAS gerado. |
StorageBlobAudience |
Define os públicos de nuvem conhecidos para armazenamento. |
StorageRetryPolicyType |
Tipos RetryPolicy. |
Funções
generate |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
generate |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters. Só aceita as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador. AVISO: Quando o identificador não é fornecido, as permissões e expirações são necessárias. Você DEVE atribuir valor ao identificador ou expira & permissões manualmente se você inicializar com este construtor. Preencha os detalhes necessários antes de executar os seguintes trechos. Exemplo de uso:
Exemplo usando um identificador:
Exemplo usando um nome de blob:
|
generate |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters. AVISO: identificador será ignorado ao gerar delegação de usuário SAS, permissões e expirações são necessárias. Exemplo de uso:
|
get |
Para obter o público OAuth para uma conta de armazenamento para o serviço de blob. |
is |
Um auxiliar para decidir se um determinado argumento satisfaz o contrato de Pipeline |
new |
Cria um novo objeto Pipeline com Credential fornecido. |
Detalhes de Função
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.
Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.
Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Parâmetros
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Devoluções
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.
Cria uma instância de SASQueryParameters.
Só aceita as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador.
AVISO: Quando o identificador não é fornecido, as permissões e expirações são necessárias. Você DEVE atribuir valor ao identificador ou expira & permissões manualmente se você inicializar com este construtor.
Preencha os detalhes necessários antes de executar os seguintes trechos.
Exemplo de uso:
// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
containerName, // Required
permissions: ContainerSASPermissions.parse("racwdl"), // Required
startsOn: new Date(), // Optional
expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Required. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2016-05-31" // Optional
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
Exemplo usando um identificador:
// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
{
accessPolicy: {
expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Date type
permissions: ContainerSASPermissions.parse("racwdl").toString(),
startsOn: new Date() // Date type
},
id: identifier
}
]);
const containerSAS = generateBlobSASQueryParameters(
{
containerName, // Required
identifier // Required
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
Exemplo usando um nome de blob:
// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
containerName, // Required
blobName, // Required
permissions: BlobSASPermissions.parse("racwd"), // Required
startsOn: new Date(), // Optional
expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Required. Date type
cacheControl: "cache-control-override", // Optional
contentDisposition: "content-disposition-override", // Optional
contentEncoding: "content-encoding-override", // Optional
contentLanguage: "content-language-override", // Optional
contentType: "content-type-override", // Optional
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2016-05-31" // Optional
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Parâmetros
- blobSASSignatureValues
- BlobSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Devoluções
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.
Cria uma instância de SASQueryParameters. AVISO: identificador será ignorado ao gerar delegação de usuário SAS, permissões e expirações são necessárias.
Exemplo de uso:
// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
containerName, // Required
permissions: ContainerSASPermissions.parse("racwdl"), // Required
startsOn, // Optional. Date type
expiresOn, // Required. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
},
userDelegationKey, // UserDelegationKey
accountName
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters
Parâmetros
- blobSASSignatureValues
- BlobSASSignatureValues
- userDelegationKey
- UserDelegationKey
Valor de retorno de blobServiceClient.getUserDelegationKey()
- accountName
-
string
Devoluções
getBlobServiceAccountAudience(string)
Para obter o público OAuth para uma conta de armazenamento para o serviço de blob.
function getBlobServiceAccountAudience(storageAccountName: string): string
Parâmetros
- storageAccountName
-
string
Devoluções
string
isPipelineLike(unknown)
Um auxiliar para decidir se um determinado argumento satisfaz o contrato de Pipeline
function isPipelineLike(pipeline: unknown): pipeline
Parâmetros
- pipeline
-
unknown
Um argumento que pode ser um Pipeline
Devoluções
pipeline
true quando o argumento satisfaz o contrato de pipeline
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria um novo objeto Pipeline com Credential fornecido.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline
Parâmetros
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity
para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.
- pipelineOptions
- StoragePipelineOptions
Opcional. Opções.
Devoluções
Um novo objeto Pipeline.