BlobServiceClient class

Erstellt eine Instanz von BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parameter

Erstellt eine Instanz von BlobServiceClient.

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

Parameter

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

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

Eigenschaftswert

Geerbt von StorageClient.accountName

Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

Geerbt von StorageClient.credential

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

Geerbt von StorageClient.url

Erstellen Sie einen Blobcontainer.

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

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

Parameter

Gibt zurück

Antwort auf die Containererstellung und den entsprechenden Containerclient.

Löscht einen Blobcontainer.

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

Parameter

Gibt zurück

Containerlöschungsantwort.

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

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

Siehe https://docs.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 die Verwendung von Paging mit einem Marker:

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

Gibt zurück

Erstellt eine Instanz von BlobServiceClient aus der Verbindungszeichenfolge.

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

Parameter

Gibt zurück

Nur verfügbar für BlobServiceClient, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde.

Generiert einen SAS-URI (Shared Access Signature) eines Blobkontos basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

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

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

Parameter

Gibt zurück

Ein KONTO-SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt vom generierten SAS-Token.

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

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

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang "Dienstkontoinformationen abrufen".

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

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

function getBlobBatchClient(): BlobBatchClient

Gibt zurück

Ein neues BlobBatchClient-Objekt für diesen Dienst.

Erstellt ein ContainerClient-Objekt

function getContainerClient(containerName: string): ContainerClient

Parameter

Gibt zurück

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

Beispielverwendung:

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

Ruft die Eigenschaften des Blobdiensts eines Speicherkontos ab, einschließlich der Eigenschaften für Storage Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

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

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang "Service Get Properties".

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

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

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

Parameter

Gibt zurück

Antwortdaten für den Dienstvorgang "Statistik abrufen".

NUR VERFÜGBAR, WENN BEARERTOKENAUTHENTIFIZIERUNG (TokenCredential) VERWENDET WIRD.

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

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

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

Parameter

Gibt zurück

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

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Container in 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 die Verwendung von Paging mit einem Marker:

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

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

Legt Eigenschaften für den Blobdienstendpunkt 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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties.

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang Dienstsatzeigenschaften.

Stellen Sie einen zuvor gelöschten Blobcontainer wieder her. Diese API ist nur funktionsfähig, wenn das vorläufige Löschen von Containern für das Speicherkonto aktiviert ist, das dem Container zugeordnet ist.

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

Parameter

Gibt zurück

Containerlöschungsantwort.