ContainerClient class

Crée une instance de ContainerClient. Cette méthode accepte une URL pointant vers un conteneur. La chaîne d’URL encodée ne sera PAS échappée deux fois, seuls les caractères spéciaux dans le chemin d’URL seront échappés. Si un nom d’objet blob inclut ? ou %, le nom de l’objet blob doit être encodé dans l’URL.

new ContainerClient(url: string, pipeline: PipelineLike)

Paramètres

Crée une instance de ContainerClient. Cette méthode accepte une URL pointant vers un conteneur. La chaîne d’URL encodée ne sera PAS échappée deux fois, seuls les caractères spéciaux dans le chemin d’URL seront échappés. Si un nom d’objet blob inclut ? ou %, le nom de l’objet blob doit être encodé dans l’URL.

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

Paramètres

Crée une instance de ContainerClient.

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

Paramètres

accountName: string

Valeur de propriété

Nom du conteneur.

string containerName

Valeur de propriété

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

Valeur de chaîne d’URL encodée.

url: string

Valeur de propriété

Crée un conteneur sous le compte spécifié. Si le conteneur portant le même nom existe déjà, l’opération échoue.

function create(options?: ContainerCreateOptions)

Paramètres

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

Retours

Crée un conteneur sous le compte spécifié. Si le conteneur portant le même nom existe déjà, il n’est pas modifié.

function createIfNotExists(options?: ContainerCreateOptions)

Paramètres

Retours

Marque le conteneur spécifié pour suppression. Le conteneur et tous les objets blob contenus dans celui-ci sont supprimés ultérieurement pendant le garbage collection.

function delete(options?: ContainerDeleteMethodOptions)

Paramètres

Retours

Marque l’objet blob ou l’instantané spécifié pour suppression. L’objet blob est supprimé ultérieurement pendant le garbage collection. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps avec l’opération Supprimer l’objet blob.

function deleteBlob(blobName: string, options?: ContainerDeleteBlobOptions)

Paramètres

Retours

Données de réponse de suppression d’objets blob de blocs.

Marque le conteneur spécifié pour la suppression s’il existe. Le conteneur et tous les objets blob contenus dans celui-ci sont supprimés ultérieurement pendant le garbage collection.

function deleteIfExists(options?: ContainerDeleteMethodOptions)

Paramètres

Retours

Retourne true si la ressource de conteneur Azure représentée par ce client existe ; false sinon. REMARQUE : utilisez cette fonction avec soin, car un conteneur existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux conteneurs portant le même nom peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée.

function exists(options?: ContainerExistsOptions)

Paramètres

Retours

Disponible uniquement pour ContainerClient construit avec des informations d’identification de clé partagée. Génère un URI SAP (Blob Container Service Shared Access Signature) basé sur les propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

function generateSasUrl(options: ContainerGenerateSasUrlOptions)

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Obtient les autorisations pour le conteneur spécifié. Les autorisations indiquent si les données de conteneur sont accessibles publiquement. AVERTISSEMENT : La date JavaScript perd potentiellement la précision lorsque l’analyse démarreOn et expire les chaînesOn. Par exemple, nouvelle Date(« 2018-12-31T03:44:23.8827891Z »). toISOString() obtient « 2018-12-31T03:44:23.882Z ».

function getAccessPolicy(options?: ContainerGetAccessPolicyOptions)

Paramètres

Retours

Crée un <xref:AppendBlobClient>

function getAppendBlobClient(blobName: string)

Paramètres

Retours

Crée un objet BlobBatchClient pour effectuer des opérations par lots.

function getBlobBatchClient()

Retours

Nouvel objet BlobBatchClient pour ce conteneur.

Crée un <xref:BlobClient>

function getBlobClient(blobName: string)

Paramètres

Retours

Nouvel objet BlobClient pour le nom d’objet blob donné.

Obtenez un <xref:BlobLeaseClient> qui gère les baux sur le conteneur.

function getBlobLeaseClient(proposeLeaseId?: string)

Paramètres

Retours

Nouvel objet BlobLeaseClient pour la gestion des baux sur le conteneur.

Crée un <xref:BlockBlobClient>

function getBlockBlobClient(blobName: string)

Paramètres

const content = "Hello world!";

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

Retours

Crée un <xref:PageBlobClient>

function getPageBlobClient(blobName: string)

Paramètres

Retours

Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le conteneur spécifié. Les données retournées n’incluent pas la liste des objets blob du conteneur.

function getProperties(options?: ContainerGetPropertiesOptions)

Paramètres

Retours

Retourne un itérateur itérable asynchrone pour répertorier tous les objets blob par hiérarchie. sous le compte spécifié. .byPage() retourne un itérateur itérable asynchrone pour répertorier les objets blob par hiérarchie dans les pages.

Exemple utilisant for await syntaxe :

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

Exemple utilisant 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}, last modified - ${item.properties.lastModified}`);
  }
  entity = await iter.next();
}

Exemple utilisant 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}, last modified - ${blob.properties.lastModified}`);
  }
}

Exemple utilisant la pagination avec une taille de page maximale :

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}, last modified - ${blob.properties.lastModified}`);
  }
}

function listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions)

Paramètres

Retours

Retourne un itérateur itérable asynchrone pour répertorier tous les objets blob sous le compte spécifié. .byPage() retourne un itérateur itérable asynchrone pour répertorier les objets blob dans les pages.

Exemple utilisant for await syntaxe :

// 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}`);
}

Exemple utilisant 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();
}

Exemple utilisant 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}`);
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

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)

Paramètres

Retours

AsyncIterableIterator qui prend en charge la pagination.

Définit les autorisations pour le conteneur spécifié. Les autorisations indiquent si les objets blob d’un conteneur sont accessibles publiquement. Lorsque vous définissez des autorisations pour un conteneur, les autorisations existantes sont remplacées. Si aucun accès ou containerAcl n’est fourni, la liste de contrôle d’accès du conteneur existante est supprimée.

Lorsque vous établissez une stratégie d’accès stockée sur un conteneur, la prise en compte peut prendre jusqu’à 30 secondes. Pendant cet intervalle, une signature d’accès partagé associée à la stratégie d’accès stockée échoue avec le code d’état 403 (Interdit), jusqu’à ce que la stratégie d’accès devienne active.

function setAccessPolicy(access?: PublicAccessType, containerAcl?: SignedIdentifier[], options?: ContainerSetAccessPolicyOptions)

Paramètres

Retours

Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le conteneur spécifié. Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre, les métadonnées du conteneur sont supprimées.

function setMetadata(metadata?: Metadata, options?: ContainerSetMetadataOptions)

Paramètres

Retours

Crée un objet blob de blocs ou met à jour le contenu d’un objet blob de blocs existant. La mise à jour d’un objet blob de blocs existant remplace toutes les métadonnées existantes sur l’objet blob. Les mises à jour partielles ne sont pas prises en charge ; le contenu de l’objet blob existant est remplacé par le nouveau contenu. Pour effectuer une mise à jour partielle des objets blob de blocs, utilisez <xref:BlockBlobClient.stageBlock> et <xref:BlockBlobClient.commitBlockList>.

Il s’agit d’une méthode de chargement non parallèle, utilisez <xref:BlockBlobClient.uploadFile>, <xref:BlockBlobClient.uploadStream> ou <xref:BlockBlobClient.uploadBrowserData> pour de meilleures performances avec le chargement concurrentiel.

function uploadBlockBlob(blobName: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Paramètres

Retours

Objet blob de blocs charge les données de réponse et l’instance BlockBlobClient correspondante.