BlobServiceClient class

BlobServiceClient rappresenta un client per il servizio BLOB di archiviazione di Azure che consente di modificare i contenitori BLOB.

Extends

StorageClient

Costruttori

BlobServiceClient(string, PipelineLike)

Crea un'istanza di BLOBServiceClient.

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

Crea un'istanza di BLOBServiceClient.

Proprietà ereditate

accountName
credential

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

url

Valore stringa URL codificato.

Metodi

createContainer(string, ContainerCreateOptions)

Creare un contenitore BLOB.

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

deleteContainer(string, ContainerDeleteMethodOptions)

Elimina un contenitore BLOB.

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Restituisce un iteratore iteratore iterabile asincrono per trovare tutti i BLOB con tag specificato nell'account specificato.

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

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

Esempio di uso for await della sintassi:

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

Esempio con 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();
}

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

Esempio di uso del paging con un marcatore:

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}`);
  }
}
fromConnectionString(string, StoragePipelineOptions)

Crea un'istanza di BlobServiceClient dalla stringa di connessione.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per BlobServiceClient costruito con credenziali di chiave condivisa.

Genera un URI di firma di accesso condiviso (SAS) dell'account BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

getAccountInfo(ServiceGetAccountInfoOptions)

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

getBlobBatchClient()

Crea un oggetto BlobBatchClient per eseguire operazioni batch.

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

getContainerClient(string)

Crea un oggetto ContainerClient

getProperties(ServiceGetPropertiesOptions)

Ottiene le proprietà del servizio BLOB di un account di archiviazione, incluse le proprietà per le regole di Analisi archiviazione e CORS (condivisione risorse tra le origini).

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

getStatistics(ServiceGetStatisticsOptions)

Recupera le statistiche correlate alla replica per il servizio BLOB. È disponibile solo sull'endpoint della posizione secondaria quando la replica geograficamente ridondante con accesso in lettura è abilitata per l'account di archiviazione.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONIBILE SOLO QUANDO SI USA L'AUTENTICAZIONE DEL TOKEN DI CONNESSIONE (TokenCredential).

Recupera una chiave di delega utente per il servizio BLOB. Si tratta di un'operazione valida solo quando si usa l'autenticazione del token di connessione.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

listContainers(ServiceListContainersOptions)

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

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

Esempio di uso for await della sintassi:

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

Esempio con 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();
}

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

Esempio di uso del paging con un marcatore:

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)

Imposta le proprietà per l'endpoint del servizio BLOB di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Ripristinare un contenitore BLOB eliminato in precedenza. Questa API è funzionante solo se l'eliminazione temporanea del contenitore è abilitata per l'account di archiviazione associato al contenitore.

Dettagli costruttore

BlobServiceClient(string, PipelineLike)

Crea un'istanza di BLOBServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parametri

url

string

Stringa client che punta al servizio BLOB di Archiviazione di Azure, ad esempio "https://myaccount.blob.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Chiamare newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.

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

Crea un'istanza di BLOBServiceClient.

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

Parametri

url

string

Stringa client che punta al servizio BLOB di Archiviazione di Azure, ad esempio "https://myaccount.blob.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

Facoltativa. Opzioni per configurare la pipeline HTTP.

Esempio di uso di DefaultAzureCredential da @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Esempio di uso di un nome account/chiave:

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

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

Dettagli proprietà ereditate

accountName

accountName: string

Valore della proprietà

string

Ereditato da StorageClient.accountName

credential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del @azure/identity pacchetto 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

url

Valore stringa URL codificato.

url: string

Valore della proprietà

string

Ereditato da StorageClient.url

Dettagli metodo

createContainer(string, ContainerCreateOptions)

Creare un contenitore BLOB.

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

function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>

Parametri

containerName

string

Nome del contenitore da creare.

options
ContainerCreateOptions

Opzioni per configurare l'operazione di creazione del contenitore.

Restituisce

Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>

Risposta alla creazione del contenitore e al client contenitore corrispondente.

deleteContainer(string, ContainerDeleteMethodOptions)

Elimina un contenitore BLOB.

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

Parametri

containerName

string

Nome del contenitore da eliminare.

options
ContainerDeleteMethodOptions

Opzioni per configurare l'operazione di eliminazione del contenitore.

Restituisce

Risposta di eliminazione del contenitore.

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Restituisce un iteratore iteratore iterabile asincrono per trovare tutti i BLOB con tag specificato nell'account specificato.

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

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

Esempio di uso for await della sintassi:

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

Esempio con 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();
}

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

Esempio di uso del paging con un marcatore:

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>

Parametri

tagFilterSqlExpression

string

Il parametro where consente al chiamante di eseguire query sui BLOB i cui tag corrispondono a una determinata espressione. L'espressione specificata deve restituire true per restituire un BLOB nei risultati. La regola di sintassi del filtro [OData - ABNF] definisce la grammatica formale per il valore del parametro di query where; Tuttavia, solo un subset della sintassi del filtro OData è supportato nel servizio BLOB.

options
ServiceFindBlobByTagsOptions

Opzioni per trovare i BLOB in base ai tag.

Restituisce

fromConnectionString(string, StoragePipelineOptions)

Crea un'istanza di BlobServiceClient dalla stringa di connessione.

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

Parametri

connectionString

string

Stringa di connessione dell'account o stringa di connessione sas di un account di archiviazione di Azure. [ Nota: la stringa di connessione dell'account può essere usata solo in NODE.JS runtime. ] Esempio di stringa di connessione dell'account -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Esempio di stringa di connessione di firma di accesso condiviso - 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

Facoltativa. Opzioni per configurare la pipeline HTTP.

Restituisce

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per BlobServiceClient costruito con credenziali di chiave condivisa.

Genera un URI di firma di accesso condiviso (SAS) dell'account BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Parametri

expiresOn

Date

Facoltativa. Ora in cui la firma di accesso condiviso non è valida. Se non specificato, il valore predefinito è un'ora successiva.

permissions
AccountSASPermissions

Specifica l'elenco di autorizzazioni da associare alla firma di accesso condiviso.

resourceTypes

string

Specifica i tipi di risorse associati alla firma di accesso condiviso.

options
ServiceGenerateAccountSasUrlOptions

Parametri facoltativi.

Restituisce

string

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

getAccountInfo(ServiceGetAccountInfoOptions)

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?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>

Parametri

options
ServiceGetAccountInfoOptions

Opzioni per l'operazione Service Get Account Info .Options to the Service Get Account Info operation.

Restituisce

Dati di risposta per l'operazione Service Get Account Info.

getBlobBatchClient()

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 servizio.

getContainerClient(string)

Crea un oggetto ContainerClient

function getContainerClient(containerName: string): ContainerClient

Parametri

containerName

string

Nome di un contenitore

Restituisce

Nuovo oggetto ContainerClient per il nome del contenitore specificato.

Esempio di utilizzo:

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

getProperties(ServiceGetPropertiesOptions)

Ottiene le proprietà del servizio BLOB di un account di archiviazione, incluse le proprietà per le regole di Analisi archiviazione e CORS (condivisione risorse tra le origini).

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

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

Parametri

options
ServiceGetPropertiesOptions

Opzioni per l'operazione Service Get Properties.Options to the Service Get Properties operation.

Restituisce

Dati di risposta per l'operazione Service Get Properties.

getStatistics(ServiceGetStatisticsOptions)

Recupera le statistiche correlate alla replica per il servizio BLOB. È disponibile solo sull'endpoint della posizione secondaria quando la replica geograficamente ridondante con accesso in lettura è abilitata per l'account di archiviazione.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats

function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

Parametri

options
ServiceGetStatisticsOptions

Opzioni per l'operazione Service Get Statistics.

Restituisce

Dati di risposta per l'operazione Service Get Statistics.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONIBILE SOLO QUANDO SI USA L'AUTENTICAZIONE DEL TOKEN DI CONNESSIONE (TokenCredential).

Recupera una chiave di delega utente per il servizio BLOB. Si tratta di un'operazione valida solo quando si usa l'autenticazione del token di connessione.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Parametri

startsOn

Date

Ora di inizio per la firma di accesso condiviso della delega utente. Deve essere entro 7 giorni dall'ora corrente

expiresOn

Date

Ora di fine per la firma di accesso condiviso della delega utente. Deve essere entro 7 giorni dall'ora corrente

Restituisce

listContainers(ServiceListContainersOptions)

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

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

Esempio di uso for await della sintassi:

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

Esempio con 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();
}

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

Esempio di uso del paging con un marcatore:

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>

Parametri

options
ServiceListContainersOptions

Opzioni per elencare i contenitori.

Restituisce

AsyncIterableIterator che supporta il paging.

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Imposta le proprietà per l'endpoint del servizio BLOB di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Parametri

options
ServiceSetPropertiesOptions

Opzioni per l'operazione Service Set Properties .Options to the Service Set Properties operation.

Restituisce

Dati di risposta per l'operazione Proprietà set di servizi.

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Ripristinare un contenitore BLOB eliminato in precedenza. Questa API è funzionante solo se l'eliminazione temporanea del contenitore è abilitata per l'account di archiviazione associato al contenitore.

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>

Parametri

deletedContainerName

string

Nome del contenitore eliminato in precedenza.

deletedContainerVersion

string

Versione del contenitore eliminato in precedenza, usata per identificare in modo univoco il contenitore eliminato.

options
ServiceUndeleteContainerOptions

Opzioni per configurare l'operazione di ripristino del contenitore.

Restituisce

Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>

Risposta di eliminazione del contenitore.