@azure/storage-blob package
Classes
AccountSASPermissions |
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um objeto AccountSASSignatureValues . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é específica e essa classe garante a exatidão. |
AccountSASResourceTypes |
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de recursos em um objeto AccountSASSignatureValues . É possível construir a cadeia de caracteres de recursos sem essa classe, mas a ordem dos recursos é específica e essa classe garante a exatidão. |
AccountSASServices |
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de serviços em um objeto AccountSASSignatureValues . É possível construir a cadeia de caracteres de serviços sem essa classe, mas a ordem dos serviços é específica e essa classe garante a exatidã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 SAS (Assinaturas de Acesso Compartilhado). |
AnonymousCredentialPolicy |
AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com SAS (Assinaturas de Acesso Compartilhado). |
AppendBlobClient |
AppendBlobClient define um conjunto de operações aplicáveis a blobs de acréscimo. |
BaseRequestPolicy |
A classe base da qual todas as políticas de solicitação derivam. |
BlobBatch |
Um BlobBatch representa um conjunto agregado de operações em blobs.
Atualmente, há suporte apenas |
BlobBatchClient |
Um BlobBatchClient permite que você faça solicitações em lote para o serviço de Blob de Armazenamento do Azure. Veja 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 blocos, um blob de acréscimo ou um blob de páginas. |
BlobLeaseClient |
Um cliente que gerencia concessões para um ContainerClient ou um BlobClient. |
BlobSASPermissions |
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um objeto BlobSASSignatureValues . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é específica e essa classe garante a exatidã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 blocos. |
ContainerClient |
Um ContainerClient representa uma URL para o contêiner do Armazenamento do Azure, permitindo que você manipule seus blobs. |
ContainerSASPermissions |
Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um objeto BlobSASSignatureValues . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é específica e essa classe garante a exatidã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 credencial usada para assinar solicitações HTTP(S) antes de enviar. Esta é uma classe abstrata. |
HttpHeaders |
Uma coleção de pares chave/valor de cabeçalho HTTP. |
PageBlobClient |
PageBlobClient define um conjunto de operações aplicáveis a blobs de páginas. |
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 do Pipeline. Consulte newPipeline e políticas fornecidas antes de implementar seu Pipeline personalizado. |
RequestPolicyOptions |
Propriedades opcionais que podem ser usadas ao criar um RequestPolicy. |
RestError |
Um erro resultante de uma solicitação HTTP para um ponto de extremidade de serviço. |
SASQueryParameters |
Representa os componentes que compõem os parâmetros de consulta de uma SAS de Armazenamento do Azure. Esse tipo não é construído diretamente pelo usuário; ele só é gerado pelos tipos AccountSASSignatureValues e BlobSASSignatureValues . Depois de gerado, ele pode ser codificado em um toString() e acrescentado a uma URL diretamente (embora tenha cuidado para ser tomado aqui caso haja parâmetros de consulta existentes, o que pode afetar os meios apropriados de acrescentar esses parâmetros de consulta). OBSERVAÇÃO: as instâncias dessa classe são imutáveis. |
StorageBrowserPolicy |
StorageBrowserPolicy lidará com diferenças entre Node.js e o runtime 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 objetos StorageRetryPolicy . |
StorageSharedKeyCredential |
DISPONÍVEL APENAS NO RUNTIME 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 a solicitação HTTP com uma chave compartilhada. |
WebResource |
Cria um novo objeto WebResource. Essa classe fornece uma abstração em uma chamada REST sendo independente de biblioteca/implementação e encapsulando as propriedades necessárias para iniciar uma solicitação. |
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 SOMENTE EM NODE.JS RUNTIME. AccountSASSignatureValues é usado para gerar uma SAS (Assinatura de Acesso Compartilhado) para uma conta de Armazenamento do Azure. Depois que todos os valores aqui forem definidos adequadamente, chame generateAccountSASQueryParameters para obter uma representação da SAS que pode realmente ser aplicada às URLs de blob. Observação: essa classe e SASQueryParameters existem porque a primeira é mutável e uma representação lógica, enquanto a última é 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 a operação 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 appendBlock . |
AppendBlobCreateHeaders |
Define cabeçalhos para AppendBlob_create operação. |
AppendBlobCreateIfNotExistsOptions |
Opções para configurar a operação createIfNotExists . |
AppendBlobCreateIfNotExistsResponse |
Contém dados de resposta para a <xref:appendBlobClient.createIfNotExists> operação. |
AppendBlobCreateOptions |
Opções para configurar a operação de criação . |
AppendBlobRequestConditions |
Condições a serem adicionadas à criação desse blob de acréscimo. |
AppendBlobSealOptions |
Opções para configurar a operação de selo . |
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 em uma operação em lote. |
BlobAbortCopyFromURLHeaders |
Define cabeçalhos para Blob_abortCopyFromURL operação. |
BlobAbortCopyFromURLOptions |
Opções para configurar a operação abortCopyFromURL . |
BlobAcquireLeaseOptions |
Opções para configurar a operação Blob – Adquirir Concessão. |
BlobBatchSubmitBatchOptionalParams |
Opções para configurar o Serviço – Enviar Parâmetros Opcionais do Lote. |
BlobBeginCopyFromURLOptions |
Opções para configurar a operação beginCopyFromURL . |
BlobBeginCopyFromURLResponse |
Contém dados de resposta para a operação beginCopyFromURL . |
BlobBeginCopyFromUrlPollState |
O estado usado pelo poller retornado de beginCopyFromURL. Esse estado é passado para o retorno de chamada especificado pelo |
BlobBreakLeaseOptions |
Opções para configurar a operação Blob – Interromper Concessão. |
BlobChangeLeaseOptions |
Opções para configurar o Blob – alterar a operação de 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 operação createSnapshot . |
BlobDeleteHeaders |
Define cabeçalhos para Blob_delete operação. |
BlobDeleteIfExistsResponse |
Contém dados de resposta para a operação deleteIfExists . |
BlobDeleteImmutabilityPolicyHeaders |
Define cabeçalhos para Blob_deleteImmutabilityPolicy operação. |
BlobDeleteImmutabilityPolicyOptions |
Opções para excluir a operação deleteImmutabilityPolicy da política de imutabilidade. |
BlobDeleteOptions |
Opções para configurar a operação de exclusão . |
BlobDownloadHeaders |
Define cabeçalhos para Blob_download operação. |
BlobDownloadOptionalParams |
Parâmetros opcionais. |
BlobDownloadOptions |
Opções para configurar a operação de download . |
BlobDownloadResponseParsed |
Contém dados de resposta para a operação de download . |
BlobDownloadToBufferOptions |
Interface de opção para a operação downloadToBuffer . |
BlobExistsOptions |
Opções para configurar a operação existente . |
BlobFlatListSegment |
Uma interface que representa BlobFlatListSegment. |
BlobFlatListSegmentModel | |
BlobGenerateSasUrlOptions |
Opções para configurar a operação generateSasUrl . |
BlobGetPropertiesHeaders |
Define cabeçalhos para Blob_getProperties operação. |
BlobGetPropertiesOptions |
Opções para configurar a operação getProperties . |
BlobGetPropertiesResponse |
Contém dados de resposta para a operação getProperties . |
BlobGetTagsHeaders |
Define cabeçalhos para Blob_getTags operação. |
BlobGetTagsOptions |
Opções para configurar a operação getTags . |
BlobHTTPHeaders |
Grupo de parâmetros |
BlobHierarchyListSegment |
Uma interface que representa BlobHierarchyListSegment. |
BlobHierarchyListSegmentModel | |
BlobImmutabilityPolicy |
Descrever 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 o blob com o formato do Apache Arrow. Válido somente para outputTextConfiguration. |
BlobQueryArrowField |
Descrever um campo em BlobQueryArrowConfiguration. |
BlobQueryCsvTextConfiguration |
Opções para consultar o blob com o formato CSV. |
BlobQueryError |
Tipo de erro de consulta de blob. |
BlobQueryHeaders |
Define cabeçalhos para Blob_query operação. |
BlobQueryJsonTextConfiguration |
Opções para consultar blob com formato JSON. |
BlobQueryParquetConfiguration |
Opções para consultar o blob com o formato Parquet. Válido somente para inputTextConfiguration. |
BlobReleaseLeaseOptions |
Opções para configurar a operação Blob – Liberação de Concessão. |
BlobRenewLeaseOptions |
Opções para configurar a operação Blob – Renovar Concessão. |
BlobRequestConditions |
cabeçalhos condicionais HTTP padrão, condição de marcas 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 SOMENTE EM NODE.JS RUNTIME. BlobSASSignatureValues é usado para ajudar a gerar tokens SAS do serviço 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 setHTTPHeaders . |
BlobSetImmutabilityPolicyHeaders |
Define cabeçalhos para Blob_setImmutabilityPolicy operação. |
BlobSetImmutabilityPolicyOptions |
Opções para definir a operação setImmutabilityPolicy da política de imutabilidade. |
BlobSetLegalHoldHeaders |
Define cabeçalhos para Blob_setLegalHold operação. |
BlobSetLegalHoldOptions |
Opções para definir a operação setLegalHold de retenção legal. |
BlobSetMetadataHeaders |
Define cabeçalhos para Blob_setMetadata operação. |
BlobSetMetadataOptions |
Opções para configurar a operação setMetadata . |
BlobSetTagsHeaders |
Define cabeçalhos para Blob_setTags operação. |
BlobSetTagsOptions |
Opções para configurar a operação setTags . |
BlobSetTierHeaders |
Define cabeçalhos para Blob_setTier operação. |
BlobSetTierOptions |
Opções para configurar a operação setAccessTier . |
BlobStartCopyFromURLHeaders |
Define cabeçalhos para Blob_startCopyFromURL operação. |
BlobStartCopyFromURLOptions |
Opções para configurar a operação beginCopyFromURL . |
BlobSyncCopyFromURLOptions |
Opções para configurar a operação syncCopyFromURL . |
BlobTag | |
BlobTags |
Marcas de blob |
BlobUndeleteHeaders |
Define cabeçalhos para Blob_undelete operação. |
BlobUndeleteOptions |
Opções para configurar a operação de cancelamento de exclusão . |
Block |
Representa um único bloco em um blob de blocos. Ele descreve a ID e o tamanho do bloco. |
BlockBlobCommitBlockListHeaders |
Define cabeçalhos para BlockBlob_commitBlockList operação. |
BlockBlobCommitBlockListOptions |
Opções para configurar a operação commitBlockList . |
BlockBlobGetBlockListHeaders |
Define cabeçalhos para BlockBlob_getBlockList operação. |
BlockBlobGetBlockListOptions |
Opções para configurar a operação 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 a operação de consulta . |
BlockBlobStageBlockFromURLHeaders |
Define cabeçalhos para BlockBlob_stageBlockFromURL operação. |
BlockBlobStageBlockFromURLOptions |
Opções para configurar a operação stageBlockFromURL . |
BlockBlobStageBlockHeaders |
Define cabeçalhos para BlockBlob_stageBlock operação. |
BlockBlobStageBlockOptions |
Opções para configurar a operação stageBlock . |
BlockBlobSyncUploadFromURLOptions |
Opções para configurar a operação syncUploadFromURL . |
BlockBlobUploadHeaders |
Define cabeçalhos para BlockBlob_upload operação. |
BlockBlobUploadOptions |
Opções para configurar a operação de upload . |
BlockBlobUploadStreamOptions |
Interface de opção para a operação uploadStream . |
BlockList | |
CommonGenerateSasUrlOptions |
Opções comuns de BlobGenerateSasUrlOptions e ContainerGenerateSasUrlOptions. |
CommonOptions |
Uma interface para opções comuns a cada operação remota. |
ContainerAcquireLeaseOptions |
Opções para configurar a operação Contêiner – Adquirir Concessão. |
ContainerBreakLeaseOptionalParams |
Parâmetros opcionais. |
ContainerBreakLeaseOptions |
Opções para configurar a operação Contêiner – Interromper Concessão. |
ContainerChangeLeaseOptions |
Opções para configurar a operação Contêiner – Alterar Concessão. |
ContainerCreateHeaders |
Define cabeçalhos para Container_create operação. |
ContainerCreateIfNotExistsResponse |
Contém dados de resposta para a operação createIfNotExists . |
ContainerCreateOptions |
Opções para configurar a operação de criação . |
ContainerDeleteBlobOptions |
Opções para configurar a operação deleteBlob . |
ContainerDeleteHeaders |
Define cabeçalhos para Container_delete operação. |
ContainerDeleteIfExistsResponse |
Contém dados de resposta para a operação deleteIfExists . |
ContainerDeleteMethodOptions |
Opções para configurar a operação de exclusão . |
ContainerEncryptionScope |
Grupo de parâmetros |
ContainerExistsOptions |
Há opções para configurar a operação . |
ContainerFilterBlobsHeaders |
Define cabeçalhos para Container_filterBlobs operação. |
ContainerFindBlobByTagsOptions |
Opções para configurar a operação findBlobsByTags . |
ContainerGenerateSasUrlOptions |
Opções para configurar a operação generateSasUrl . |
ContainerGetAccessPolicyHeaders |
Define cabeçalhos para Container_getAccessPolicy operação. |
ContainerGetAccessPolicyOptions |
Opções para configurar a operação getAccessPolicy . |
ContainerGetPropertiesHeaders |
Define cabeçalhos para Container_getProperties operação. |
ContainerGetPropertiesOptions |
Opções para configurar a operação getProperties . |
ContainerItem |
Um contêiner 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 operações de Contêiner – Listar Blobs. Consulte: |
ContainerProperties |
Propriedades de um contêiner |
ContainerReleaseLeaseOptions |
Opções para configurar a operação Contêiner – Liberação de Concessão. |
ContainerRenameHeaders |
Define cabeçalhos para Container_rename operação. |
ContainerRenewLeaseOptions |
Opções para configurar a operação Contêiner – Renovar Concessão. |
ContainerRequestConditions |
Condições a serem atendidos para o contêiner. |
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 a operação setAccessPolicy . |
ContainerSetMetadataHeaders |
Define cabeçalhos para Container_setMetadata operação. |
ContainerSetMetadataOptions |
Opções para configurar a operação setMetadata . |
ContainerUndeleteHeaders |
Define cabeçalhos para Container_restore operação. |
CorsRule |
O CORS é um recurso HTTP que permite que um aplicativo web em execução 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 uma página da Web de chamar 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 à API de Blobs de Filtro |
FilterBlobSegment |
Resposta de segmento da operação findBlobsByTags . |
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 nos valores de cabeçalho Authorization, ProxyAuthorization, WWW-Authenticate e Proxy-Authenticate. |
HttpOperationResponse |
Objeto wrapper para solicitação http e resposta. O objeto desserializado é armazenado na |
IHttpClient |
Uma interface que pode enviar HttpRequests e receber HttpResponses prometidos. |
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 contêineres |
Logging |
Configurações de log do Azure Analytics. |
MatchConditions |
Especifica opções HTTP para solicitações condicionais com base na correspondência de ETag. |
Metadata |
Um mapa de pares nome-valor a serem associados 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 |
padrão de cabeçalhos condicionais HTTP e condição de marcas. |
ModifiedAccessConditionsModel |
Grupo de parâmetros |
ObjectReplicationPolicy |
Contém a ID da Política de Replicação de Objeto e a respectiva lista de ObjectReplicationRule. Isso é usado ao recuperar as Propriedades de Replicação de Objeto no blob de origem. A ID da política para o blob de destino é definida em ObjectReplicationDestinationPolicyId das respectivas respostas de método (por exemplo, <xref:BlobProperties.ObjectReplicationDestinationPolicyId>. |
ObjectReplicationRule |
Contém a ID da Regra de Replicação de Objeto 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 a operação 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 createIfNotExists . |
PageBlobCreateIfNotExistsResponse |
Contém dados de resposta para a operação createIfNotExists . |
PageBlobCreateOptions |
Opções para configurar a operação de criaçã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 getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions) operação. |
PageBlobGetPageRangesHeaders |
Define cabeçalhos para PageBlob_getPageRanges operação. |
PageBlobGetPageRangesOptions |
Opções para configurar a operação getPageRanges . |
PageBlobGetPageRangesResponse |
Contém dados de resposta para a getPageRanges(number, number, PageBlobGetPageRangesOptions) operação. |
PageBlobListPageRangesDiffOptions |
Opções para configurar a operação listPageRangesDiff . |
PageBlobListPageRangesOptions |
Opções para configurar a operação listPageRanges . |
PageBlobRequestConditions |
Condições a serem adicionadas à criação deste blob de páginas. |
PageBlobResizeHeaders |
Define cabeçalhos para PageBlob_resize operação. |
PageBlobResizeOptions |
Opções para configurar a operação de redimensionamento . |
PageBlobStartCopyIncrementalOptions |
Opções para configurar a operação startCopyIncremental . |
PageBlobUpdateSequenceNumberHeaders |
Define cabeçalhos para PageBlob_updateSequenceNumber operação. |
PageBlobUpdateSequenceNumberOptions |
Opções para configurar a operação updateSequenceNumber . |
PageBlobUploadPagesFromURLHeaders |
Define cabeçalhos para PageBlob_uploadPagesFromURL operação. |
PageBlobUploadPagesFromURLOptions |
Opções para configurar a operação uploadPagesFromURL . |
PageBlobUploadPagesHeaders |
Define cabeçalhos para PageBlob_uploadPages operação. |
PageBlobUploadPagesOptions |
Opções para configurar a operação uploadPages . |
PageList |
Lista de intervalos de páginas para um blob. |
PageRangeInfo | |
ParsedBatchResponse |
A resposta multipart/mista que contém a resposta para cada sub-solicitação. |
PipelineLike |
Uma interface para a 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 do Pipeline. Consulte newPipeline e 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ário para definir qualquer sondador de operação de execução prolongada. Enquanto a classe Poller funciona como o mecanismo de controle local para começar a disparar, aguardar e potencialmente cancelar uma operação de execução longa, o PollOperationState documenta o status da operação de execução longa remota. Ela deve ser atualizada 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 possam ser atualizadas por outros motivos. |
PollerLike |
Representação abstrata de um sondador, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar. |
PollerLikeWithCancellation |
Representação abstrata de um sondador, 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. |
RequestPolicy |
A estrutura subjacente de uma política de solicitação. |
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 |
ServiceFilterBlobsHeaders |
Define cabeçalhos para Service_filterBlobs operação. |
ServiceFindBlobByTagsOptions |
Opções para configurar a operação findBlobsByTags . |
ServiceGenerateAccountSasUrlOptions |
Opções para configurar a operação generateAccountSasUrl . |
ServiceGetAccountInfoHeaders |
Define cabeçalhos para Service_getAccountInfo operação. |
ServiceGetAccountInfoOptions |
Opções para configurar a operação getAccountInfo . |
ServiceGetPropertiesHeaders |
Define cabeçalhos para Service_getProperties operação. |
ServiceGetPropertiesOptions |
Opções para configurar a operação getProperties . |
ServiceGetStatisticsHeaders |
Define cabeçalhos para Service_getStatistics operação. |
ServiceGetStatisticsOptions |
Opções para configurar a operação getStatistics . |
ServiceGetUserDelegationKeyHeaders |
Define cabeçalhos para Service_getUserDelegationKey operação. |
ServiceGetUserDelegationKeyOptions |
Opções para configurar o Serviço – Obter Chave de Delegação do Usuário. |
ServiceListContainersOptions |
Opções para configurar a operação listContainers . |
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 operação setProperties . |
ServiceSubmitBatchHeaders |
Define cabeçalhos para Service_submitBatch operação. |
ServiceSubmitBatchOptionalParamsModel |
Parâmetros opcionais. |
ServiceUndeleteContainerOptions |
Opções para configurar a operação 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 newPipeline . |
StorageRetryOptions |
Interface de opções de repetição do Blob de Armazenamento. |
TagConditions |
Especifica opções HTTP para solicitações condicionais com base em marcas de 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 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 deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) operação. |
BlobBatchSetBlobsAccessTierResponse |
Contém dados de resposta para a setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) operação. |
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. |
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 getTags . |
BlobImmutabilityPolicyMode |
Define valores para BlobImmutabilityPolicyMode. |
BlobQueryArrowFieldType |
O tipo de um 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 cancelamento de exclusão. |
BlobUploadCommonResponse |
Tipo de resposta para uploadFile, 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 upload. |
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 exclusão. |
ContainerFindBlobsByTagsSegmentResponse |
A resposta da operação findBlobsByTags . |
ContainerGetAccessPolicyResponse |
Contém dados de resposta para a operação 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 de um BlobClient que são necessárias para que o poller retornado por 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. Conhecer valores compatíveis com o serviçoAES256 |
GeoReplicationStatusType |
Define valores para GeoReplicationStatusType. |
HttpRequestBody |
Possíveis tipos de corpo de solicitação HTTP |
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 objeto 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 de criação. |
PageBlobGetPageRangesDiffResponseModel |
Contém dados de resposta para a operação getPageRangesDiff. |
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. |
RequestPolicyFactory |
Cria uma nova RequestPolicy por solicitação que usa a nextPolicy fornecida. |
SequenceNumberActionType |
Define valores para SequenceNumberActionType. |
ServiceFindBlobsByTagsSegmentResponse |
A resposta da operação findBlobsByTags . |
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 getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) 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 |
Marcas de blob. |
Enumerações
BlockBlobTier |
Representa a camada de acesso em um blob. Para obter informações detalhadas sobre camadas de nível de blob de blocos , consulte Camadas de armazenamento frequentes, esporádicas e de arquivos. |
KnownEncryptionAlgorithmType |
Valores conhecidos de EncryptionAlgorithmType que o serviço aceita. |
PremiumPageBlobTier |
Especifica a camada de blob de página para a qual definir o blob. Isso só é aplicável a blobs de páginas em contas de armazenamento premium. Consulte aqui para obter informações detalhadas sobre o IOPS e a taxa de transferência correspondentes por PageBlobTier. |
SASProtocol |
Protocolos para SAS gerada. |
StorageBlobAudience |
Define os públicos de nuvem conhecidos para Armazenamento. |
StorageRetryPolicyType |
Tipos retryPolicy. |
Funções
deserialization |
Crie uma solicitação de serialização RequestPolicyCreator que serializará corpos de solicitação HTTP à medida que passarem pelo pipeline HTTP. |
generate |
DISPONÍVEL APENAS NO RUNTIME 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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
generate |
DISPONÍVEL APENAS NO RUNTIME NODE.JS. Cria uma instância de SASQueryParameters. Aceita apenas as configurações necessárias necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identifier. AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraOn. Você DEVE atribuir valor ao identificador ou expiraOn & permissões manualmente se você inicializar com esse construtor. Preencha os detalhes necessários antes de executar os snippets a seguir. Exemplo de uso:
Exemplo usando um identificador:
Exemplo usando um nome de blob:
|
generate |
DISPONÍVEL APENAS NO RUNTIME NODE.JS. Cria uma instância de SASQueryParameters. AVISO: o identificador será ignorado ao gerar SAS de delegação de usuário, são necessárias permissões e expiraçõesOn. Exemplo de uso:
|
get |
|
is |
Um auxiliar para decidir se um determinado argumento satisfaz o contrato pipeline |
new |
Cria um novo objeto Pipeline com a Credencial fornecida. |
Detalhes da função
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
Crie uma solicitação de serialização RequestPolicyCreator que serializará corpos de solicitação HTTP à medida que passarem pelo pipeline HTTP.
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory
Parâmetros
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
Retornos
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
DISPONÍVEL APENAS NO RUNTIME 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.
Veja 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
Retornos
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)
DISPONÍVEL APENAS NO RUNTIME NODE.JS.
Cria uma instância de SASQueryParameters.
Aceita apenas as configurações necessárias necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identifier.
AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraOn. Você DEVE atribuir valor ao identificador ou expiraOn & permissões manualmente se você inicializar com esse construtor.
Preencha os detalhes necessários antes de executar os snippets a seguir.
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): SASQueryParameters
Parâmetros
- blobSASSignatureValues
- BlobSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Retornos
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)
DISPONÍVEL APENAS NO RUNTIME NODE.JS.
Cria uma instância de SASQueryParameters. AVISO: o identificador será ignorado ao gerar SAS de delegação de usuário, são necessárias permissões e expiraçõesOn.
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 retornado de blobServiceClient.getUserDelegationKey()
- accountName
-
string
Retornos
getBlobServiceAccountAudience(string)
function getBlobServiceAccountAudience(storageAccountName: string): string
Parâmetros
- storageAccountName
-
string
Retornos
string
isPipelineLike(unknown)
Um auxiliar para decidir se um determinado argumento satisfaz o contrato pipeline
function isPipelineLike(pipeline: unknown): pipeline
Parâmetros
- pipeline
-
unknown
Um argumento que pode ser um Pipeline
Retornos
pipeline
true quando o argumento satisfaz o contrato pipeline
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria um novo objeto Pipeline com a Credencial fornecida.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline
Parâmetros
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity
pacote 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.
Retornos
Um novo objeto Pipeline.