BlobServiceClient class
Un BlobServiceClient représente un client vers le service Blob Stockage Azure qui vous permet de manipuler des conteneurs d’objets blob.
- Extends
-
StorageClient
Blob |
Crée une instance de BlobServiceClient. |
Blob |
Crée une instance de BlobServiceClient. |
account |
|
credential | Telles que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du |
url | Valeur de chaîne d’URL encodée. |
create |
Créez un conteneur d’objets blob. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
delete |
Supprime un conteneur d’objets blob. |
find |
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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties Exemple utilisant la
Exemple utilisant
Exemple utilisant
Exemple d’utilisation de la pagination avec un marqueur :
|
from |
Crée une instance de BlobServiceClient à partir de la chaîne de connexion. |
generate |
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 d’objet blob en fonction des propriétés et paramètres du client passés. La signature d’accès partagé est signée par les informations d’identification de clé partagée du client. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
get |
L’opération Obtenir les informations sur le compte retourne le nom de la référence SKU 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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Crée un objet BlobBatchClient pour effectuer des opérations par lot. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
get |
Crée un objet ContainerClient |
get |
Obtient les propriétés du service Blob d’un compte de stockage, y compris les propriétés des règles Storage Analytics et CORS (Cross-Origin Resource Sharing). Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats |
get |
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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key |
list |
Retourne un itérateur itérable asynchrone pour répertorier tous les conteneurs sous le compte spécifié. .byPage() retourne un itérateur itérable asynchrone pour répertorier les conteneurs dans les pages. Exemple utilisant la
Exemple utilisant
Exemple utilisant
Exemple d’utilisation de la pagination avec un marqueur :
|
set |
Définit les propriétés du point de terminaison de service Blob d’un compte de stockage, notamment les propriétés de Storage Analytics, les règles CORS (Cross-Origin Resource Sharing) et les paramètres de suppression réversible. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
Restaurer un conteneur d’objets blob précédemment supprimé. Cette API est fonctionnelle uniquement si la suppression réversible de conteneur est activée pour le compte de stockage associé au conteneur. |
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
Optionnel. 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
);
accountName: string
Valeur de propriété
string
Hérité de StorageClient.accountName
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é.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Valeur de propriété
Hérité de StorageClient.credential
Valeur de chaîne d’URL encodée.
url: string
Valeur de propriété
string
Hérité de StorageClient.url
Créez un conteneur d’objets blob.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
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<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Réponse de création de conteneur et client de conteneur correspondant.
Supprime un conteneur d’objets blob.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
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.
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.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
Exemple utilisant la for await
syntaxe :
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
Exemple utilisant 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();
}
Exemple utilisant 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}`);
}
}
}
Exemple d’utilisation de la pagination avec un marqueur :
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>
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
Crée une instance de BlobServiceClient à partir de la chaîne de connexion.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
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
Optionnel. Options de configuration du pipeline HTTP.
Retours
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 d’objet blob en fonction des propriétés et paramètres du client passés. La signature d’accès partagé est signée par les informations d’identification de clé partagée du client.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Paramètres
- expiresOn
-
Date
Optionnel. Heure à laquelle la signature d’accès partagé ne devient plus 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 signature d’accès partagé.
- resourceTypes
-
string
Spécifie les types de ressources associés à la signature d’accès partagé.
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 SAS généré.
L’opération Obtenir les informations sur le compte retourne le nom de la référence SKU 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.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
Paramètres
- options
- ServiceGetAccountInfoOptions
Options de l’opération Obtenir les informations sur le compte du service.
Retours
Promise<ServiceGetAccountInfoResponse>
Données de réponse pour l’opération Obtenir les informations de compte du service.
Crée un objet BlobBatchClient pour effectuer des opérations par lot.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
function getBlobBatchClient(): BlobBatchClient
Retours
Nouvel objet BlobBatchClient pour ce service.
Crée un objet ContainerClient
function getContainerClient(containerName: string): ContainerClient
Paramètres
- containerName
-
string
Nom d’un conteneur
Retours
Nouvel objet ContainerClient pour le nom de conteneur donné.
Exemple d’utilisation :
const containerClient = blobServiceClient.getContainerClient("<container name>");
Obtient les propriétés du service Blob d’un compte de stockage, y compris les propriétés des règles Storage Analytics et CORS (Cross-Origin Resource Sharing).
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Paramètres
- options
- ServiceGetPropertiesOptions
Options de l’opération Obtenir les propriétés du service.
Retours
Promise<ServiceGetPropertiesResponse>
Données de réponse pour l’opération Obtenir les propriétés du service.
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.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>
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.
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.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Paramètres
- startsOn
-
Date
Heure de début de la sape de délégation d’utilisateur. Doit être dans les 7 jours suivant l’heure actuelle
- expiresOn
-
Date
Heure de fin de la sape de délégation d’utilisateur. Doit être dans les 7 jours suivant l’heure actuelle
Retours
Promise<ServiceGetUserDelegationKeyResponse>
Retourne un itérateur itérable asynchrone pour répertorier tous les conteneurs sous le compte spécifié.
.byPage() retourne un itérateur itérable 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): PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>
Paramètres
- options
- ServiceListContainersOptions
Options de liste des conteneurs.
Retours
AsyncIterableIterator qui prend en charge la pagination.
Définit les propriétés du point de terminaison de service Blob d’un compte de stockage, notamment les propriétés de Storage Analytics, les règles CORS (Cross-Origin Resource Sharing) et les paramètres de suppression réversible.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
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.
Restaurer un conteneur d’objets blob précédemment supprimé. Cette API est fonctionnelle uniquement 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): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Paramètres
- deletedContainerName
-
string
Nom du conteneur précédemment supprimé.
- deletedContainerVersion
-
string
Version du conteneur supprimé précédemment, utilisée pour identifier de manière unique le conteneur supprimé.
- options
- ServiceUndeleteContainerOptions
Options permettant de configurer l’opération de restauration de conteneur.
Retours
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Réponse à la suppression du conteneur.