BlobServiceClient class

Cria uma instância de BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parâmetros

Cria uma instância de BlobServiceClient.

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

Parâmetros

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

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

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

accountName: string

Valor da propriedade

Herdado de StorageClient.accountName

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor da propriedade

Herdado de StorageClient.credential

Valor da cadeia de caracteres de URL codificada.

url: string

Valor da propriedade

Herdado de StorageClient.url

Criar um contêiner de Blob.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-container

function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>

Parâmetros

Retornos

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

Exclui um contêiner de Blob.

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

Parâmetros

Retornos

Resposta de exclusão de contêiner.

Retorna um iterador iterável assíncrono para localizar todos os blobs com a marca especificada na conta especificada.

.byPage() retorna um iterador iterável assíncrono para listar os blobs nas páginas.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties

Exemplo usando for await a sintaxe:

let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
  console.log(`Blob ${i++}: ${container.name}`);
}

Exemplo usando iter.next():

let i = 1;
const iter = blobServiceClient.findBlobsByTags("tagkey='tagvalue'");
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
  if (response.blobs) {
    for (const blob of response.blobs) {
      console.log(`Blob ${i++}: ${blob.name}`);
    }
  }
}

Exemplo usando paginação com um marcador:

let i = 1;
let iterator = blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 blob names
if (response.blobs) {
  for (const blob of response.blobs) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

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

// Prints blob names
if (response.blobs) {
  for (const blob of response.blobs) {
     console.log(`Blob ${i++}: ${blob.name}`);
  }
}

function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse, PageSettings>

Parâmetros

Retornos

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

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

Parâmetros

Retornos

Disponível somente para BlobServiceClient construído com uma credencial de chave compartilhada.

Gera um URI de SAS (Assinatura de Acesso Compartilhado) da conta de Blob com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Parâmetros

Retornos

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

A operação Obter Informações da Conta retorna o nome do sku e o tipo de conta da conta especificada. A operação Obter Informações da Conta está disponível em versões de serviço a partir da versão 2018-03-28.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>

Parâmetros

Retornos

Dados de resposta para a operação Obter Informações da Conta do Serviço.

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

function getBlobBatchClient(): BlobBatchClient

Retornos

Um novo objeto BlobBatchClient para esse serviço.

Cria um objeto ContainerClient

function getContainerClient(containerName: string): ContainerClient

Parâmetros

Retornos

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

Exemplo de uso:

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

Obtém as propriedades do serviço Blob de uma conta de armazenamento, incluindo propriedades para regras de Análise de Armazenamento e CORS (compartilhamento de recursos entre origens).

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

Parâmetros

Retornos

Dados de resposta para a operação Obter Propriedades do Serviço.

Recupera as estatísticas relacionadas à replicação do serviço Blob. Ela está disponível apenas no ponto de extremidade de local secundário quando a replicação georredundante de acesso de leitura está habilitada para a conta de armazenamento.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats

function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

Parâmetros

Retornos

Dados de resposta para a operação Obter Estatísticas do Serviço.

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 Blob. Essa é apenas uma operação válida ao usar a autenticação de token de portador.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Parâmetros

Retornos

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 em páginas.

Exemplo usando for await a sintaxe:

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 usando 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): PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>

Parâmetros

Retornos

Um asyncIterableIterator que dá suporte à paginação.

Define propriedades para o ponto de extremidade do serviço Blob de uma conta de armazenamento, incluindo propriedades para Análise de Armazenamento, regras cors (compartilhamento de recursos entre origens) e configurações de exclusão reversível.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Parâmetros

Retornos

Dados de resposta para a operação Propriedades do Conjunto de Serviços.

Restaurar um contêiner de Blob excluído anteriormente. Essa API só será funcional se a Exclusão Reversível de Contêiner estiver habilitada para a conta de armazenamento associada ao contêiner.

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>

Parâmetros

Retornos

Resposta de exclusão de contêiner.