BlobServiceClient class
Obiekt BlobServiceClient reprezentuje klienta usługi Azure Storage Blob Service, co umożliwia manipulowanie kontenerami obiektów blob.
- Extends
-
StorageClient
Konstruktory
Blob |
Tworzy wystąpienie obiektu BlobServiceClient. |
Blob |
Tworzy wystąpienie obiektu BlobServiceClient. |
Właściwości dziedziczone
account |
|
credential | Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w |
url | Zakodowana wartość ciągu adresu URL. |
Metody
create |
Tworzenie kontenera obiektów blob. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
delete |
Usuwa kontener obiektów blob. |
find |
Zwraca iterator asynchroniczny w celu znalezienia wszystkich obiektów blob z określonym tagiem w ramach określonego konta. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę obiektów blob na stronach. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties Przykład użycia
Przykład użycia polecenia
Przykład użycia polecenia
Przykład użycia stronicowania ze znacznikiem:
|
from |
Tworzy wystąpienie obiektu BlobServiceClient na podstawie parametrów połączenia. |
generate |
Dostępny tylko dla obiektu BlobServiceClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) konta obiektów blob na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przy użyciu poświadczeń klucza współużytkowanego klienta. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
get |
Operacja Pobierz informacje o koncie zwraca nazwę jednostki SKU i rodzaj konta dla określonego konta. Operacja Uzyskiwanie informacji o koncie jest dostępna w wersjach usługi, począwszy od wersji 2018-03-28. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Tworzy obiekt BlobBatchClient do przeprowadzania operacji wsadowych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
get |
Tworzy obiekt ContainerClient |
get |
Pobiera właściwości usługi Blob service konta magazynu, w tym właściwości reguł analityka magazynu i CORS (współużytkowanie zasobów między źródłami). Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
Pobiera statystyki związane z replikacją dla usługi Blob Service. Jest ona dostępna tylko w punkcie końcowym lokalizacji pomocniczej, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa z dostępem do odczytu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats |
get |
DOSTĘPNE TYLKO W PRZYPADKU KORZYSTANIA Z UWIERZYTELNIANIA TOKENU ELEMENTU NOŚNEGO (TokenCredential). Pobiera klucz delegowania użytkownika dla usługi Blob Service. Jest to tylko prawidłowa operacja podczas korzystania z uwierzytelniania tokenu elementu nośnego. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key |
list |
Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich kontenerów w ramach określonego konta. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę kontenerów na stronach. Przykład użycia
Przykład użycia polecenia
Przykład użycia polecenia
Przykład użycia stronicowania ze znacznikiem:
|
set |
Ustawia właściwości punktu końcowego usługi blob konta magazynu, w tym właściwości dla analityka magazynu, reguł CORS (współużytkowanie zasobów między źródłami) i ustawień usuwania nietrwałego. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
Przywracanie wcześniej usuniętego kontenera obiektów blob. Ten interfejs API działa tylko wtedy, gdy dla konta magazynu skojarzonego z kontenerem jest włączone usuwanie nietrwałe kontenera. |
Szczegóły konstruktora
BlobServiceClient(string, PipelineLike)
Tworzy wystąpienie obiektu BlobServiceClient.
new BlobServiceClient(url: string, pipeline: PipelineLike)
Parametry
- url
-
string
Ciąg klienta wskazujący usługę obiektów blob usługi Azure Storage, taką jak "https://myaccount.blob.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.blob.core.windows.net?sasString".
- pipeline
- PipelineLike
Wywołaj metodę newPipeline(), aby utworzyć domyślny potok, lub podaj dostosowany potok.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Tworzy wystąpienie obiektu BlobServiceClient.
new BlobServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametry
- url
-
string
Ciąg klienta wskazujący usługę obiektów blob usługi Azure Storage, taką jak "https://myaccount.blob.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.blob.core.windows.net?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity
celu uwierzytelnienia żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.
- options
- StoragePipelineOptions
Opcjonalny. Opcje konfigurowania potoku HTTP.
Przykład użycia elementu DefaultAzureCredential z elementu @azure/identity
:
const account = "<storage account name>";
const defaultAzureCredential = new DefaultAzureCredential();
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
defaultAzureCredential
);
Przykład użycia nazwy/klucza konta:
const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
sharedKeyCredential
);
Szczegóły właściwości dziedziczonej
accountName
accountName: string
Wartość właściwości
string
Dziedziczone z StorageClient.accountName
credential
Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity
celu uwierzytelnienia żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Wartość właściwości
Dziedziczone z StorageClient.credential
url
Zakodowana wartość ciągu adresu URL.
url: string
Wartość właściwości
string
Dziedziczone z StorageClient.url
Szczegóły metody
createContainer(string, ContainerCreateOptions)
Tworzenie kontenera obiektów blob.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Parametry
- containerName
-
string
Nazwa kontenera do utworzenia.
- options
- ContainerCreateOptions
Opcje konfigurowania operacji tworzenia kontenera.
Zwraca
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Odpowiedź tworzenia kontenera i odpowiedni klient kontenera.
deleteContainer(string, ContainerDeleteMethodOptions)
Usuwa kontener obiektów blob.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
Parametry
- containerName
-
string
Nazwa kontenera do usunięcia.
- options
- ContainerDeleteMethodOptions
Opcje konfigurowania operacji usuwania kontenera.
Zwraca
Promise<ContainerDeleteResponse>
Odpowiedź na usunięcie kontenera.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
Zwraca iterator asynchroniczny w celu znalezienia wszystkich obiektów blob z określonym tagiem w ramach określonego konta.
Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę obiektów blob na stronach.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
Przykład użycia for await
składni:
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
Przykład użycia polecenia 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();
}
Przykład użycia polecenia 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}`);
}
}
}
Przykład użycia stronicowania ze znacznikiem:
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>
Parametry
- tagFilterSqlExpression
-
string
Parametr where umożliwia obiektowi wywołującego wykonywanie zapytań o obiekty blob, których tagi są zgodne z danym wyrażeniem. Podane wyrażenie musi mieć wartość true, aby obiekt blob został zwrócony w wynikach. Reguła składni filtru [OData - ABNF] definiuje formalną gramatykę dla wartości parametru where query; jednak w usłudze Blob Service jest obsługiwany tylko podzbiór składni filtru OData.
- options
- ServiceFindBlobByTagsOptions
Opcje znajdowania obiektów blob według tagów.
Zwraca
fromConnectionString(string, StoragePipelineOptions)
Tworzy wystąpienie obiektu BlobServiceClient na podstawie parametrów połączenia.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
Parametry
- connectionString
-
string
Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage.
[ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Przykład parametrów połączenia sygnatury dostępu współdzielonego — 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
Opcjonalny. Opcje konfigurowania potoku HTTP.
Zwraca
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Dostępny tylko dla obiektu BlobServiceClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.
Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) konta obiektów blob na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przy użyciu poświadczeń klucza współużytkowanego klienta.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parametry
- expiresOn
-
Date
Opcjonalny. Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wartość domyślna to godzina później, jeśli nie zostanie podana.
- permissions
- AccountSASPermissions
Określa listę uprawnień do skojarzenia z sygnaturą dostępu współdzielonego.
- resourceTypes
-
string
Określa typy zasobów skojarzone z sygnaturą dostępu współdzielonego.
Parametry opcjonalne.
Zwraca
string
Identyfikator URI sygnatury dostępu współdzielonego konta składający się z identyfikatora URI zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SYGNATURy dostępu współdzielonego.
getAccountInfo(ServiceGetAccountInfoOptions)
Operacja Pobierz informacje o koncie zwraca nazwę jednostki SKU i rodzaj konta dla określonego konta. Operacja Uzyskiwanie informacji o koncie jest dostępna w wersjach usługi, począwszy od wersji 2018-03-28.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
Parametry
- options
- ServiceGetAccountInfoOptions
Opcje operacji Uzyskiwanie informacji o koncie w usłudze.
Zwraca
Promise<ServiceGetAccountInfoResponse>
Dane odpowiedzi dla operacji Uzyskiwanie informacji o koncie usługi.
getBlobBatchClient()
Tworzy obiekt BlobBatchClient do przeprowadzania operacji wsadowych.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
function getBlobBatchClient(): BlobBatchClient
Zwraca
Nowy obiekt BlobBatchClient dla tej usługi.
getContainerClient(string)
Tworzy obiekt ContainerClient
function getContainerClient(containerName: string): ContainerClient
Parametry
- containerName
-
string
Nazwa kontenera
Zwraca
Nowy obiekt ContainerClient dla danej nazwy kontenera.
Przykład użycia:
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
Pobiera właściwości usługi Blob service konta magazynu, w tym właściwości reguł analityka magazynu i CORS (współużytkowanie zasobów między źródłami).
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Parametry
- options
- ServiceGetPropertiesOptions
Opcje operacji Pobierz właściwości usługi.
Zwraca
Promise<ServiceGetPropertiesResponse>
Dane odpowiedzi dla operacji Pobierania właściwości usługi.
getStatistics(ServiceGetStatisticsOptions)
Pobiera statystyki związane z replikacją dla usługi Blob Service. Jest ona dostępna tylko w punkcie końcowym lokalizacji pomocniczej, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa z dostępem do odczytu.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>
Parametry
- options
- ServiceGetStatisticsOptions
Opcje operacji Pobierania statystyk usługi.
Zwraca
Promise<ServiceGetStatisticsResponse>
Dane odpowiedzi dla operacji Pobierania statystyk usługi.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
DOSTĘPNE TYLKO W PRZYPADKU KORZYSTANIA Z UWIERZYTELNIANIA TOKENU ELEMENTU NOŚNEGO (TokenCredential).
Pobiera klucz delegowania użytkownika dla usługi Blob Service. Jest to tylko prawidłowa operacja podczas korzystania z uwierzytelniania tokenu elementu nośnego.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Parametry
- startsOn
-
Date
Godzina rozpoczęcia sygnatury dostępu współdzielonego delegowania użytkownika. Musi być w ciągu 7 dni od bieżącego czasu
- expiresOn
-
Date
Godzina zakończenia sygnatury dostępu współdzielonego delegowania użytkownika. Musi być w ciągu 7 dni od bieżącego czasu
Zwraca
Promise<ServiceGetUserDelegationKeyResponse>
listContainers(ServiceListContainersOptions)
Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich kontenerów w ramach określonego konta.
Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę kontenerów na stronach.
Przykład użycia for await
składni:
let i = 1;
for await (const container of blobServiceClient.listContainers()) {
console.log(`Container ${i++}: ${container.name}`);
}
Przykład użycia polecenia 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();
}
Przykład użycia polecenia 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}`);
}
}
}
Przykład użycia stronicowania ze znacznikiem:
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>
Parametry
- options
- ServiceListContainersOptions
Opcje wyświetlania listy kontenerów.
Zwraca
AsyncIterableIterator, który obsługuje stronicowanie.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Ustawia właściwości punktu końcowego usługi blob konta magazynu, w tym właściwości dla analityka magazynu, reguł CORS (współużytkowanie zasobów między źródłami) i ustawień usuwania nietrwałego.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
Parametry
- properties
- BlobServiceProperties
- options
- ServiceSetPropertiesOptions
Opcje operacji Właściwości zestawu usług.
Zwraca
Promise<ServiceSetPropertiesResponse>
Dane odpowiedzi dla operacji Właściwości zestawu usług.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)
Przywracanie wcześniej usuniętego kontenera obiektów blob. Ten interfejs API działa tylko wtedy, gdy dla konta magazynu skojarzonego z kontenerem jest włączone usuwanie nietrwałe kontenera.
function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Parametry
- deletedContainerName
-
string
Nazwa wcześniej usuniętego kontenera.
- deletedContainerVersion
-
string
Wersja wcześniej usuniętego kontenera używana do unikatowego identyfikowania usuniętego kontenera.
- options
- ServiceUndeleteContainerOptions
Opcje konfigurowania operacji przywracania kontenera.
Zwraca
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Odpowiedź na usunięcie kontenera.