BlobServiceClient class
Ein BlobServiceClient stellt einen Client für den Azure Storage-Blobdienst dar, mit dem Sie Blobcontainer bearbeiten können.
- Extends
-
StorageClient
Konstruktoren
Blob |
Erstellt eine Instanz von BlobServiceClient. |
Blob |
Erstellt eine Instanz von BlobServiceClient. |
Geerbte Eigenschaften
account |
|
credential | Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem |
url | Codierter URL-Zeichenfolgenwert. |
Methoden
create |
Erstellen Sie einen Blobcontainer. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-container. |
delete |
Löscht einen Blobcontainer. |
find |
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
Beispiel für die Verwendung von
Beispiel für die Verwendung von
Beispiel für die Verwendung von Paging mit einem Marker:
|
from |
Erstellt eine Instanz von BlobServiceClient aus der Verbindungszeichenfolge. |
generate |
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. |
get |
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. |
get |
Erstellt ein BlobBatchClient-Objekt zum Ausführen von Batchvorgängen. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch. |
get |
Erstellt ein ContainerClient-Objekt |
get |
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. |
get |
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. |
get |
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. |
list |
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
Beispiel für die Verwendung von
Beispiel für die Verwendung von
Beispiel für die Verwendung von Paging mit einem Marker:
|
set |
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. |
undelete |
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. |
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-Blobdienst zeigt, z. B. "https://myaccount.blob.core.windows.net"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.blob.core.windows.net?sasString".
- pipeline
- PipelineLike
Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen, oder stellen Sie eine benutzerdefinierte Pipeline bereit.
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-Blobdienst zeigt, z. B. "https://myaccount.blob.core.windows.net"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.blob.core.windows.net?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
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.
- options
- StoragePipelineOptions
Optional. 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
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
url
Codierter URL-Zeichenfolgenwert.
url: string
Eigenschaftswert
string
Geerbt von StorageClient.url
Details zur Methode
createContainer(string, ContainerCreateOptions)
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
- containerName
-
string
Name des zu erstellenden Containers.
- options
- ContainerCreateOptions
Optionen zum Konfigurieren des Vorgangs "Containererstellung".
Gibt zurück
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Antwort auf die Containererstellung und den entsprechenden Containerclient.
deleteContainer(string, ContainerDeleteMethodOptions)
Löscht einen Blobcontainer.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
Parameter
- containerName
-
string
Name des zu löschenden Containers.
- options
- ContainerDeleteMethodOptions
Optionen zum Konfigurieren des Vorgangs zum Löschen von Containern.
Gibt zurück
Promise<ContainerDeleteResponse>
Containerlöschungsantwort.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
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
- tagFilterSqlExpression
-
string
Der where-Parameter ermöglicht es dem Aufrufer, Blobs abzufragen, deren Tags mit einem bestimmten Ausdruck übereinstimmen. 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 where-Abfrageparameters. Im Blobdienst wird jedoch nur eine Teilmenge der OData-Filtersyntax unterstützt.
- options
- ServiceFindBlobByTagsOptions
Optionen zum Suchen von Blobs nach Tags.
Gibt zurück
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: Die Kontoverbindungszeichenfolge kann nur in NODE.JS Runtime verwendet werden. ] Beispiel für eine Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Beispiel für eine 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
Optional. Optionen zum Konfigurieren der HTTP-Pipeline.
Gibt zurück
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
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
- expiresOn
-
Date
Optional. Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Wenn nicht angegeben, wird standardmäßig eine Stunde später festgelegt.
- permissions
- AccountSASPermissions
Gibt die Liste der Berechtigungen an, die der SAS zugeordnet werden sollen.
- resourceTypes
-
string
Gibt die Ressourcentypen an, die der Shared Access Signature zugeordnet sind.
Optionale Parameter.
Gibt zurück
string
Ein KONTO-SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt vom 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 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
- options
- ServiceGetAccountInfoOptions
Optionen für den Vorgang "Dienstkontoinformationen abrufen".
Gibt zurück
Promise<ServiceGetAccountInfoResponse>
Antwortdaten für den Vorgang "Dienstkontoinformationen abrufen".
getBlobBatchClient()
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.
getContainerClient(string)
Erstellt ein ContainerClient-Objekt
function getContainerClient(containerName: string): ContainerClient
Parameter
- containerName
-
string
Ein Containername
Gibt zurück
Ein neues ContainerClient-Objekt für den angegebenen Containernamen.
Beispielverwendung:
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
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
- options
- ServiceGetPropertiesOptions
Optionen für den Vorgang Zum Abrufen von Eigenschaften des Diensts.
Gibt zurück
Promise<ServiceGetPropertiesResponse>
Antwortdaten für den Vorgang "Service Get Properties".
getStatistics(ServiceGetStatisticsOptions)
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
- options
- ServiceGetStatisticsOptions
Optionen für den Dienstvorgang "Statistiken abrufen".
Gibt zurück
Promise<ServiceGetStatisticsResponse>
Antwortdaten für den Dienstvorgang "Statistik abrufen".
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
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
- startsOn
-
Date
Die Startzeit für die SAS für die Benutzerdelegierung. Muss innerhalb von 7 Tagen nach dem aktuellen Zeitpunkt sein.
- expiresOn
-
Date
Die Endzeit für die SAS für die Benutzerdelegierung. Muss innerhalb von 7 Tagen nach dem aktuellen Zeitpunkt sein.
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 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
- options
- ServiceListContainersOptions
Optionen zum Auflisten von Containern.
Gibt zurück
Ein asyncIterableIterator, der Paging unterstützt.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
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
- properties
- BlobServiceProperties
- options
- ServiceSetPropertiesOptions
Optionen für den Vorgang "Eigenschaften des Diensts festlegen".
Gibt zurück
Promise<ServiceSetPropertiesResponse>
Antwortdaten für den Vorgang Dienstsatzeigenschaften.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)
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
- deletedContainerName
-
string
Name des zuvor gelöschten Containers.
- deletedContainerVersion
-
string
Version des zuvor gelöschten Containers, die 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 }>
Containerlöschungsantwort.