Partilhar via

BlobServiceClient class

  • Referência
Pacote:
@azure/storage-blob

Um BlobServiceClient representa um Cliente para o serviço de Blob de Armazenamento do Azure, permitindo que você manipule contêineres de blob.

Extends
StorageClient

Construtores

BlobServiceClient(string, PipelineLike)

Cria uma instância de BlobServiceClient.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de BlobServiceClient.

Propriedades

accountName
credential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.
url

Valor da cadeia de caracteres de URL codificada.

Métodos

createContainer(string, ContainerCreateOptions)

Crie um contêiner de Blob.
deleteContainer(string, ContainerDeleteMethodOptions)

Exclui um contêiner de Blob.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Retorna um iterador iterável assíncrono para localizar todos os blobs com a tag especificada na conta especificada. .byPage() retorna um iterador iterável assíncrono para listar os blobs nas páginas.
fromConnectionString(string, StoragePipelineOptions)

Cria uma instância de BlobServiceClient a partir da cadeia de conexão.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para BlobServiceClient construído com uma credencial de chave compartilhada. Gera um URI SAS (Assinatura de Acesso Compartilhado) de conta de Blob com base nas propriedades e parâmetros do cliente passados. O SAS é assinado pela credencial de chave compartilhada do cliente.
getAccountInfo(ServiceGetAccountInfoOptions)

A operação Obter informações da conta retorna o nome da sku e o tipo de conta para a conta especificada. A operação Obter informações da conta está disponível em versões de serviço que começam com a versão 2018-03-28.
getBlobBatchClient()

Cria um objeto BlobBatchClient para conduzir operações em lote.
getContainerClient(string)

Cria um objeto <xref:ContainerClient>
getProperties(ServiceGetPropertiesOptions)

Obtém as propriedades do serviço de Blob de uma conta de armazenamento, incluindo propriedades para regras de Análise de Armazenamento e CORS (Cross-Origin Resource Sharing).
getStatistics(ServiceGetStatisticsOptions)

Recupera estatísticas relacionadas à replicação para o serviço de Blob. Ele só está disponível no ponto de extremidade do local secundário quando a replicação com redundância geográfica de acesso de leitura está habilitada para a conta de armazenamento.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONÍVEL SOMENTE AO USAR A AUTENTICAÇÃO DE TOKEN DE PORTADOR (TokenCredential). Recupera uma chave de delegação de usuário para o serviço de Blob. Esta é apenas uma operação válida ao usar a autenticação de token de portador.
listContainers(ServiceListContainersOptions)

Retorna um iterador iterável assíncrono para listar todos os contêineres na conta especificada. .byPage() retorna um iterador iterável assíncrono para listar os contêineres nas páginas.

Exemplo usando sintaxe for await:

let i = 1;
for await (const container of blobServiceClient.listContainers()) {
  console.log(`Container ${i++}: ${container.name}`);
}

Exemplo usando iter.next():

let i = 1;
const iter = blobServiceClient.listContainers();
let containerItem = await iter.next();
while (!containerItem.done) {
  console.log(`Container ${i++}: ${containerItem.value.name}`);
  containerItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
  if (response.containerItems) {
    for (const container of response.containerItems) {
      console.log(`Container ${i++}: ${container.name}`);
    }
  }
}

Exemplo de utilização da paginação com um marcador:

let i = 1;
let iterator = blobServiceClient.listContainers().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
    console.log(`Container ${i++}: ${container.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
     console.log(`Container ${i++}: ${container.name}`);
  }
}
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Define propriedades para o ponto de extremidade de serviço Blob de uma conta de armazenamento, incluindo propriedades para Análise de Armazenamento, regras CORS (Cross-Origin Resource Sharing) e configurações de exclusão suave.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Restaure um contêiner de Blob excluído anteriormente. Essa API só será funcional se o Container Soft Delete estiver habilitado para a conta de armazenamento associada ao contêiner.

Detalhes do Construtor

BlobServiceClient(string, PipelineLike)

Cria uma instância de BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parâmetros

url

string

Uma cadeia de caracteres Client apontando para o serviço de blob de Armazenamento do Azure, como "https://myaccount.blob.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de BlobServiceClient.

new BlobServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parâmetros

url

string

Uma cadeia de caracteres Client apontando para o serviço de blob de Armazenamento do Azure, como "https://myaccount.blob.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

options
StoragePipelineOptions

Opcional. Opções para configurar o pipeline HTTP.

Exemplo usando DefaultAzureCredential de @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  defaultAzureCredential
);

Exemplo usando um nome/chave de conta:

const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");

const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  sharedKeyCredential
);

Detalhes de Propriedade

accountName 

accountName: string

Valor de Propriedade

string

credential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

url

Valor da cadeia de caracteres de URL codificada.

url: string

Valor de Propriedade

string

Detalhes de Método

createContainer(string, ContainerCreateOptions)

Crie um contêiner de Blob.

function createContainer(containerName: string, options?: ContainerCreateOptions)

Parâmetros

containerName

string

Nome do contêiner a ser criado.

options
ContainerCreateOptions

Opções para configurar a operação Criar contêiner.

Devoluções

Promise<Object>

Resposta de criação de contêiner e o cliente de contêiner correspondente.

deleteContainer(string, ContainerDeleteMethodOptions)

Exclui um contêiner de Blob.

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions)

Parâmetros

containerName

string

Nome do contêiner a ser excluído.

options
ContainerDeleteMethodOptions

Opções para configurar a operação Exclusão de contêiner.

Devoluções

Promise<ContainerDeleteResponse>

Resposta de exclusão de contêiner.

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Retorna um iterador iterável assíncrono para localizar todos os blobs com a tag especificada na conta especificada. .byPage() retorna um iterador iterável assíncrono para listar os blobs nas páginas.

function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions)

Parâmetros

tagFilterSqlExpression

string

O parâmetro where permite que o chamador consulte blobs cujas tags correspondem a uma determinada expressão. A expressão dada deve ser avaliada como verdadeira para que um blob seja retornado nos resultados. A regra de sintaxe do filtro [OData - ABNF] define a gramática formal para o valor do parâmetro de consulta where; no entanto, apenas um subconjunto da sintaxe do filtro OData é suportado no serviço Blob.

options
ServiceFindBlobByTagsOptions

Opções para encontrar blobs por tags.

Devoluções

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>

fromConnectionString(string, StoragePipelineOptions)

Cria uma instância de BlobServiceClient a partir da cadeia de conexão.

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions)

Parâmetros

connectionString

string

Cadeia de conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure. [ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS tempo de execução. ] Exemplo de cadeia de conexão de conta - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net exemplo de cadeia de conexão SAS - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

options
StoragePipelineOptions

Opcional. Opções para configurar o pipeline HTTP.

Devoluções

BlobServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para BlobServiceClient construído com uma credencial de chave compartilhada. Gera um URI SAS (Assinatura de Acesso Compartilhado) de conta de Blob com base nas propriedades e parâmetros do cliente passados. O SAS é assinado pela credencial de chave compartilhada do cliente.

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions)

Parâmetros

expiresOn

Date

Opcional. O momento em que a assinatura de acesso compartilhado se torna inválida. O padrão é uma hora depois, se não for fornecido.

permissions
AccountSASPermissions

Especifica a lista de permissões a serem associadas ao SAS.

resourceTypes

string

Especifica os tipos de recursos associados à assinatura de acesso compartilhado.

options
ServiceGenerateAccountSasUrlOptions

Parâmetros opcionais.

Devoluções

string

Um URI SAS de conta que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

getAccountInfo(ServiceGetAccountInfoOptions)

A operação Obter informações da conta retorna o nome da sku e o tipo de conta para a conta especificada. A operação Obter informações da conta está disponível em versões de serviço que começam com a versão 2018-03-28.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

Parâmetros

options
ServiceGetAccountInfoOptions

Opções para a operação Obter informações da conta do serviço.

Devoluções

Promise<ServiceGetAccountInfoResponse>

Dados de resposta para a operação Obter informações da conta do serviço.

getBlobBatchClient()

Cria um objeto BlobBatchClient para conduzir operações em lote.

function getBlobBatchClient()

Devoluções

BlobBatchClient

Um novo objeto BlobBatchClient para este serviço.

getContainerClient(string)

Cria um objeto <xref:ContainerClient>

function getContainerClient(containerName: string)

Parâmetros

containerName

string

Um nome de contêiner

Devoluções

ContainerClient

Um novo objeto ContainerClient para o nome de contêiner fornecido.

Exemplo de uso:

const containerClient = blobServiceClient.getContainerClient("<container name>");

getProperties(ServiceGetPropertiesOptions)

Obtém as propriedades do serviço de Blob de uma conta de armazenamento, incluindo propriedades para regras de Análise de Armazenamento e CORS (Cross-Origin Resource Sharing).

function getProperties(options?: ServiceGetPropertiesOptions)

Parâmetros

options
ServiceGetPropertiesOptions

Opções para a operação Obter propriedades do serviço.

Devoluções

Promise<ServiceGetPropertiesResponse>

Dados de resposta para a operação Service Get Properties.

getStatistics(ServiceGetStatisticsOptions)

Recupera estatísticas relacionadas à replicação para o serviço de Blob. Ele só está disponível no ponto de extremidade do local secundário quando a replicação com redundância geográfica de acesso de leitura está habilitada para a conta de armazenamento.

function getStatistics(options?: ServiceGetStatisticsOptions)

Parâmetros

options
ServiceGetStatisticsOptions

Opções para a operação Obter estatísticas do serviço.

Devoluções

Promise<ServiceGetStatisticsResponse>

Dados de resposta para a operação Service Get Statistics.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONÍVEL SOMENTE AO USAR A AUTENTICAÇÃO DE TOKEN DE PORTADOR (TokenCredential). Recupera uma chave de delegação de usuário para o serviço de Blob. Esta é apenas uma operação válida ao usar a autenticação de token de portador.

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions)

Parâmetros

startsOn

Date

A hora de início para a SAS de delegação de usuário. Deve ser dentro de 7 dias da hora atual

expiresOn

Date

A hora de término da SAS de delegação de usuário. Deve ser dentro de 7 dias da hora atual

options
ServiceGetUserDelegationKeyOptions

Devoluções

Promise<ServiceGetUserDelegationKeyResponse>

listContainers(ServiceListContainersOptions)

Retorna um iterador iterável assíncrono para listar todos os contêineres na conta especificada. .byPage() retorna um iterador iterável assíncrono para listar os contêineres nas páginas.

Exemplo usando sintaxe for await:

let i = 1;
for await (const container of blobServiceClient.listContainers()) {
  console.log(`Container ${i++}: ${container.name}`);
}

Exemplo usando iter.next():

let i = 1;
const iter = blobServiceClient.listContainers();
let containerItem = await iter.next();
while (!containerItem.done) {
  console.log(`Container ${i++}: ${containerItem.value.name}`);
  containerItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
  if (response.containerItems) {
    for (const container of response.containerItems) {
      console.log(`Container ${i++}: ${container.name}`);
    }
  }
}

Exemplo de utilização da paginação com um marcador:

let i = 1;
let iterator = blobServiceClient.listContainers().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
    console.log(`Container ${i++}: ${container.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
     console.log(`Container ${i++}: ${container.name}`);
  }
}

function listContainers(options?: ServiceListContainersOptions)

Parâmetros

options
ServiceListContainersOptions

Opções para listar contêineres.

Devoluções

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

Um asyncIterableIterator que suporta paginação.

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Define propriedades para o ponto de extremidade de serviço Blob de uma conta de armazenamento, incluindo propriedades para Análise de Armazenamento, regras CORS (Cross-Origin Resource Sharing) e configurações de exclusão suave.

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions)

Parâmetros

properties
BlobServiceProperties
options
ServiceSetPropertiesOptions

Opções para a operação Propriedades do conjunto de serviços.

Devoluções

Promise<ServiceSetPropertiesResponse>

Dados de resposta para a operação Propriedades do conjunto de serviços.

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Restaure um contêiner de Blob excluído anteriormente. Essa API só será funcional se o Container Soft Delete estiver habilitado para a conta de armazenamento associada ao contêiner.

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions)

Parâmetros

deletedContainerName

string

Nome do contêiner excluído anteriormente.

deletedContainerVersion

string

Versão do contêiner excluído anteriormente, usado para identificar exclusivamente o contêiner excluído.

options
ServiceUndeleteContainerOptions

Opções para configurar a operação de restauração de contêiner.

Devoluções

Promise<Object>

Resposta de exclusão de contêiner.