ContainerClient class

Crea un'istanza di ContainerClient. Questo metodo accetta un URL che punta a un contenitore. La stringa URL codificata non verrà preceduta da un carattere di escape due volte. Solo i caratteri speciali nel percorso URL verranno preceduti da un carattere di escape. Se il nome di un BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL.

new ContainerClient(url: string, pipeline: PipelineLike)

Parametri

Crea un'istanza di ContainerClient. Questo metodo accetta un URL che punta a un contenitore. La stringa URL codificata non verrà preceduta da un carattere di escape due volte. Solo i caratteri speciali nel percorso URL verranno preceduti da un carattere di escape. Se il nome di un BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL.

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

Parametri

Crea un'istanza di ContainerClient.

new ContainerClient(connectionString: string, containerName: string, options?: StoragePipelineOptions)

Parametri

Nome del contenitore.

string containerName

Valore della proprietà

accountName: string

Valore della proprietà

Ereditato da StorageClient.accountName

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

ereditato da StorageClient.credential

Valore stringa URL codificato.

url: string

Valore della proprietà

Ereditato da StorageClient.url

Crea un nuovo contenitore nell'account specificato. Se il contenitore con lo stesso nome esiste già, l'operazione non riesce.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/create-container regole di denominazione: vedere https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

function create(options?: ContainerCreateOptions): Promise<ContainerCreateResponse>

Parametri

const containerClient = blobServiceClient.getContainerClient("<container name>");
const createContainerResponse = await containerClient.create();
console.log("Container was created successfully", createContainerResponse.requestId);

Restituisce

Crea un nuovo contenitore nell'account specificato. Se il contenitore con lo stesso nome esiste già, non viene modificato.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/create-container regole di denominazione: vedere https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

function createIfNotExists(options?: ContainerCreateOptions): Promise<ContainerCreateIfNotExistsResponse>

Parametri

Restituisce

Contrassegna il contenitore specificato per l'eliminazione. Il contenitore e tutti i BLOB contenuti in esso vengono eliminati in un secondo momento durante la Garbage Collection.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

function delete(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

Parametri

Restituisce

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione. Il BLOB viene eliminato in un secondo momento durante l'operazione di Garbage Collection. Si noti che per eliminare un BLOB, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente con l'operazione Elimina BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteBlob(blobName: string, options?: ContainerDeleteBlobOptions): Promise<BlobDeleteResponse>

Parametri

Restituisce

Bloccare i dati di risposta all'eliminazione del BLOB.

Contrassegna il contenitore specificato per l'eliminazione, se presente. Il contenitore e tutti i BLOB contenuti in esso vengono eliminati in un secondo momento durante la Garbage Collection.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

function deleteIfExists(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteIfExistsResponse>

Parametri

Restituisce

Restituisce true se la risorsa contenitore di Azure rappresentata da questo client esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione perché un contenitore esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, i nuovi contenitori con lo stesso nome potrebbero essere aggiunti da altri client o applicazioni al termine di questa funzione.

function exists(options?: ContainerExistsOptions): Promise<boolean>

Parametri

Restituisce

Restituisce un iteratore iteratore asincrono per trovare tutti i BLOB con tag specificato nel contenitore specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i BLOB nelle pagine.

Esempio di utilizzo della sintassi for await:

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

Esempio di utilizzo di iter.next():

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

Esempio di utilizzo di byPage():

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

Esempio di utilizzo del paging con un marcatore:

let i = 1;
let iterator = containerClient.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 = containerClient
  .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?: ContainerFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

Parametri

Restituisce

Disponibile solo per ContainerClient costruito con credenziali chiave condivise.

Genera un URI della firma di accesso condiviso del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ContainerGenerateSasUrlOptions): Promise<string>

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Ottiene le autorizzazioni per il contenitore specificato. Le autorizzazioni indicano se è possibile accedere pubblicamente ai dati del contenitore.

AVVISO: la data JavaScript perderà potenzialmente la precisione durante l'analisi di startsOn e scadrà stringheOn. Ad esempio, new Date("2018-12-31T03:44:23.8827891Z").toISOString() otterrà "2018-12-31T03:44:23.882Z".

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl

function getAccessPolicy(options?: ContainerGetAccessPolicyOptions): Promise<ContainerGetAccessPolicyResponse>

Parametri

Restituisce

L'operazione Get Account Information restituisce il nome sku e il tipo di account per l'account specificato. L'operazione Get Account Information è disponibile nelle versioni del servizio a partire dalla versione 2018-03-28.

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

function getAccountInfo(options?: ContainerGetAccountInfoOptions): Promise<ContainerGetAccountInfoResponse>

Parametri

Restituisce

Dati di risposta per l'operazione Di recupero dell'account del servizio.

Crea un AppendBlobClient

function getAppendBlobClient(blobName: string): AppendBlobClient

Parametri

Restituisce

Crea un oggetto BlobBatchClient per eseguire operazioni batch.

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

function getBlobBatchClient(): BlobBatchClient

Restituisce

Nuovo oggetto BlobBatchClient per questo contenitore.

Crea un BlobClient

function getBlobClient(blobName: string): BlobClient

Parametri

Restituisce

Nuovo oggetto BlobClient per il nome del BLOB specificato.

Ottenere un BlobLeaseClient che gestisce i lease nel contenitore.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametri

Restituisce

Nuovo oggetto BlobLeaseClient per la gestione dei lease nel contenitore.

Crea un BlockBlobClient

function getBlockBlobClient(blobName: string): BlockBlobClient

Parametri

const content = "Hello world!";

const blockBlobClient = containerClient.getBlockBlobClient("<blob name>");
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

Restituisce

Crea un PageBlobClient di

function getPageBlobClient(blobName: string): PageBlobClient

Parametri

Restituisce

Restituisce tutti i metadati e le proprietà di sistema definiti dall'utente per il contenitore specificato. I dati restituiti non includono l'elenco di BLOB del contenitore.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties

AVVISO: l'oggetto metadata restituito nella risposta avrà le relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dal metodo listContainers di BlobServiceClient usando l'opzione includeMetadata, che manterrà le maiuscole e minuscole originali.

function getProperties(options?: ContainerGetPropertiesOptions): Promise<ContainerGetPropertiesResponse>

Parametri

Restituisce

Restituisce un iteratore iteratore asincrono per elencare tutti i BLOB in base alla gerarchia. nell'account specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i BLOB in base alla gerarchia nelle pagine.

Esempio di utilizzo della sintassi for await:

for await (const item of containerClient.listBlobsByHierarchy("/")) {
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}`);
  }
}

Esempio di utilizzo di iter.next():

let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
let entity = await iter.next();
while (!entity.done) {
  let item = entity.value;
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}`);
  }
  entity = await iter.next();
}

Esempio di utilizzo di byPage():

console.log("Listing blobs by hierarchy by page");
for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
  const segment = response.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

Esempio di utilizzo del paging con dimensioni massime della pagina:

console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");

let i = 1;
for await (const response of containerClient
  .listBlobsByHierarchy("/", { prefix: "prefix2/sub1/" })
  .byPage({ maxPageSize: 2 })) {
  console.log(`Page ${i++}`);
  const segment = response.segment;

  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }

  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

function listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<({ kind: "prefix" } & BlobPrefix) | ({ kind: "blob" } & BlobItem), ContainerListBlobHierarchySegmentResponse, PageSettings>

Parametri

Restituisce

Restituisce un iteratore iteratore asincrono per elencare tutti i BLOB nell'account specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i BLOB nelle pagine.

Esempio di utilizzo della sintassi for await:

// Get the containerClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>");`
let i = 1;
for await (const blob of containerClient.listBlobsFlat()) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

Esempio di utilizzo di iter.next():

let i = 1;
let iter = containerClient.listBlobsFlat();
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

Esempio di utilizzo di byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

Esempio di utilizzo del paging con un marcatore:

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

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

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = containerClient.listBlobsFlat().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

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

function listBlobsFlat(options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Parametri

Restituisce

AsyncIterableIterator che supporta il paging.

Imposta le autorizzazioni per il contenitore specificato. Le autorizzazioni indicano se è possibile accedere pubblicamente ai BLOB in un contenitore.

Quando si impostano le autorizzazioni per un contenitore, le autorizzazioni esistenti vengono sostituite. Se non viene fornito alcun accesso o contenitoreAcl, l'ACL del contenitore esistente verrà rimosso.

Quando si stabilisce un criterio di accesso archiviato in un contenitore, potrebbero essere necessari fino a 30 secondi. Durante questo intervallo, una firma di accesso condiviso associata ai criteri di accesso archiviati avrà esito negativo con il codice di stato 403 (Accesso negato), fino a quando i criteri di accesso non diventano attivi.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl

function setAccessPolicy(access?: PublicAccessType, containerAcl?: SignedIdentifier[], options?: ContainerSetAccessPolicyOptions): Promise<ContainerSetAccessPolicyResponse>

Parametri

Restituisce

Imposta una o più coppie nome-valore definite dall'utente per il contenitore specificato.

Se non viene specificata alcuna opzione o nessun metadato definito nel parametro, i metadati del contenitore verranno rimossi.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata

function setMetadata(metadata?: Metadata, options?: ContainerSetMetadataOptions): Promise<ContainerSetMetadataResponse>

Parametri

Restituisce

Crea un nuovo BLOB in blocchi o aggiorna il contenuto di un BLOB in blocchi esistente.

L'aggiornamento di un BLOB in blocchi esistente sovrascrive tutti i metadati esistenti nel BLOB. Gli aggiornamenti parziali non sono supportati; il contenuto del BLOB esistente viene sovrascritto con il nuovo contenuto. Per eseguire un aggiornamento parziale di un BLOB in blocchi, usare stageBlock e commitBlockList.

Si tratta di un metodo di caricamento non parallelo, usare uploadFile, uploadStream o uploadBrowserData per ottenere prestazioni migliori con il caricamento della concorrenza.

Vedere https://docs.microsoft.com/rest/api/storageservices/put-blob

function uploadBlockBlob(blobName: string, body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<{ blockBlobClient: BlockBlobClient, response: BlockBlobUploadResponse }>

Parametri

Restituisce

Bloccare i dati di risposta di caricamento blob e l'istanza BlockBlobClient corrispondente.