Partilhar via


@azure/storage-blob package

Classes

AccountSASPermissions

APENAS DISPONÍVEL NO NODE.JS RUNTIME. Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de permissões num <xref:AccountSASSignatureValues> objeto. É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.

AccountSASResourceTypes

APENAS DISPONÍVEL NO NODE.JS RUNTIME. Esta é uma classe auxiliar para construir uma cadeia que representa os recursos acessíveis por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá acesso a esse tipo de recurso. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de recursos num <xref:AccountSASSignatureValues> objeto. É possível construir a cadeia de recursos sem esta classe, mas a ordem dos recursos é particular e esta classe garante a correção.

AccountSASServices

APENAS DISPONÍVEL NO NODE.JS RUNTIME. Esta é uma classe auxiliar para construir uma cadeia que representa os serviços acessíveis por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá acesso a esse serviço. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de serviços num <xref:AccountSASSignatureValues> objeto. É possível construir a cadeia de serviços sem esta classe, mas a ordem dos serviços é particular e esta classe garante a correção.

AnonymousCredential

AnonymousCredential fornece um membro credentialPolicyCreator utilizado para criar objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy é utilizado com pedidos HTTP(S) que leem recursos públicos ou para utilização com Assinaturas de Acesso Partilhado (SAS).

AnonymousCredentialPolicy

AnonymousCredentialPolicy é utilizado com pedidos HTTP(S) que leem recursos públicos ou para utilização com Assinaturas de Acesso Partilhado (SAS).

AppendBlobClient

AppendBlobClient define um conjunto de operações aplicáveis aos blobs de acréscimo.

BlobBatch

Um BlobBatch representa um conjunto agregado de operações em blobs. Atualmente, apenas delete e setAccessTier são suportados.

BlobBatchClient

Um BlobBatchClient permite-lhe fazer pedidos em lote para o serviço Blob de Armazenamento do Azure.

BlobClient

Um BlobClient representa um URL para um blob de Armazenamento do Azure; o blob pode ser um blob de blocos, blob de acréscimo ou blob de páginas.

BlobLeaseClient

Um cliente que gere as concessões de um <xref:ContainerClient> ou um <xref:BlobClient>.

BlobSASPermissions

DISPONÍVEL APENAS NO NODE.JS RUNTIME. Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por um ServiceSAS a um blob. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este deve ser serializado com toString e definido como o campo de permissões num <xref:BlobSASSignatureValues> objeto. É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.

BlobServiceClient

Um BlobServiceClient representa um Cliente para o serviço Blob de Armazenamento do Azure que lhe permite manipular contentores de blobs.

BlockBlobClient

BlockBlobClient define um conjunto de operações aplicáveis a blobs de blocos.

ContainerClient

Um ContainerClient representa um URL para o contentor do Armazenamento do Azure que lhe permite manipular os blobs.

ContainerSASPermissions

Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por um ServiceSAS a um contentor. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de permissões num <xref:BlobSASSignatureValues> objeto. É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.

Credential

A credencial é uma classe abstrata para a assinatura de pedidos HTTP do Armazenamento do Microsoft Azure. Esta classe irá alojar uma fábrica credentialPolicyCreator que gera CredentialPolicy.

CredentialPolicy

Política de credenciais utilizada para assinar pedidos HTTP(S) antes de enviar. Esta é uma classe abstrata.

PageBlobClient

PageBlobClient define um conjunto de operações aplicáveis aos blobs de páginas.

Pipeline

Uma classe pipeline que contém políticas de pedido HTTP. Pode criar um Pipeline predefinido ao chamar <xref:newPipeline>. Em alternativa, pode criar um Pipeline com as suas próprias políticas pelo construtor do Pipeline. <xref:newPipeline> Veja as políticas fornecidas e efetuadas antes de implementar o Pipeline personalizado.

SASQueryParameters

Representa os componentes que constituem os parâmetros de consulta da SAS do Armazenamento do Azure. Este tipo não é construído diretamente pelo utilizador; só é gerado pelos <xref:AccountSASSignatureValues> tipos e <xref:BlobSASSignatureValues> . Uma vez gerado, pode ser codificado num <xref:String> URL e anexado diretamente a um URL (embora deva ter cuidado aqui no caso de existirem parâmetros de consulta, o que pode afetar os meios adequados de anexar estes parâmetros de consulta). NOTA: as instâncias desta classe são imutáveis.

StorageBrowserPolicy

StorageBrowserPolicy processará as diferenças entre Node.js e o runtime do browser, incluindo:

  1. Os browsers colocam em cache pedidos GET/HEAD ao adicionar cabeçalhos condicionais, como "IF_MODIFIED_SINCE". StorageBrowserPolicy é uma política utilizada para adicionar uma consulta de carimbo de data/hora ao URL do pedido GET/HEAD, evitando assim a cache do browser.

  2. Remover cabeçalho de cookie para segurança

  3. Remover o cabeçalho de comprimento do conteúdo para evitar avisos de browsers

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> etc.

StorageClientContext
StorageRetryPolicy

Repita a política com repetição exponencial e repetição linear implementada.

StorageRetryPolicyFactory

StorageRetryPolicyFactory é uma classe de fábrica que ajuda a <xref:StorageRetryPolicy> gerar objetos.

StorageSharedKeyCredential

DISPONÍVEL APENAS NO NODE.JS RUNTIME. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy é uma política utilizada para assinar o pedido HTTP com uma chave partilhada.

Interfaces

AccessPolicy

Uma política de Acesso

AccountSASPermissionsLike

Um tipo que se parece com uma permissão SAS de conta. Utilizado para <xref:AccountSASPermissions> analisar permissões SAS de objetos não processados.

AccountSASSignatureValues

APENAS DISPONÍVEL NO NODE.JS RUNTIME. AccountSASSignatureValues é utilizado para gerar uma Assinatura de Acesso Partilhado (SAS) para uma conta de Armazenamento do Azure. Assim que todos os valores aqui estiverem definidos adequadamente, chame <xref:generateAccountSASQueryParameters> para obter uma representação da SAS que pode ser aplicada aos urls de blob. Nota: esta classe e <xref:SASQueryParameters> existem porque a primeira é mutável e uma representação lógica enquanto esta é imutável e utilizada para gerar pedidos REST reais.

AppendBlobAppendBlockFromURLOptions

Opções para configurar a <xref:AppendBlobClient.appendBlockFromURL> operação.

AppendBlobAppendBlockFromUrlHeaders

Define cabeçalhos para AppendBlob_appendBlockFromUrl operação.

AppendBlobAppendBlockHeaders

Define cabeçalhos para AppendBlob_appendBlock operação.

AppendBlobAppendBlockOptions

Opções para configurar a <xref:AppendBlobClient.appendBlock> operação.

AppendBlobCreateHeaders

Define cabeçalhos para AppendBlob_create operação.

AppendBlobCreateIfNotExistsOptions

Opções para configurar <xref:AppendBlobClient.createIfNotExists> a operação.

AppendBlobCreateIfNotExistsResponse

Contém dados de resposta para a <xref:appendBlobClient.createIfNotExists> operação.

AppendBlobCreateOptions

Opções para configurar <xref:AppendBlobClient.create> a operação.

AppendBlobRequestConditions

Condições a adicionar à criação deste blob de acréscimo.

AppendBlobSealOptions

Opções para configurar <xref:AppendBlobClient.seal> a operação.

AppendPositionAccessConditions

Grupo de parâmetros

BatchSubRequest

Um pedido associado a uma operação de lote.

BatchSubResponse

Os dados de resposta associados a um único pedido numa operação de lote.

BlobAbortCopyFromURLHeaders

Define cabeçalhos para Blob_abortCopyFromURL operação.

BlobAbortCopyFromURLOptions

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

BlobAcquireLeaseOptions

Opções para configurar a operação Blob – Adquirir Concessão.

BlobBatchSubmitBatchOptionalParams

Opções para configurar o Serviço – Submeter Parâmetros Opcionais do Batch.

BlobBeginCopyFromURLOptions

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

BlobBeginCopyFromURLResponse

Contém dados de resposta para a <xref:BlobClient.beginCopyFromURL> operação.

BlobBeginCopyFromUrlPollState

O estado utilizado pelo poller devolvido de <xref:BlobClient.beginCopyFromURL>. Este estado é transmitido para a chamada de retorno especificada pelo onProgress utilizador sempre que for detetado o progresso da cópia.

BlobBreakLeaseOptions

Opções para configurar a operação Blob – Interromper Concessão.

BlobChangeLeaseOptions

Opções para configurar a operação Blob – Alterar Concessão.

BlobCopyFromURLHeaders

Define cabeçalhos para Blob_copyFromURL operação.

BlobCreateSnapshotHeaders

Define cabeçalhos para Blob_createSnapshot operação.

BlobCreateSnapshotOptions

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

BlobDeleteHeaders

Define cabeçalhos para Blob_delete operação.

BlobDeleteIfExistsResponse

Contém dados de resposta para a <xref:BlobClient.deleteIfExists> operação.

BlobDeleteImmutabilityPolicyHeaders

Define cabeçalhos para Blob_deleteImmutabilityPolicy operação.

BlobDeleteImmutabilityPolicyOptions

Opções para eliminar a operação de política <xref:BlobClient.deleteImmutabilityPolicy> de imutabilidade.

BlobDeleteOptions

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

BlobDownloadHeaders

Define cabeçalhos para Blob_download operação.

BlobDownloadOptionalParams

Parâmetros opcionais.

BlobDownloadOptions

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

BlobDownloadResponseParsed

Contém dados de resposta para a <xref:BlobClient.download> operação.

BlobDownloadToBufferOptions

Interface de opção para a <xref:BlobClient.downloadToBuffer> operação.

BlobExistsOptions

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

BlobFlatListSegment

Uma interface que representa BlobFlatListSegment.

BlobFlatListSegmentModel
BlobGenerateSasUrlOptions

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

BlobGetPropertiesHeaders

Define cabeçalhos para Blob_getProperties operação.

BlobGetPropertiesOptions

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

BlobGetPropertiesResponse

Contém dados de resposta para a <xref:BlobClient.getProperties> operação.

BlobGetTagsHeaders

Define cabeçalhos para Blob_getTags operação.

BlobGetTagsOptions

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

BlobHTTPHeaders

Grupo de parâmetros

BlobHierarchyListSegment

Uma interface que representa BlobHierarchyListSegment.

BlobHierarchyListSegmentModel
BlobImmutabilityPolicy

Descreva uma política imutável para blob.

BlobItem

Um blob do Armazenamento do Azure

BlobItemInternal

Um blob do Armazenamento do Azure

BlobPrefix
BlobProperties

Propriedades de um blob

BlobQueryArrowConfiguration

Opções para consultar o blob com o formato de Seta para Apache. Apenas válido para <xref:BlockBlobQueryOptions.outputTextConfiguration>.

BlobQueryArrowField

Descrever um campo em <xref:BlobQueryArrowConfiguration>.

BlobQueryCsvTextConfiguration

Opções para consultar o blob com o formato CSV.

BlobQueryError

Tipo de erro de consulta de blobs.

BlobQueryHeaders

Define cabeçalhos para Blob_query operação.

BlobQueryJsonTextConfiguration

Opções para consultar o blob com o formato JSON.

BlobQueryParquetConfiguration

Opções para consultar o blob com o formato Parquet. Apenas válido para <xref:BlockBlobQueryOptions.inputTextConfiguration>.

BlobReleaseLeaseOptions

Opções para configurar a operação Blob – Concessão de Versão.

BlobRenewLeaseOptions

Opções para configurar a operação Blob – Renovar Concessão.

BlobRequestConditions

cabeçalhos condicionais HTTP padrão, condição de etiquetas e condição de concessão

BlobSASPermissionsLike

Um tipo que se assemelha a uma permissão SAS de Blob. Utilizado no <xref:BlobSASPermissions> para analisar permissões SAS de objetos não processados.

BlobSASSignatureValues

DISPONÍVEL APENAS NO NODE.JS RUNTIME. BlobSASSignatureValues é utilizado para ajudar a gerar tokens SAS do serviço Blob para contentores ou blobs.

BlobServiceProperties

Propriedades do Serviço de Armazenamento.

BlobServiceStatistics

Estatísticas do serviço de armazenamento.

BlobSetHTTPHeadersHeaders

Define cabeçalhos para Blob_setHttpHeaders operação.

BlobSetHTTPHeadersOptions

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

BlobSetImmutabilityPolicyHeaders

Define cabeçalhos para Blob_setImmutabilityPolicy operação.

BlobSetImmutabilityPolicyOptions

Opções para definir a operação de política <xref:BlobClient.setImmutabilityPolicy> de imutabilidade.

BlobSetLegalHoldHeaders

Define cabeçalhos para Blob_setLegalHold operação.

BlobSetLegalHoldOptions

Opções para definir a operação de retenção <xref:BlobClient.setLegalHold> legal.

BlobSetMetadataHeaders

Define cabeçalhos para Blob_setMetadata operação.

BlobSetMetadataOptions

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

BlobSetTagsHeaders

Define cabeçalhos para Blob_setTags operação.

BlobSetTagsOptions

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

BlobSetTierHeaders

Define cabeçalhos para Blob_setTier operação.

BlobSetTierOptions

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

BlobStartCopyFromURLHeaders

Define cabeçalhos para Blob_startCopyFromURL operação.

BlobStartCopyFromURLOptions

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

BlobSyncCopyFromURLOptions

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

BlobTag
BlobTags

Etiquetas de blobs

BlobUndeleteHeaders

Define cabeçalhos para Blob_undelete operação.

BlobUndeleteOptions

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

Block

Representa um único bloco num blob de blocos. 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> a operação.

BlockBlobGetBlockListHeaders

Define cabeçalhos para BlockBlob_getBlockList operação.

BlockBlobGetBlockListOptions

Opções para configurar <xref:BlockBlobClient.getBlockList> a 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> a operação.

BlockBlobStageBlockFromURLHeaders

Define cabeçalhos para BlockBlob_stageBlockFromURL operação.

BlockBlobStageBlockFromURLOptions

Opções para configurar <xref:BlockBlobClient.stageBlockFromURL> a operação.

BlockBlobStageBlockHeaders

Define cabeçalhos para BlockBlob_stageBlock operação.

BlockBlobStageBlockOptions

Opções para configurar <xref:BlockBlobClient.stageBlock> a operação.

BlockBlobSyncUploadFromURLOptions

Opções para configurar <xref:BlockBlobClient.syncUploadFromURL> a operação.

BlockBlobUploadHeaders

Define cabeçalhos para BlockBlob_upload operação.

BlockBlobUploadOptions

Opções para configurar <xref:BlockBlobClient.upload> a operação.

BlockBlobUploadStreamOptions

Interface de opção para a <xref:BlockBlobClient.uploadStream> operação.

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 Contentor – Adquirir Concessão.

ContainerBreakLeaseOptionalParams

Parâmetros opcionais.

ContainerBreakLeaseOptions

Opções para configurar a operação Contentor – Interromper Concessão.

ContainerChangeLeaseOptions

Opções para configurar a operação Contentor – Alterar Concessão.

ContainerCreateHeaders

Define cabeçalhos para Container_create operação.

ContainerCreateIfNotExistsResponse

Contém dados de resposta para a <xref:ContainerClient.createIfNotExists> operação.

ContainerCreateOptions

Opções para configurar <xref:ContainerClient.create> a operação.

ContainerDeleteBlobOptions

Opções para configurar a <xref:ContainerClient.deleteBlob> operação.

ContainerDeleteHeaders

Define cabeçalhos para Container_delete operação.

ContainerDeleteIfExistsResponse

Contém dados de resposta para a <xref:ContainerClient.deleteIfExists> operação.

ContainerDeleteMethodOptions

Opções para configurar <xref:ContainerClient.delete> a operação.

ContainerEncryptionScope

Grupo de parâmetros

ContainerExistsOptions

Opções para configurar <xref:ContainerClient.exists> a operação.

ContainerGenerateSasUrlOptions

Opções para configurar <xref:ContainerClient.generateSasUrl> a operação.

ContainerGetAccessPolicyHeaders

Define cabeçalhos para Container_getAccessPolicy operação.

ContainerGetAccessPolicyOptions

Opções para configurar <xref:ContainerClient.getAccessPolicy> a operação.

ContainerGetPropertiesHeaders

Define cabeçalhos para Container_getProperties operação.

ContainerGetPropertiesOptions

Opções para configurar <xref:ContainerClient.getProperties> a operação.

ContainerItem

Um contentor do 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 as operações Contentor - Listar Blobs. Veja:

  • <xref:ContainerClient.listBlobsFlat>
  • <xref:ContainerClient.listBlobsByHierarchy>
ContainerProperties

Propriedades de um contentor

ContainerReleaseLeaseOptions

Opções para configurar a operação Contentor – Concessão de Versão.

ContainerRenameHeaders

Define cabeçalhos para Container_rename operação.

ContainerRenewLeaseOptions

Opções para configurar a operação Contentor – Renovar Concessão.

ContainerRequestConditions

Condições a cumprir para o contentor.

ContainerSASPermissionsLike

Um tipo semelhante a uma permissão SAS de Contentor. Utilizado para <xref:ContainerSASPermissions> analisar permissões SAS de objetos não processados.

ContainerSetAccessPolicyHeaders

Define cabeçalhos para Container_setAccessPolicy operação.

ContainerSetAccessPolicyOptions

Opções para configurar <xref:ContainerClient.setAccessPolicy> a operação.

ContainerSetMetadataHeaders

Define cabeçalhos para Container_setMetadata operação.

ContainerSetMetadataOptions

Opções para configurar <xref:ContainerClient.setMetadata> a operação.

ContainerUndeleteHeaders

Define cabeçalhos para Container_restore operação.

CorsRule

O CORS é uma funcionalidade HTTP que permite a execução de uma aplicação Web num domínio para aceder a recursos noutro domínio. Os browsers implementam uma restrição de segurança conhecida como política de origem idêntica que impede uma página Web de chamar APIs num domínio diferente; O CORS fornece uma forma segura de permitir que um domínio (o domínio de origem) chame APIs noutro domínio

CpkInfo

Grupo de parâmetros

FilterBlobItem

Informações de blobs de um <xref:BlobServiceClient.findBlobsByTags>

FilterBlobItemModel

Informações de blobs de uma chamada à API de Blobs de Filtro

FilterBlobSegment

Resposta de segmento da <xref:BlobServiceClient.findBlobsByTags> operação.

FilterBlobSegmentModel

O resultado de uma chamada à API de Blobs de Filtro

GeoReplication

Geo-Replication informações do Serviço de Armazenamento Secundário

HttpAuthorization

Representa informações de autenticação nos valores de cabeçalho Authorization, ProxyAuthorization, WWW-Authenticate e Proxy-Authenticate.

Lease

Os detalhes de uma concessão específica.

LeaseAccessConditions

Grupo de parâmetros

LeaseOperationOptions

Configura operações de concessã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 contentores

Logging

Definições do Registo do Azure Analytics.

MatchConditions

Especifica opções HTTP para pedidos condicionais com base na correspondência de ETag.

Metadata

Um mapa de pares nome-valor para associar ao recurso.

Metrics

um resumo das estatísticas de pedido agrupadas pela API em agregações de hora ou minuto para blobs

ModificationConditions

Especifica opções HTTP para pedidos condicionais com base no tempo de modificação.

ModifiedAccessConditions

condição de cabeçalhos condicionais e etiquetas HTTP padrão.

ModifiedAccessConditionsModel

Grupo de parâmetros

ObjectReplicationPolicy

Contém o ID da Política de Replicação de Objetos e a respetiva lista de <xref:ObjectReplicationRule>. Isto é utilizado ao obter as Propriedades de Replicação de Objetos no blob de origem. O ID da política para o blob de destino está definido em ObjectReplicationDestinationPolicyId das respetivas respostas do método (por exemplo, <xref:BlobProperties.ObjectReplicationDestinationPolicyId>.

ObjectReplicationRule

Contém o ID da Regra de Replicação de Objetos e <xref:ObjectReplicationStatus> de um blob. Pode haver mais do que um <xref:ObjectReplicationRule> abaixo de um <xref:ObjectReplicationPolicy>.

PageBlobClearPagesHeaders

Define cabeçalhos para PageBlob_clearPages operação.

PageBlobClearPagesOptions

Opções para configurar a <xref:PageBlobClient.clearPages> operação.

PageBlobCopyIncrementalHeaders

Define cabeçalhos para PageBlob_copyIncremental operação.

PageBlobCreateHeaders

Define cabeçalhos para PageBlob_create operação.

PageBlobCreateIfNotExistsOptions

Opções para configurar a <xref:PageBlobClient.createIfNotExists> operação.

PageBlobCreateIfNotExistsResponse

Contém dados de resposta para a <xref:PageBlobClient.createIfNotExists> operação.

PageBlobCreateOptions

Opções para configurar a <xref:PageBlobClient.create> operação.

PageBlobGetPageRangesDiffHeaders

Define cabeçalhos para PageBlob_getPageRangesDiff operação.

PageBlobGetPageRangesDiffOptions

Opções para configurar a <xref:PageBlobClient.getRangesDiff> operação.

PageBlobGetPageRangesDiffResponse

Contém dados de resposta para a <xref:BlobClient.getPageRangesDiff> operação.

PageBlobGetPageRangesHeaders

Define cabeçalhos para PageBlob_getPageRanges operação.

PageBlobGetPageRangesOptions

Opções para configurar a <xref:PageBlobClient.getPageRanges> operação.

PageBlobGetPageRangesResponse

Contém dados de resposta para a <xref:BlobClient.getPageRanges> operação.

PageBlobRequestConditions

Condições a 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> a operação.

PageBlobStartCopyIncrementalOptions

Opções para configurar <xref:PageBlobClient.startCopyIncremental> a operação.

PageBlobUpdateSequenceNumberHeaders

Define cabeçalhos para PageBlob_updateSequenceNumber operação.

PageBlobUpdateSequenceNumberOptions

Opções para configurar <xref:PageBlobClient.updateSequenceNumber> a operação.

PageBlobUploadPagesFromURLHeaders

Define cabeçalhos para PageBlob_uploadPagesFromURL operação.

PageBlobUploadPagesFromURLOptions

Opções para configurar <xref:PageBlobClient.uploadPagesFromURL> a operação.

PageBlobUploadPagesHeaders

Define cabeçalhos para PageBlob_uploadPages operação.

PageBlobUploadPagesOptions

Opções para configurar a <xref:PageBlobClient.uploadPages> operação.

PageList

Lista de intervalos de páginas para um blob.

ParsedBatchResponse

A resposta multipart/mista que contém a resposta para cada sub-requisito.

PipelineLike

Uma interface para a <xref:Pipeline> classe que contém políticas de pedido HTTP. Pode criar um Pipeline predefinido ao chamar <xref:newPipeline>. Em alternativa, pode criar um Pipeline com as suas próprias políticas pelo construtor do Pipeline. <xref:newPipeline> Veja as políticas fornecidas e efetuadas antes de implementar o Pipeline personalizado.

PipelineOptions

Interface de opção do construtor de pipelines.

Range

Intervalo para Operações do Serviço blob.

RetentionPolicy

a política de retenção que determina 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 <xref:BlobServiceClient.findBlobsByTags> operação.

ServiceGenerateAccountSasUrlOptions

Opções para configurar <xref:BlobServiceClient.generateAccountSasUrl> a operação.

ServiceGetAccountInfoHeaders

Define cabeçalhos para Service_getAccountInfo operação.

ServiceGetAccountInfoOptions

Opções para configurar a <xref:BlobServiceClient.getAccountInfo> operação.

ServiceGetPropertiesHeaders

Define cabeçalhos para Service_getProperties operação.

ServiceGetPropertiesOptions

Opções para configurar a <xref:BlobServiceClient.getProperties> operação.

ServiceGetStatisticsHeaders

Define cabeçalhos para Service_getStatistics operação.

ServiceGetStatisticsOptions

Opções para configurar a <xref:BlobServiceClient.getStatistics> operação.

ServiceGetUserDelegationKeyHeaders

Define cabeçalhos para Service_getUserDelegationKey operação.

ServiceGetUserDelegationKeyOptions

Opções para configurar o Serviço – Obter Chave de Delegação de Utilizador.

ServiceListContainersOptions

Opções para configurar a <xref:BlobServiceClient.listContainers> operação.

ServiceListContainersSegmentHeaders

Define cabeçalhos para Service_listContainersSegment operação.

ServiceRenameContainerOptions

Opções para configurar <xref:BlobServiceClient.renameContainer> a operação.

ServiceSetPropertiesHeaders

Define cabeçalhos para Service_setProperties operação.

ServiceSetPropertiesOptions

Opções para configurar a <xref:BlobServiceClient.setProperties> operação.

ServiceSubmitBatchHeaders

Define cabeçalhos para Service_submitBatch operação.

ServiceSubmitBatchOptionalParamsModel

Parâmetros opcionais.

ServiceUndeleteContainerOptions

Opções para configurar <xref:BlobServiceClient.undeleteContainer> a operação.

SignedIdentifier

Identificador assinado.

SignedIdentifierModel

identificador assinado

StaticWebsite

As propriedades que permitem que uma conta aloje um site estático

StorageClientOptionalParams

Parâmetros opcionais.

StoragePipelineOptions

Interface de opções para a <xref:newPipeline> função.

StorageRetryOptions

Interface de opções de repetição do Blob de Armazenamento.

TagConditions

Especifica opções HTTP para pedidos condicionais com base em etiquetas de blobs.

UserDelegationKey

Uma chave de delegação de utilizador.

UserDelegationKeyModel

Uma chave de delegação de utilizador

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 de criação.

ArchiveStatus

Define valores para ArchiveStatus.

BlobAbortCopyFromURLResponse

Contém dados de resposta para a operação abortCopyFromURL.

BlobBatchDeleteBlobsResponse

Contém dados de resposta para a <xref:deleteBlobs> operação.

BlobBatchSetBlobsAccessTierResponse

Contém dados de resposta para a <xref:setBlobsAccessTier> operação.

BlobBatchSubmitBatchResponse

Contém dados de resposta para operações de lote de blobs.

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 eliminação.

BlobDownloadResponseModel

Contém dados de resposta para a operação de transferência.

BlobGetPropertiesResponseModel

Contém dados de resposta para a operação getProperties.

BlobGetTagsResponse

Contém dados de resposta para a <xref:BlobClient.getTags> operação.

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 anulação de eliminação.

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 de criação.

ContainerDeleteResponse

Contém dados de resposta para a operação de eliminação.

ContainerGetAccessPolicyResponse

Contém dados de resposta para a <xref:ContainerClient.getAccessPolicy> operação.

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 mudança de nome.

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 restauro.

CopyPollerBlobClient

Define as operações de uma <xref:BlobClient> que são necessárias para que o poller devolvido por <xref:BlobClient.beginCopyFromURL> funcione.

CopyStatusType

Define valores para CopyStatusType.

CredentialPolicyCreator

Uma função de fábrica que cria uma nova CredentialPolicy que utiliza 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 eliminam uma concessão. Consulte <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 Estado de Replicação de um blob. Isto é utilizado quando uma conta de armazenamento tem Políticas de Replicação de Objetos aplicadas. Veja <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 de criação.

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 da <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 <xref:getUserDelegationKey> operação.

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

Etiquetas de blobs.

Enumerações

BlockBlobTier

Representa a camada de acesso num blob. Para obter informações detalhadas sobre as camadas ao nível do blob de blocos, veja Camadas de armazenamento frequente, esporádico e de arquivo.

PremiumPageBlobTier

Especifica a camada de blobs de páginas para definir o blob como. Isto só é aplicável a blobs de páginas em contas de armazenamento premium. Consulte aqui para obter informações detalhadas sobre o IOPS e o débito correspondentes por PageBlobTier.

SASProtocol

Protocolos para SAS gerados.

StorageRetryPolicyType

Tipos de RetryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO NODE.JS RUNTIME. Gera um <xref:SASQueryParameters> objeto que contém todos os parâmetros de consulta SAS necessários para fazer um pedido REST real.

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO NODE.JS RUNTIME. Cria uma instância de SASQueryParameters.

Apenas aceita as definições necessárias para criar uma SAS. Para definições opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador.

AVISO: quando o identificador não é fornecido, são necessárias permissões e expiresOn. Tem de atribuir o valor ao identificador ou expiraDo & permissões manualmente se inicialmente com este construtor.

Preencha os detalhes necessários antes de executar os seguintes fragmentos.

Utilização de exemplo:

// 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 com 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 com 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();
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

DISPONÍVEL APENAS NO NODE.JS RUNTIME. Cria uma instância de SASQueryParameters. AVISO: o identificador será ignorado ao gerar SAS de delegação de utilizador, são necessárias permissões e expiraçõesOn.

Utilização de exemplo:

// 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();
isPipelineLike(unknown)

Um programa auxiliar para decidir se um determinado argumento satisfaz o contrato do Pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto pipeline com a Credencial fornecida.

Detalhes de Função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO NODE.JS RUNTIME. Gera um <xref:SASQueryParameters> objeto que contém todos os parâmetros de consulta SAS necessários para fazer um pedido REST real.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parâmetros

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Devoluções

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO NODE.JS RUNTIME. Cria uma instância de SASQueryParameters.

Apenas aceita as definições necessárias para criar uma SAS. Para definições opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador.

AVISO: quando o identificador não é fornecido, são necessárias permissões e expiresOn. Tem de atribuir o valor ao identificador ou expiraDo & permissões manualmente se inicialmente com este construtor.

Preencha os detalhes necessários antes de executar os seguintes fragmentos.

Utilização de exemplo:

// 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 com 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 com 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 NO NODE.JS RUNTIME. Cria uma instância de SASQueryParameters. AVISO: o identificador será ignorado ao gerar SAS de delegação de utilizador, são necessárias permissões e expiraçõesOn.

Utilização de exemplo:

// 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 devolvido de blobServiceClient.getUserDelegationKey()

accountName

string

Devoluções

isPipelineLike(unknown)

Um programa auxiliar para decidir se um determinado argumento satisfaz o contrato do Pipeline

function isPipelineLike(pipeline: unknown)

Parâmetros

pipeline

unknown

Um argumento que pode ser um Pipeline

Devoluções

boolean

verdadeiro quando o argumento satisfaz o contrato do Pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto pipeline com a Credencial fornecida.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)

Parâmetros

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

pipelineOptions
StoragePipelineOptions

Opcional. Opções.

Devoluções

Um novo objeto pipeline.