@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 <xref:AccountSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção. |
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 <xref:AccountSASSignatureValues>. É possível construir a cadeia de caracteres de recursos sem essa classe, mas a ordem dos recursos é particular e essa classe garante a correção. |
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 <xref:AccountSASSignatureValues>. É possível construir a cadeia de caracteres de serviços sem essa classe, mas a ordem dos serviços é particular e essa classe garante a correção. |
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. |
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. |
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 gere arrendamentos para um <xref:ContainerClient> ou um <xref: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 <xref:BlobSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção. |
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 <xref:BlobSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção. |
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 <xref:newPipeline>. Ou você pode criar um Pipeline com suas próprias políticas pelo construtor de Pipeline. Consulte <xref:newPipeline> e políticas fornecidas antes de implementar seu pipeline personalizado. |
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; é gerado apenas pelos tipos <xref:AccountSASSignatureValues> e <xref:BlobSASSignatureValues>. Uma vez gerado, ele pode ser codificado em um <xref:String> 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. |
StorageClient |
Um StorageClient representa uma classe de URL baseada para <xref:BlobServiceClient>, <xref:ContainerClient> e etc. |
StorageClientContext | |
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 objetos <xref:StorageRetryPolicy>. |
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 no <xref: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 <xref:generateAccountSASQueryParameters> para obter uma representação do SAS que pode realmente ser aplicado a urls de blob. Nota: que tanto essa classe quanto <xref:SASQueryParameters> existem porque a primeira é mutável e uma representação lógica, enquanto a segunda é imutável e usada para gerar solicitações REST reais. |
AppendBlobAppendBlockFromURLOptions |
Opções para configurar a operação <xref:AppendBlobClient.appendBlockFromURL>. |
AppendBlobAppendBlockFromUrlHeaders |
Define cabeçalhos para AppendBlob_appendBlockFromUrl operação. |
AppendBlobAppendBlockHeaders |
Define cabeçalhos para AppendBlob_appendBlock operação. |
AppendBlobAppendBlockOptions |
Opções para configurar a operação <xref:AppendBlobClient.appendBlock>. |
AppendBlobCreateHeaders |
Define cabeçalhos para AppendBlob_create operação. |
AppendBlobCreateIfNotExistsOptions |
Opções para configurar <xref:AppendBlobClient.createIfNotExists> operação. |
AppendBlobCreateIfNotExistsResponse |
Contém dados de resposta para a operação <xref:appendBlobClient.createIfNotExists>. |
AppendBlobCreateOptions |
Opções para configurar <xref:AppendBlobClient.create> operação. |
AppendBlobRequestConditions |
Condições a serem adicionadas à criação deste blob de acréscimo. |
AppendBlobSealOptions |
Opções para configurar <xref:AppendBlobClient.seal> 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 a operação <xref:BlobClient.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 a operação <xref:BlobClient.beginCopyFromURL>. |
BlobBeginCopyFromURLResponse |
Contém dados de resposta para a operação <xref:BlobClient.beginCopyFromURL>. |
BlobBeginCopyFromUrlPollState |
O estado usado pelo poller voltou de <xref:BlobClient.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 a operação <xref:BlobClient.createSnapshot>. |
BlobDeleteHeaders |
Define cabeçalhos para Blob_delete operação. |
BlobDeleteIfExistsResponse |
Contém dados de resposta para a operação <xref:BlobClient.deleteIfExists>. |
BlobDeleteImmutabilityPolicyHeaders |
Define cabeçalhos para Blob_deleteImmutabilityPolicy operação. |
BlobDeleteImmutabilityPolicyOptions |
Opções para excluir a política de imutabilidade <xref:BlobClient.deleteImmutabilityPolicy> operação. |
BlobDeleteOptions |
Opções para configurar a operação <xref:BlobClient.delete>. |
BlobDownloadHeaders |
Define cabeçalhos para Blob_download operação. |
BlobDownloadOptionalParams |
Parâmetros opcionais. |
BlobDownloadOptions |
Opções para configurar a operação <xref:BlobClient.download>. |
BlobDownloadResponseParsed |
Contém dados de resposta para a operação <xref:BlobClient.download>. |
BlobDownloadToBufferOptions |
Interface de opção para a operação <xref:BlobClient.downloadToBuffer>. |
BlobExistsOptions |
Opções para configurar a operação <xref:BlobClient.exists>. |
BlobFlatListSegment |
Uma interface que representa BlobFlatListSegment. |
BlobFlatListSegmentModel | |
BlobGenerateSasUrlOptions |
Opções para configurar <xref:BlobClient.generateSasUrl> operação. |
BlobGetPropertiesHeaders |
Define cabeçalhos para Blob_getProperties operação. |
BlobGetPropertiesOptions |
Opções para configurar a operação <xref:BlobClient.getProperties>. |
BlobGetPropertiesResponse |
Contém dados de resposta para a operação <xref:BlobClient.getProperties>. |
BlobGetTagsHeaders |
Define cabeçalhos para Blob_getTags operação. |
BlobGetTagsOptions |
Opções para configurar a operação <xref:BlobClient.getTags>. |
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 <xref:BlockBlobQueryOptions.outputTextConfiguration>. |
BlobQueryArrowField |
Descreva um campo em <xref: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 <xref:BlockBlobQueryOptions.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 no <xref: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 a operação <xref:BlobClient.setHTTPHeaders>. |
BlobSetImmutabilityPolicyHeaders |
Define cabeçalhos para Blob_setImmutabilityPolicy operação. |
BlobSetImmutabilityPolicyOptions |
Opções para definir a política de imutabilidade <xref:BlobClient.setImmutabilityPolicy> operação. |
BlobSetLegalHoldHeaders |
Define cabeçalhos para Blob_setLegalHold operação. |
BlobSetLegalHoldOptions |
Opções para definir a retenção legal <xref:BlobClient.setLegalHold> operação. |
BlobSetMetadataHeaders |
Define cabeçalhos para Blob_setMetadata operação. |
BlobSetMetadataOptions |
Opções para configurar a operação <xref:BlobClient.setMetadata>. |
BlobSetTagsHeaders |
Define cabeçalhos para Blob_setTags operação. |
BlobSetTagsOptions |
Opções para configurar a operação <xref:BlobClient.setTags>. |
BlobSetTierHeaders |
Define cabeçalhos para Blob_setTier operação. |
BlobSetTierOptions |
Opções para configurar a operação <xref:BlobClient.setAccessTier>. |
BlobStartCopyFromURLHeaders |
Define cabeçalhos para Blob_startCopyFromURL operação. |
BlobStartCopyFromURLOptions |
Opções para configurar a operação <xref:BlobClient.beginCopyFromURL>. |
BlobSyncCopyFromURLOptions |
Opções para configurar a operação <xref:BlobClient.syncCopyFromURL>. |
BlobTag | |
BlobTags |
Tags de Blob |
BlobUndeleteHeaders |
Define cabeçalhos para Blob_undelete operação. |
BlobUndeleteOptions |
Opções para configurar a operação <xref:BlobClient.undelete>. |
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 <xref:BlockBlobClient.commitBlockList> operação. |
BlockBlobGetBlockListHeaders |
Define cabeçalhos para BlockBlob_getBlockList operação. |
BlockBlobGetBlockListOptions |
Opções para configurar <xref:BlockBlobClient.getBlockList> operação. |
BlockBlobParallelUploadOptions |
Interface de opção para <xref:BlockBlobClient.uploadFile> e <xref:BlockBlobClient.uploadSeekableStream>. |
BlockBlobPutBlobFromUrlHeaders |
Define cabeçalhos para BlockBlob_putBlobFromUrl operação. |
BlockBlobQueryOptions |
Opções para configurar <xref:BlockBlobClient.query> operação. |
BlockBlobStageBlockFromURLHeaders |
Define cabeçalhos para BlockBlob_stageBlockFromURL operação. |
BlockBlobStageBlockFromURLOptions |
Opções para configurar <xref:BlockBlobClient.stageBlockFromURL> operação. |
BlockBlobStageBlockHeaders |
Define cabeçalhos para BlockBlob_stageBlock operação. |
BlockBlobStageBlockOptions |
Opções para configurar <xref:BlockBlobClient.stageBlock> operação. |
BlockBlobSyncUploadFromURLOptions |
Opções para configurar <xref:BlockBlobClient.syncUploadFromURL> operação. |
BlockBlobUploadHeaders |
Define cabeçalhos para BlockBlob_upload operação. |
BlockBlobUploadOptions |
Opções para configurar <xref:BlockBlobClient.upload> operação. |
BlockBlobUploadStreamOptions |
Interface de opção para a operação <xref:BlockBlobClient.uploadStream>. |
BlockList | |
CommonGenerateSasUrlOptions |
Opções comuns de <xref:BlobGenerateSasUrlOptions> e <xref: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 a operação <xref:ContainerClient.createIfNotExists>. |
ContainerCreateOptions |
Opções para configurar <xref:ContainerClient.create> operação. |
ContainerDeleteBlobOptions |
Opções para configurar a operação <xref:ContainerClient.deleteBlob>. |
ContainerDeleteHeaders |
Define cabeçalhos para Container_delete operação. |
ContainerDeleteIfExistsResponse |
Contém dados de resposta para a operação <xref:ContainerClient.deleteIfExists>. |
ContainerDeleteMethodOptions |
Opções para configurar <xref:ContainerClient.delete> operação. |
ContainerEncryptionScope |
Grupo de parâmetros |
ContainerExistsOptions |
Opções para configurar <xref:ContainerClient.exists> operação. |
ContainerGenerateSasUrlOptions |
Opções para configurar <xref:ContainerClient.generateSasUrl> operação. |
ContainerGetAccessPolicyHeaders |
Define cabeçalhos para Container_getAccessPolicy operação. |
ContainerGetAccessPolicyOptions |
Opções para configurar <xref:ContainerClient.getAccessPolicy> operação. |
ContainerGetPropertiesHeaders |
Define cabeçalhos para Container_getProperties operação. |
ContainerGetPropertiesOptions |
Opções para configurar <xref:ContainerClient.getProperties> operação. |
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 no <xref:ContainerSASPermissions> para analisar permissões SAS de objetos brutos. |
ContainerSetAccessPolicyHeaders |
Define cabeçalhos para Container_setAccessPolicy operação. |
ContainerSetAccessPolicyOptions |
Opções para configurar <xref:ContainerClient.setAccessPolicy> operação. |
ContainerSetMetadataHeaders |
Define cabeçalhos para Container_setMetadata operação. |
ContainerSetMetadataOptions |
Opções para configurar <xref:ContainerClient.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 <xref:BlobServiceClient.findBlobsByTags> |
FilterBlobItemModel |
Informações de Blob de uma chamada da API de Blobs de Filtro |
FilterBlobSegment |
Resposta do segmento de <xref:BlobServiceClient.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. |
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 <xref: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 <xref:ObjectReplicationStatus> de um blob. Pode haver mais de um <xref:ObjectReplicationRule> sob um <xref:ObjectReplicationPolicy>. |
PageBlobClearPagesHeaders |
Define cabeçalhos para PageBlob_clearPages operação. |
PageBlobClearPagesOptions |
Opções para configurar a operação <xref:PageBlobClient.clearPages>. |
PageBlobCopyIncrementalHeaders |
Define cabeçalhos para PageBlob_copyIncremental operação. |
PageBlobCreateHeaders |
Define cabeçalhos para PageBlob_create operação. |
PageBlobCreateIfNotExistsOptions |
Opções para configurar a operação <xref:PageBlobClient.createIfNotExists>. |
PageBlobCreateIfNotExistsResponse |
Contém dados de resposta para a operação <xref:PageBlobClient.createIfNotExists>. |
PageBlobCreateOptions |
Opções para configurar a operação <xref:PageBlobClient.create>. |
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 <xref:BlobClient.getPageRangesDiff>. |
PageBlobGetPageRangesHeaders |
Define cabeçalhos para PageBlob_getPageRanges operação. |
PageBlobGetPageRangesOptions |
Opções para configurar a operação <xref:PageBlobClient.getPageRanges>. |
PageBlobGetPageRangesResponse |
Contém dados de resposta para a operação <xref:BlobClient.getPageRanges>. |
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 <xref:PageBlobClient.resize> operação. |
PageBlobStartCopyIncrementalOptions |
Opções para configurar <xref:PageBlobClient.startCopyIncremental> operação. |
PageBlobUpdateSequenceNumberHeaders |
Define cabeçalhos para PageBlob_updateSequenceNumber operação. |
PageBlobUpdateSequenceNumberOptions |
Opções para configurar <xref:PageBlobClient.updateSequenceNumber> operação. |
PageBlobUploadPagesFromURLHeaders |
Define cabeçalhos para PageBlob_uploadPagesFromURL operação. |
PageBlobUploadPagesFromURLOptions |
Opções para configurar <xref:PageBlobClient.uploadPagesFromURL> operação. |
PageBlobUploadPagesHeaders |
Define cabeçalhos para PageBlob_uploadPages operação. |
PageBlobUploadPagesOptions |
Opções para configurar a operação <xref:PageBlobClient.uploadPages>. |
PageList |
Lista de intervalos de páginas para um blob. |
ParsedBatchResponse |
A resposta com várias partes/mista que contém a resposta para cada subsolicitação. |
PipelineLike |
Uma interface para a classe <xref:Pipeline> que contém diretivas de solicitação HTTP. Você pode criar um Pipeline padrão chamando <xref:newPipeline>. Ou você pode criar um Pipeline com suas próprias políticas pelo construtor de Pipeline. Consulte <xref:newPipeline> e políticas fornecidas antes de implementar seu pipeline personalizado. |
PipelineOptions |
Interface de opção para o construtor Pipeline. |
Range |
Intervalo para operações de serviço de Blob. |
RetentionPolicy |
a política de retenção que determina por quanto tempo os dados associados devem persistir |
SASQueryParametersOptions |
Opções para construir <xref:SASQueryParameters>. |
SasIPRange |
Intervalo de IP permitido para uma SAS. |
SequenceNumberAccessConditions |
Grupo de parâmetros |
ServiceFilterBlobsHeaders |
Define cabeçalhos para Service_filterBlobs operação. |
ServiceFindBlobByTagsOptions |
Opções para configurar a operação <xref:BlobServiceClient.findBlobsByTags>. |
ServiceGenerateAccountSasUrlOptions |
Opções para configurar <xref:BlobServiceClient.generateAccountSasUrl> operação. |
ServiceGetAccountInfoHeaders |
Define cabeçalhos para Service_getAccountInfo operação. |
ServiceGetAccountInfoOptions |
Opções para configurar a operação <xref:BlobServiceClient.getAccountInfo>. |
ServiceGetPropertiesHeaders |
Define cabeçalhos para Service_getProperties operação. |
ServiceGetPropertiesOptions |
Opções para configurar a operação <xref:BlobServiceClient.getProperties>. |
ServiceGetStatisticsHeaders |
Define cabeçalhos para Service_getStatistics operação. |
ServiceGetStatisticsOptions |
Opções para configurar a operação <xref:BlobServiceClient.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 a operação <xref:BlobServiceClient.listContainers>. |
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 a operação <xref:BlobServiceClient.setProperties>. |
ServiceSubmitBatchHeaders |
Define cabeçalhos para Service_submitBatch operação. |
ServiceSubmitBatchOptionalParamsModel |
Parâmetros opcionais. |
ServiceUndeleteContainerOptions |
Opções para configurar <xref:BlobServiceClient.undeleteContainer> operação. |
SignedIdentifier |
Identificador assinado. |
SignedIdentifierModel |
identificador assinado |
StaticWebsite |
As propriedades que permitem que uma conta hospede um site estático |
StorageClientOptionalParams |
Parâmetros opcionais. |
StoragePipelineOptions |
Interface de opções para a função <xref:newPipeline>. |
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 |
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 <xref:deleteBlobs>. |
BlobBatchSetBlobsAccessTierResponse |
Contém dados de resposta para a operação <xref:setBlobsAccessTier>. |
BlobBatchSubmitBatchResponse |
Contém dados de resposta para operações de lote de blob. |
BlobCopyFromURLResponse |
Contém dados de resposta para a operação copyFromURL. |
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. |
BlobDownloadResponseModel |
Contém dados de resposta para a operação de download. |
BlobGetPropertiesResponseModel |
Contém dados de resposta para a operação getProperties. |
BlobGetTagsResponse |
Contém dados de resposta para a operação <xref:BlobClient.getTags>. |
BlobImmutabilityPolicyMode |
Define valores para BlobImmutabilityPolicyMode. |
BlobQueryArrowFieldType |
O tipo de <xref:BlobQueryArrowField>. |
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 <xref:BlockBlobClient.uploadFile>, <xref:BlockBlobClient.uploadStream>e <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. |
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. |
ContainerGetAccessPolicyResponse |
Contém dados de resposta para a operação <xref:ContainerClient.getAccessPolicy>. |
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 a partir de um <xref:BlobClient> que são necessárias para que o polidor retornado por <xref:BlobClient.beginCopyFromURL> funcione. |
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. |
GeoReplicationStatusType |
Define valores para GeoReplicationStatusType. |
LeaseDurationType |
Define valores para LeaseDurationType. |
LeaseOperationResponse |
Contém os dados de resposta para operações que criam, modificam ou excluem uma concessão. Ver <xref:BlobLeaseClient>. |
LeaseStateType |
Define valores para LeaseStateType. |
LeaseStatusType |
Define valores para LeaseStatusType. |
ListBlobsIncludeItem |
Define valores para ListBlobsIncludeItem. |
ListContainersIncludeType |
Define valores para ListContainersIncludeType. |
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. Ver <xref:ObjectReplicationPolicy> e <xref: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. |
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 <xref:BlobServiceClient.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. |
ServiceGetStatisticsResponse |
Contém dados de resposta para a operação getStatistics. |
ServiceGetUserDelegationKeyResponse |
Contém dados de resposta para a operação <xref:getUserDelegationKey>. |
ServiceListContainersSegmentResponse |
Contém dados de resposta para a operação listContainersSegment. |
ServiceSetPropertiesResponse |
Contém dados de resposta para a operação setProperties. |
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. |
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. |
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. |
StorageRetryPolicyType |
Tipos RetryPolicy. |
Funções
generate |
DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Gera um objeto <xref:SASQueryParameters> que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real. |
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:
|
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 <xref:SASQueryParameters> que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
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), // 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), // 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), // 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)
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)
Parâmetros
- blobSASSignatureValues
- BlobSASSignatureValues
- userDelegationKey
- UserDelegationKey
Valor de retorno de blobServiceClient.getUserDelegationKey()
- accountName
-
string
Devoluções
isPipelineLike(unknown)
Um auxiliar para decidir se um determinado argumento satisfaz o contrato de Pipeline
function isPipelineLike(pipeline: unknown)
Parâmetros
- pipeline
-
unknown
Um argumento que pode ser um Pipeline
Devoluções
boolean
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)
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.
Azure SDK for JavaScript