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

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 da propriedade

Valor da cadeia de caracteres de URL codificada.

url: string

Valor da propriedade

Crie um contêiner de Blob.

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

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)

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.

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

Parâmetros

Retornos

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

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

Parâmetros

Retornos

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

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

Parâmetros

Retornos

Um URI 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.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

Parâmetros

Retornos

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

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

function getBlobBatchClient()

Retornos

Um novo objeto BlobBatchClient para este serviço.

Cria um objeto <xref:ContainerClient>

function getContainerClient(containerName: string)

Parâmetros

Retornos

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

Uso de exemplo:

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

Obtém as propriedades do serviço blob de uma conta de armazenamento, incluindo propriedades para as regras de Análise de Armazenamento e CORS (Compartilhamento de Recursos entre Origens).

function getProperties(options?: ServiceGetPropertiesOptions)

Parâmetros

Retornos

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

Recupera estatísticas relacionadas à replicação para o serviço Blob. Ele só está disponível no ponto de extremidade de 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

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 do usuário para o serviço Blob. Essa é 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

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 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 a 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

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.

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

Parâmetros

Retornos

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

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

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

Parâmetros

Retornos

Resposta de exclusão de contêiner.