Partager via

BlobServiceClient class

  • Référence
Paquet:
@azure/storage-blob

Un BlobServiceClient représente un client du service Blob Stockage Azure, ce qui vous permet de manipuler des conteneurs d’objets blob.

Extends
StorageClient

Constructeurs

BlobServiceClient(string, PipelineLike)

Crée une instance de BlobServiceClient.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crée une instance de BlobServiceClient.

Propriétés

accountName
credential

Par exemple, AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du @azure/identity package pour authentifier les demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.
url

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

Méthodes

createContainer(string, ContainerCreateOptions)

Créez un conteneur d’objets blob.
deleteContainer(string, ContainerDeleteMethodOptions)

Supprime un conteneur d’objets blob.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Retourne un itérateur itérable asynchrone pour rechercher tous les objets blob avec la balise spécifiée sous le compte spécifié. .byPage() retourne un itérateur itérable asynchrone pour répertorier les objets blob dans les pages.
fromConnectionString(string, StoragePipelineOptions)

Crée une instance de BlobServiceClient à partir de la chaîne de connexion.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponible uniquement pour BlobServiceClient construit avec des informations d’identification de clé partagée. Génère un URI de signature d’accès partagé (SAS) de compte Blob en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client.
getAccountInfo(ServiceGetAccountInfoOptions)

L’opération Obtenir les informations de compte retourne le nom de la référence et le type de compte pour le compte spécifié. L’opération Obtenir les informations sur le compte est disponible sur les versions de service à compter de la version 2018-03-28.
getBlobBatchClient()

Crée un objet BlobBatchClient pour effectuer des opérations par lots.
getContainerClient(string)

Crée un <xref:ContainerClient> objet
getProperties(ServiceGetPropertiesOptions)

Obtient les propriétés du service Blob d’un compte de stockage, y compris les propriétés pour les règles Storage Analytics et CORS (Cross-Origin Resource Sharing).
getStatistics(ServiceGetStatisticsOptions)

Récupère des statistiques relatives à la réplication pour le service BLOB. Elle est uniquement disponible sur le point de terminaison d'emplacement secondaire lorsque la réplication géographique redondante avec accès en lecture est activée pour le compte de stockage.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONIBLE UNIQUEMENT LORS DE L’UTILISATION DE L’AUTHENTIFICATION PAR JETON DU PORTEUR (TokenCredential). Récupère une clé de délégation utilisateur pour le service Blob. Il s’agit uniquement d’une opération valide lors de l’utilisation de l’authentification par jeton du porteur.
listContainers(ServiceListContainersOptions)

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

Exemple utilisant la for await syntaxe :

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

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

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

Exemple d’utilisation de la pagination avec un marqueur :

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)

Définit les propriétés du point de terminaison de service Blob d’un compte de stockage, y compris les propriétés pour les Storage Analytics, les règles CORS (Cross-Origin Resource Sharing) et les paramètres de suppression réversible.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Restaurez un conteneur d’objets blob précédemment supprimé. Cette API est uniquement fonctionnelle si la suppression réversible de conteneur est activée pour le compte de stockage associé au conteneur.

Détails du constructeur

BlobServiceClient(string, PipelineLike)

Crée une instance de BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Paramètres

url

string

Chaîne cliente pointant vers le service d’objet blob Stockage Azure, telle que « https://myaccount.blob.core.windows.net". Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.blob.core.windows.net?sasString" ; ».

pipeline
PipelineLike

Appelez newPipeline() pour créer un pipeline par défaut ou fournissez un pipeline personnalisé.

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

Crée une instance de BlobServiceClient.

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

Paramètres

url

string

Chaîne cliente pointant vers le service d’objet blob Stockage Azure, telle que « https://myaccount.blob.core.windows.net". Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.blob.core.windows.net?sasString" ; ».

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Telles que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du @azure/identity package pour authentifier les demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.

options
StoragePipelineOptions

facultatif. Options de configuration du pipeline HTTP.

Exemple utilisant DefaultAzureCredential à partir de @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Exemple utilisant un nom/une clé de compte :

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

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

Détails de la propriété

accountName 

accountName: string

Valeur de propriété

string

credential

Par exemple, AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du @azure/identity package pour authentifier les demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

url

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

url: string

Valeur de propriété

string

Détails de la méthode

createContainer(string, ContainerCreateOptions)

Créez un conteneur d’objets blob.

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

Paramètres

containerName

string

Nom du conteneur à créer.

options
ContainerCreateOptions

Options de configuration de l’opération de création de conteneur.

Retours

Promise<Object>

Réponse de création de conteneur et client de conteneur correspondant.

deleteContainer(string, ContainerDeleteMethodOptions)

Supprime un conteneur d’objets blob.

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

Paramètres

containerName

string

Nom du conteneur à supprimer.

options
ContainerDeleteMethodOptions

Options de configuration de l’opération de suppression de conteneur.

Retours

Promise<ContainerDeleteResponse>

Réponse à la suppression du conteneur.

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

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

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

Paramètres

tagFilterSqlExpression

string

Le paramètre where permet à l’appelant d’interroger les objets blob dont les balises correspondent à une expression donnée. L’expression donnée doit prendre la valeur true pour qu’un objet blob soit retourné dans les résultats. La règle de syntaxe de filtre [OData - ABNF] définit la grammaire formelle pour la valeur du paramètre de requête where ; Toutefois, seul un sous-ensemble de la syntaxe de filtre OData est pris en charge dans le service Blob.

options
ServiceFindBlobByTagsOptions

Options permettant de rechercher des objets blob par balises.

Retours

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>

fromConnectionString(string, StoragePipelineOptions)

Crée une instance de BlobServiceClient à partir de la chaîne de connexion.

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

Paramètres

connectionString

string

Chaîne de connexion de compte ou chaîne de connexion SAP d’un compte de stockage Azure. [ Remarque : la chaîne de connexion de compte ne peut être utilisée que dans NODE.JS runtime. ] Exemple de chaîne de connexion de compte -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemple de chaîne de connexion 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

facultatif. Options pour configurer le pipeline HTTP.

Retours

BlobServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponible uniquement pour BlobServiceClient construit avec des informations d’identification de clé partagée. Génère un URI de signature d’accès partagé (SAS) de compte Blob en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client.

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

Paramètres

expiresOn

Date

facultatif. Heure à laquelle la signature d’accès partagé devient non valide. La valeur par défaut est une heure plus tard si elle n’est pas fournie.

permissions
AccountSASPermissions

Spécifie la liste des autorisations à associer à la sap.

resourceTypes

string

Spécifie les types de ressources associés à la signature d’accès partagé.

options
ServiceGenerateAccountSasUrlOptions

Paramètres facultatifs.

Retours

string

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

getAccountInfo(ServiceGetAccountInfoOptions)

L’opération Obtenir les informations de compte retourne le nom de la référence et le type de compte pour le compte spécifié. L’opération Obtenir les informations sur le compte est disponible sur les versions de service à compter de la version 2018-03-28.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

Paramètres

options
ServiceGetAccountInfoOptions

Options de l’opération Obtenir les informations de compte du service.

Retours

Promise<ServiceGetAccountInfoResponse>

Données de réponse pour l’opération Obtenir les informations de compte du service.

getBlobBatchClient()

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

function getBlobBatchClient()

Retours

BlobBatchClient

Nouvel objet BlobBatchClient pour ce service.

getContainerClient(string)

Crée un <xref:ContainerClient> objet

function getContainerClient(containerName: string)

Paramètres

containerName

string

Nom d’un conteneur

Retours

ContainerClient

Nouvel objet ContainerClient pour le nom de conteneur donné.

Exemple d'utilisation :

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

getProperties(ServiceGetPropertiesOptions)

Obtient les propriétés du service Blob d’un compte de stockage, y compris les propriétés pour les règles Storage Analytics et CORS (Cross-Origin Resource Sharing).

function getProperties(options?: ServiceGetPropertiesOptions)

Paramètres

options
ServiceGetPropertiesOptions

Options de l’opération Propriétés d’obtention du service.

Retours

Promise<ServiceGetPropertiesResponse>

Données de réponse pour l’opération Propriétés d’obtention du service.

getStatistics(ServiceGetStatisticsOptions)

Récupère des statistiques relatives à la réplication pour le service BLOB. Elle est uniquement disponible sur le point de terminaison d'emplacement secondaire lorsque la réplication géographique redondante avec accès en lecture est activée pour le compte de stockage.

function getStatistics(options?: ServiceGetStatisticsOptions)

Paramètres

options
ServiceGetStatisticsOptions

Options de l’opération Obtenir les statistiques du service.

Retours

Promise<ServiceGetStatisticsResponse>

Données de réponse pour l’opération Obtenir les statistiques du service.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONIBLE UNIQUEMENT LORS DE L’UTILISATION DE L’AUTHENTIFICATION PAR JETON DU PORTEUR (TokenCredential). Récupère une clé de délégation utilisateur pour le service Blob. Il s’agit uniquement d’une opération valide lors de l’utilisation de l’authentification par jeton du porteur.

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

Paramètres

startsOn

Date

Heure de début de la sap de délégation d’utilisateur. Doit être dans les 7 jours suivant l’heure actuelle

expiresOn

Date

Heure de fin de la sap de délégation d’utilisateur. Doit être dans les 7 jours suivant l’heure actuelle

options
ServiceGetUserDelegationKeyOptions

Retours

Promise<ServiceGetUserDelegationKeyResponse>

listContainers(ServiceListContainersOptions)

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

Exemple utilisant la for await syntaxe :

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

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

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

Exemple d’utilisation de la pagination avec un marqueur :

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)

Paramètres

options
ServiceListContainersOptions

Options permettant de répertorier les conteneurs.

Retours

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

AsyncIterableIterator qui prend en charge la pagination.

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Définit les propriétés du point de terminaison de service Blob d’un compte de stockage, y compris les propriétés pour les Storage Analytics, les règles CORS (Cross-Origin Resource Sharing) et les paramètres de suppression réversible.

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

Paramètres

properties
BlobServiceProperties
options
ServiceSetPropertiesOptions

Options de l’opération Propriétés du jeu de services.

Retours

Promise<ServiceSetPropertiesResponse>

Données de réponse pour l’opération Propriétés du jeu de services.

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Restaurez un conteneur d’objets blob précédemment supprimé. Cette API est uniquement fonctionnelle si la suppression réversible de conteneur est activée pour le compte de stockage associé au conteneur.

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

Paramètres

deletedContainerName

string

Nom du conteneur précédemment supprimé.

deletedContainerVersion

string

Version du conteneur précédemment supprimé, utilisée pour identifier de manière unique le conteneur supprimé.

options
ServiceUndeleteContainerOptions

Options pour configurer l’opération de restauration de conteneur.

Retours

Promise<Object>

Réponse à la suppression du conteneur.