Freigeben über

BlobServiceClient class

  • Referenz
Paket:
@azure/storage-blob

Ein BlobServiceClient stellt einen Client für den Azure Storage Blob-Dienst dar, mit dem Sie BLOB-Container bearbeiten können.

Extends

StorageClient

Konstruktoren

BlobServiceClient(string, PipelineLike)

Erstellt eine Instanz von BlobServiceClient.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt eine Instanz von BlobServiceClient.

Geerbte Eigenschaften

accountName
credential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.
url

Codierter URL-Zeichenfolgenwert.

Methoden

createContainer(string, ContainerCreateOptions)

Erstellen Sie einen BLOB-Container.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/create-container.
deleteContainer(string, ContainerDeleteMethodOptions)

Löscht einen BLOB-Container.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Blobs mit dem angegebenen Tag unter dem angegebenen Konto zu finden.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Blobs auf Seiten auflisten zu können.

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

Beispiel mit for await Syntax:

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

Beispiel für die Verwendung von 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();
}

Beispiel für die Verwendung von 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}`);
    }
  }
}

Beispiel für das Paging mit einer Markierung:

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)

Erstellt eine Instanz von BlobServiceClient aus der Verbindungszeichenfolge.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Nur für BlobServiceClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert einen SAS-URI (Blob Account Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas.
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Nur für BlobServiceClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert eine Zeichenfolge zum Signieren für einen SAS-URI (Blob Account Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas.
getAccountInfo(ServiceGetAccountInfoOptions)

Der Vorgang "Kontoinformationen abrufen" gibt den SKU-Namen und die Kontoart für das angegebene Konto zurück. Der Vorgang "Kontoinformationen abrufen" ist in Dienstversionen ab Version 2018-03-28 verfügbar.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information.
getBlobBatchClient()

Erstellt ein BlobBatchClient -Objekt zum Durchführen von Batchvorgängen.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch.
getContainerClient(string)

Erstellt ein ContainerClient--Objekt
getProperties(ServiceGetPropertiesOptions)

Ruft die Eigenschaften des Blob-Diensts eines Speicherkontos ab, einschließlich Eigenschaften für Speicheranalyse- und CORS-Regeln (Cross-Origin Resource Sharing).

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties.
getStatistics(ServiceGetStatisticsOptions)

Ruft Statistiken zur Replikation für den Blob-Dienst ab. Sie ist nur für den sekundären Standortendpunkt verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Speicherkonto aktiviert ist.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

NUR VERFÜGBAR BEI VERWENDUNG DER BEARERTOKENAUTHENTIFIZIERUNG (TokenCredential).

Ruft einen Benutzerdelegierungsschlüssel für den BLOB-Dienst ab. Dies ist nur ein gültiger Vorgang, wenn die Bearertokenauthentifizierung verwendet wird.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key.
listContainers(ServiceListContainersOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Container unter dem angegebenen Konto auflisten zu können.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Container auf Seiten auflisten zu können.

Beispiel mit for await Syntax:

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

Beispiel für die Verwendung von 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();
}

Beispiel für die Verwendung von 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}`);
    }
  }
}

Beispiel für das Paging mit einer Markierung:

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)

Legt Eigenschaften für den Blob-Dienstendpunkt eines Speicherkontos fest, einschließlich Eigenschaften für Storage Analytics, CORS -Regeln (Cross-Origin Resource Sharing) und Einstellungen für vorläufiges Löschen.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Stellen Sie einen zuvor gelöschten BLOB-Container wieder her. Diese API ist nur funktionsfähig, wenn container Soft Delete für das dem Container zugeordnete Speicherkonto aktiviert ist.

Details zum Konstruktor

BlobServiceClient(string, PipelineLike)

Erstellt eine Instanz von BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parameter

url

string

Eine Clientzeichenfolge, die auf den Azure Storage-BLOB-Dienst verweist, z. B. "https://myaccount.blob.core.windows.net". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.

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

Erstellt eine Instanz von BlobServiceClient.

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

Parameter

url

string

Eine Clientzeichenfolge, die auf den Azure Storage-BLOB-Dienst verweist, z. B. "https://myaccount.blob.core.windows.net". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

options
StoragePipelineOptions

Wahlfrei. Optionen zum Konfigurieren der HTTP-Pipeline.

Beispiel für die Verwendung von DefaultAzureCredential aus @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Beispiel für die Verwendung eines Kontonamens/Schlüssels:

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

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

Geerbte Eigenschaftsdetails

accountName 

accountName: string

Eigenschaftswert

string

geerbt von StorageClient.accountName

credential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

von StorageClient.credential geerbt

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

geerbt von StorageClient.url

Details zur Methode

createContainer(string, ContainerCreateOptions)

Erstellen Sie einen BLOB-Container.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/create-container.

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

Parameter

containerName

string

Name des zu erstellenden Containers.

options
ContainerCreateOptions

Optionen zum Konfigurieren des Containererstellungsvorgangs.

Gibt zurück

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

Antwort auf die Containererstellung und den entsprechenden Containerclient.

deleteContainer(string, ContainerDeleteMethodOptions)

Löscht einen BLOB-Container.

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

Parameter

containerName

string

Name des zu löschenden Containers.

options
ContainerDeleteMethodOptions

Optionen zum Konfigurieren des Containerlöschvorgangs.

Gibt zurück

Promise<ContainerDeleteResponse>

Antwort auf das Löschen von Containern.

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Blobs mit dem angegebenen Tag unter dem angegebenen Konto zu finden.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Blobs auf Seiten auflisten zu können.

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

Beispiel mit for await Syntax:

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

Beispiel für die Verwendung von 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();
}

Beispiel für die Verwendung von 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}`);
    }
  }
}

Beispiel für das Paging mit einer Markierung:

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>

Parameter

tagFilterSqlExpression

string

Mit dem Parameter "where" kann der Aufrufer Blobs abfragen, deren Tags einem bestimmten Ausdruck entsprechen. Der angegebene Ausdruck muss als "true" ausgewertet werden, damit ein BLOB in den Ergebnissen zurückgegeben wird. Die [OData - ABNF]-Filtersyntaxregel definiert die formale Grammatik für den Wert des Abfrageparameters; Im Blob-Dienst wird jedoch nur eine Teilmenge der OData-Filtersyntax unterstützt.

options
ServiceFindBlobByTagsOptions

Optionen zum Suchen von Blobs nach Tags.

Gibt zurück

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse, PageSettings>

fromConnectionString(string, StoragePipelineOptions)

Erstellt eine Instanz von BlobServiceClient aus der Verbindungszeichenfolge.

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

Parameter

connectionString

string

Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos. [ Hinweis : Kontoverbindungszeichenfolge kann nur in NODE.JS Laufzeit verwendet werden. ] Beispiel für kontoverbindungszeichenfolge - beispiel für DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-Verbindungszeichenfolge - 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

Wahlfrei. Optionen zum Konfigurieren der HTTP-Pipeline.

Gibt zurück

BlobServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Nur für BlobServiceClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert einen SAS-URI (Blob Account Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas.

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

Parameter

expiresOn

Date

Wahlfrei. Der Zeitpunkt, zu dem die Signatur des freigegebenen Zugriffs ungültig wird. Wird standardmäßig eine Stunde später angegeben.

permissions
AccountSASPermissions

Gibt die Liste der Berechtigungen an, die der SAS zugeordnet werden sollen.

resourceTypes

string

Gibt die Ressourcentypen an, die der Gemeinsamen Zugriffssignatur zugeordnet sind.

options
ServiceGenerateAccountSasUrlOptions

Optionale Parameter.

Gibt zurück

string

Ein SAS-Konto-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt von dem generierten SAS-Token.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Nur für BlobServiceClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert eine Zeichenfolge zum Signieren für einen SAS-URI (Blob Account Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas.

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

Parameter

expiresOn

Date

Wahlfrei. Der Zeitpunkt, zu dem die Signatur des freigegebenen Zugriffs ungültig wird. Wird standardmäßig eine Stunde später angegeben.

permissions
AccountSASPermissions

Gibt die Liste der Berechtigungen an, die der SAS zugeordnet werden sollen.

resourceTypes

string

Gibt die Ressourcentypen an, die der Gemeinsamen Zugriffssignatur zugeordnet sind.

options
ServiceGenerateAccountSasUrlOptions

Optionale Parameter.

Gibt zurück

string

Ein SAS-Konto-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt von dem generierten SAS-Token.

getAccountInfo(ServiceGetAccountInfoOptions)

Der Vorgang "Kontoinformationen abrufen" gibt den SKU-Namen und die Kontoart für das angegebene Konto zurück. Der Vorgang "Kontoinformationen abrufen" ist in Dienstversionen ab Version 2018-03-28 verfügbar.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information.

function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>

Parameter

options
ServiceGetAccountInfoOptions

Optionen für den Service Get Account Info-Vorgang.

Gibt zurück

Promise<ServiceGetAccountInfoResponse>

Antwortdaten für den Service Get Account Info-Vorgang.

getBlobBatchClient()

Erstellt ein BlobBatchClient -Objekt zum Durchführen von Batchvorgängen.

Siehe https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch.

function getBlobBatchClient(): BlobBatchClient

Gibt zurück

BlobBatchClient

Ein neues BlobBatchClient-Objekt für diesen Dienst.

getContainerClient(string)

Erstellt ein ContainerClient--Objekt

function getContainerClient(containerName: string): ContainerClient

Parameter

containerName

string

Ein Containername

Gibt zurück

ContainerClient

Ein neues ContainerClient-Objekt für den angegebenen Containernamen.

Beispielverwendung:

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

getProperties(ServiceGetPropertiesOptions)

Ruft die Eigenschaften des Blob-Diensts eines Speicherkontos ab, einschließlich Eigenschaften für Speicheranalyse- und CORS-Regeln (Cross-Origin Resource Sharing).

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

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

Parameter

options
ServiceGetPropertiesOptions

Optionen für den Service Get Properties-Vorgang.

Gibt zurück

Promise<ServiceGetPropertiesResponse>

Antwortdaten für den Service Get Properties-Vorgang.

getStatistics(ServiceGetStatisticsOptions)

Ruft Statistiken zur Replikation für den Blob-Dienst ab. Sie ist nur für den sekundären Standortendpunkt verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Speicherkonto aktiviert ist.

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

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

Parameter

options
ServiceGetStatisticsOptions

Optionen für den Dienst get Statistics-Vorgang.

Gibt zurück

Promise<ServiceGetStatisticsResponse>

Antwortdaten für den Service Get Statistics-Vorgang.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

NUR VERFÜGBAR BEI VERWENDUNG DER BEARERTOKENAUTHENTIFIZIERUNG (TokenCredential).

Ruft einen Benutzerdelegierungsschlüssel für den BLOB-Dienst ab. Dies ist nur ein gültiger Vorgang, wenn die Bearertokenauthentifizierung verwendet wird.

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

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

Parameter

startsOn

Date

Die Startzeit für die Benutzerdelegierung SAS. Muss innerhalb von 7 Tagen nach der aktuellen Uhrzeit sein

expiresOn

Date

Die Endzeit für die Sas der Benutzerdelegierung. Muss innerhalb von 7 Tagen nach der aktuellen Uhrzeit sein

options
ServiceGetUserDelegationKeyOptions

Gibt zurück

Promise<ServiceGetUserDelegationKeyResponse>

listContainers(ServiceListContainersOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Container unter dem angegebenen Konto auflisten zu können.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Container auf Seiten auflisten zu können.

Beispiel mit for await Syntax:

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

Beispiel für die Verwendung von 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();
}

Beispiel für die Verwendung von 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}`);
    }
  }
}

Beispiel für das Paging mit einer Markierung:

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>

Parameter

options
ServiceListContainersOptions

Optionen zum Auflisten von Containern.

Gibt zurück

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>

Ein asyncIterableIterator, der paging unterstützt.

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Legt Eigenschaften für den Blob-Dienstendpunkt eines Speicherkontos fest, einschließlich Eigenschaften für Storage Analytics, CORS -Regeln (Cross-Origin Resource Sharing) und Einstellungen für vorläufiges Löschen.

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

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

Parameter

properties
BlobServiceProperties
options
ServiceSetPropertiesOptions

Optionen für den Dienstsatz-Eigenschaftenvorgang.

Gibt zurück

Promise<ServiceSetPropertiesResponse>

Antwortdaten für den Dienstsatz-Eigenschaftenvorgang.

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Stellen Sie einen zuvor gelöschten BLOB-Container wieder her. Diese API ist nur funktionsfähig, wenn container Soft Delete für das dem Container zugeordnete Speicherkonto aktiviert ist.

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

Parameter

deletedContainerName

string

Name des zuvor gelöschten Containers.

deletedContainerVersion

string

Version des zuvor gelöschten Containers, der verwendet wird, um den gelöschten Container eindeutig zu identifizieren.

options
ServiceUndeleteContainerOptions

Optionen zum Konfigurieren des Containerwiederherstellungsvorgangs.

Gibt zurück

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

Antwort auf das Löschen von Containern.