Udostępnij za pośrednictwem

BlobServiceClient class

  • Odwołanie
Pakiet:
@azure/storage-blob

Obiekt BlobServiceClient reprezentuje klienta usługi Azure Storage Blob Service, co umożliwia manipulowanie kontenerami obiektów blob.

Rozszerzenie
StorageClient

Konstruktory

BlobServiceClient(string, PipelineLike)

Tworzy wystąpienie obiektu BlobServiceClient.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Tworzy wystąpienie obiektu BlobServiceClient.

Właściwości

accountName
credential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żą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.
url

Wartość zakodowanego ciągu adresu URL.

Metody

createContainer(string, ContainerCreateOptions)

Utwórz kontener obiektów blob.
deleteContainer(string, ContainerDeleteMethodOptions)

Usuwa kontener obiektów blob.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Zwraca iterator asynchroniczny, aby znaleźć wszystkie obiekty blob z określonym tagiem na określonym koncie. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę obiektów blob na stronach.
fromConnectionString(string, StoragePipelineOptions)

Tworzy wystąpienie obiektu BlobServiceClient na podstawie parametrów połączenia.
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 obiektu blob na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.
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.
getBlobBatchClient()

Tworzy obiekt BlobBatchClient do przeprowadzania operacji wsadowych.
getContainerClient(string)

Tworzy obiekt <xref:ContainerClient>
getProperties(ServiceGetPropertiesOptions)

Pobiera właściwości usługi blob konta magazynu, w tym właściwości reguł analizy magazynu i mechanizmu CORS (współużytkowanie zasobów między źródłami).
getStatistics(ServiceGetStatisticsOptions)

Pobiera statystyki związane z replikacją dla usługi Blob Service. Jest on dostępny tylko w punkcie końcowym lokalizacji dodatkowej, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.
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.
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 składni for await:

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

Przykład użycia 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 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}`);
  }
}
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Ustawia właściwości punktu końcowego usługi Blob Service konta magazynu, w tym właściwości dla reguł analizy magazynu, mechanizmu CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Przywróć wcześniej usunięty kontener 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ę Azure Storage Blob Service, taką jak "https://myaccount.blob.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "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ę Azure Storage Blob Service, taką jak "https://myaccount.blob.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żą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

Fakultatywny. Opcje konfigurowania potoku HTTP.

Przykład użycia elementu DefaultAzureCredential z @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

accountName 

accountName: string

Wartość właściwości

string

credential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żą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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

url

Wartość zakodowanego ciągu adresu URL.

url: string

Wartość właściwości

string

Szczegóły metody

createContainer(string, ContainerCreateOptions)

Utwórz kontener obiektów blob.

function createContainer(containerName: string, options?: ContainerCreateOptions)

Parametry

containerName

string

Nazwa kontenera do utworzenia.

options
ContainerCreateOptions

Opcje konfigurowania operacji tworzenia kontenera.

Zwraca

Promise<Object>

Odpowiedź tworzenia kontenera i odpowiedni klient kontenera.

deleteContainer(string, ContainerDeleteMethodOptions)

Usuwa kontener obiektów blob.

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions)

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, aby znaleźć wszystkie obiekty blob z określonym tagiem na określonym koncie. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę obiektów blob na stronach.

function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions)

Parametry

tagFilterSqlExpression

string

Parametr where umożliwia obiektowi wywołującym wykonywanie zapytań o obiekty blob, których tagi pasują do danego wyrażenia. Podane wyrażenie musi mieć wartość true, aby obiekt blob był zwracany w wynikach. Reguła składni filtru[OData - ABNF] definiuje formalną gramatykę dla wartości parametru where query; jednak tylko podzbiór składni filtru OData jest obsługiwany w usłudze Blob Service.

options
ServiceFindBlobByTagsOptions

Opcje znajdowania obiektów blob według tagów.

Zwraca

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>

fromConnectionString(string, StoragePipelineOptions)

Tworzy wystąpienie obiektu BlobServiceClient na podstawie parametrów połączenia.

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

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 — przykład parametrów połączenia sygnatury dostępu współdzielonego DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net — 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

Fakultatywny. Opcje konfigurowania potoku HTTP.

Zwraca

BlobServiceClient

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 obiektu blob na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

Parametry

expiresOn

Date

Fakultatywny. Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wartość domyślna na godzinę 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.

options
ServiceGenerateAccountSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego konta składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

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.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

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.

function getBlobBatchClient()

Zwraca

BlobBatchClient

Nowy obiekt BlobBatchClient dla tej usługi.

getContainerClient(string)

Tworzy obiekt <xref:ContainerClient>

function getContainerClient(containerName: string)

Parametry

containerName

string

Nazwa kontenera

Zwraca

ContainerClient

Nowy obiekt ContainerClient dla podanej nazwy kontenera.

Przykładowe użycie:

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

getProperties(ServiceGetPropertiesOptions)

Pobiera właściwości usługi blob konta magazynu, w tym właściwości reguł analizy magazynu i mechanizmu CORS (współużytkowanie zasobów między źródłami).

function getProperties(options?: ServiceGetPropertiesOptions)

Parametry

options
ServiceGetPropertiesOptions

Opcje operacji Pobierz właściwości usługi.

Zwraca

Promise<ServiceGetPropertiesResponse>

Dane odpowiedzi dla operacji Pobieranie właściwości usługi.

getStatistics(ServiceGetStatisticsOptions)

Pobiera statystyki związane z replikacją dla usługi Blob Service. Jest on dostępny tylko w punkcie końcowym lokalizacji dodatkowej, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.

function getStatistics(options?: ServiceGetStatisticsOptions)

Parametry

options
ServiceGetStatisticsOptions

Opcje operacji Uzyskiwanie statystyk usługi.

Zwraca

Promise<ServiceGetStatisticsResponse>

Dane odpowiedzi dla operacji Uzyskiwanie 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.

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions)

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

options
ServiceGetUserDelegationKeyOptions

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 składni for await:

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

Przykład użycia 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 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)

Parametry

options
ServiceListContainersOptions

Opcje wyświetlania listy kontenerów.

Zwraca

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

AsyncIterableIterator, który obsługuje stronicowanie.

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Ustawia właściwości punktu końcowego usługi Blob Service konta magazynu, w tym właściwości dla reguł analizy magazynu, mechanizmu CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions)

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)

Przywróć wcześniej usunięty kontener 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)

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<Object>

Odpowiedź na usunięcie kontenera.