Sdílet prostřednictvím

BlobServiceClient class

  • Reference
Balíček:
@azure/storage-blob

Objekt BlobServiceClient představuje klienta služby Azure Storage Blob Service, který umožňuje manipulovat s kontejnery objektů blob.

Extends
StorageClient

Konstruktory

BlobServiceClient(string, PipelineLike)

Vytvoří instanci BlobServiceClient.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří instanci BlobServiceClient.

Vlastnosti

accountName
credential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.
url

Zakódovaná hodnota řetězce adresy URL.

Metody

createContainer(string, ContainerCreateOptions)

Vytvořte kontejner objektů blob.
deleteContainer(string, ContainerDeleteMethodOptions)

Odstraní kontejner objektů blob.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Vrátí asynchronní iterátor pro vyhledání všech objektů blob se zadanou značkou v zadaném účtu. .byPage() vrátí asynchronní iterovatelný iterátor pro výpis objektů blob na stránkách.
fromConnectionString(string, StoragePipelineOptions)

Vytvoří instanci BlobServiceClient z připojovacího řetězce.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

K dispozici pouze pro Objekt BlobServiceClient vytvořený s přihlašovacími údaji sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) účtu blob na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.
getAccountInfo(ServiceGetAccountInfoOptions)

Operace Získání informací o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služeb od verze 2018-03-28.
getBlobBatchClient()

Vytvoří objekt BlobBatchClient pro provádění dávkových operací.
getContainerClient(string)

Vytvoří <xref:ContainerClient> objekt.
getProperties(ServiceGetPropertiesOptions)

Získá vlastnosti služby Blob service účtu úložiště, včetně vlastností pro Analýza úložiště a PRAVIDLA CORS (Sdílení prostředků mezi zdroji).
getStatistics(ServiceGetStatisticsOptions)

Načte statistiky související s replikací pro službu Blob Service. Je k dispozici pouze v sekundárním koncovém bodu umístění, pokud je pro účet úložiště povolená geograficky redundantní replikace jen pro čtení.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

K DISPOZICI POUZE PŘI POUŽITÍ OVĚŘOVÁNÍ NOSNÝ TOKEN (TokenCredential). Načte klíč delegování uživatele pro službu Blob Service. Jedná se pouze o platnou operaci při použití ověřování nosný token.
listContainers(ServiceListContainersOptions)

Vrátí asynchronní iterátor pro výpis všech kontejnerů v rámci zadaného účtu. .byPage() vrátí asynchronní iterátor pro výpis kontejnerů na stránkách.

Příklad s využitím for await syntaxe:

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

Příklad použití 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();
}

Příklad použití 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}`);
    }
  }
}

Příklad použití stránkování se značkou:

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)

Nastaví vlastnosti pro koncový bod služby Blob Service účtu úložiště, včetně vlastností pro Analýza úložiště, pravidel CORS (Sdílení prostředků mezi zdroji) a nastavení obnovitelného odstranění.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Obnovení dříve odstraněného kontejneru objektů blob Toto rozhraní API je funkční jenom v případě, že je pro účet úložiště přidruženého ke kontejneru povolené obnovitelné odstranění kontejneru.

Podrobnosti konstruktoru

BlobServiceClient(string, PipelineLike)

Vytvoří instanci BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parametry

url

string

Řetězec klienta odkazující na službu objektů blob služby Azure Storage, například "https://myaccount.blob.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Voláním příkazu newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.

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

Vytvoří instanci BlobServiceClient.

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

Parametry

url

string

Řetězec klienta odkazující na službu objektů blob služby Azure Storage, například "https://myaccount.blob.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

options
StoragePipelineOptions

Nepovinný parametr. Možnosti konfigurace kanálu HTTP

Příklad použití DefaultAzureCredential z @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Příklad použití názvu nebo klíče účtu:

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

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

Podrobnosti vlastnosti

accountName 

accountName: string

Hodnota vlastnosti

string

credential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

url

Zakódovaná hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

Podrobnosti metody

createContainer(string, ContainerCreateOptions)

Vytvořte kontejner objektů blob.

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

Parametry

containerName

string

Název kontejneru, který chcete vytvořit.

options
ContainerCreateOptions

Možnosti konfigurace operace vytvoření kontejneru

Návraty

Promise<Object>

Odpověď na vytvoření kontejneru a odpovídající klient kontejneru

deleteContainer(string, ContainerDeleteMethodOptions)

Odstraní kontejner objektů blob.

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

Parametry

containerName

string

Název kontejneru, který chcete odstranit.

options
ContainerDeleteMethodOptions

Možnosti konfigurace operace odstranění kontejneru

Návraty

Promise<ContainerDeleteResponse>

Odpověď na odstranění kontejneru

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Vrátí asynchronní iterátor pro vyhledání všech objektů blob se zadanou značkou v zadaném účtu. .byPage() vrátí asynchronní iterovatelný iterátor pro výpis objektů blob na stránkách.

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

Parametry

tagFilterSqlExpression

string

Parametr where umožňuje volajícímu dotazovat se na objekty blob, jejichž značky odpovídají danému výrazu. Aby se objekt blob vrátil ve výsledcích, musí být daný výraz vyhodnocen jako true. Pravidlo syntaxe filtru [OData – ABNF] definuje formální gramatiku pro hodnotu parametru dotazu where; Ve službě Blob Je však podporována pouze podmnožina syntaxe filtru OData.

options
ServiceFindBlobByTagsOptions

Možnosti hledání objektů blob podle značek

Návraty

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>

fromConnectionString(string, StoragePipelineOptions)

Vytvoří instanci BlobServiceClient z připojovacího řetězce.

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

Parametry

connectionString

string

Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure. [ Poznámka – Připojovací řetězec účtu se dá použít jenom v modulu runtime NODE.JS. ] Příklad připojovacího řetězce účtu –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Příklad připojovacího řetězce SAS – 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

Nepovinný parametr. Možnosti konfigurace kanálu HTTP

Návraty

BlobServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

K dispozici pouze pro Objekt BlobServiceClient vytvořený s přihlašovacími údaji sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) účtu blob na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

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

Parametry

expiresOn

Date

Nepovinný parametr. Čas, kdy se sdílený přístupový podpis stane neplatným. Výchozí hodnota je o hodinu později, pokud není k dispozici.

permissions
AccountSASPermissions

Určuje seznam oprávnění, která se mají přidružit k SAS.

resourceTypes

string

Určuje typy prostředků přidružené ke sdílenému přístupovém podpisu.

options
ServiceGenerateAccountSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS účtu, který se skládá z identifikátoru URI prostředku reprezentovaného tímto klientem, následovaného vygenerovaným tokenem SAS.

getAccountInfo(ServiceGetAccountInfoOptions)

Operace Získání informací o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služeb od verze 2018-03-28.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

Parametry

options
ServiceGetAccountInfoOptions

Možnosti operace Získání informací o účtu služby

Návraty

Promise<ServiceGetAccountInfoResponse>

Data odpovědi pro operaci Service Get Account Info

getBlobBatchClient()

Vytvoří objekt BlobBatchClient pro provádění dávkových operací.

function getBlobBatchClient()

Návraty

BlobBatchClient

Nový objekt BlobBatchClient pro tuto službu.

getContainerClient(string)

Vytvoří <xref:ContainerClient> objekt.

function getContainerClient(containerName: string)

Parametry

containerName

string

Název kontejneru

Návraty

ContainerClient

Nový objekt ContainerClient pro daný název kontejneru.

Příklad použití:

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

getProperties(ServiceGetPropertiesOptions)

Získá vlastnosti služby Blob service účtu úložiště, včetně vlastností pro Analýza úložiště a PRAVIDLA CORS (Sdílení prostředků mezi zdroji).

function getProperties(options?: ServiceGetPropertiesOptions)

Parametry

options
ServiceGetPropertiesOptions

Možnosti operace Získání vlastností služby

Návraty

Promise<ServiceGetPropertiesResponse>

Data odpovědi pro operaci Service Get Properties

getStatistics(ServiceGetStatisticsOptions)

Načte statistiky související s replikací pro službu Blob Service. Je k dispozici pouze v sekundárním koncovém bodu umístění, pokud je pro účet úložiště povolená geograficky redundantní replikace jen pro čtení.

function getStatistics(options?: ServiceGetStatisticsOptions)

Parametry

options
ServiceGetStatisticsOptions

Možnosti operace Získání statistiky služby

Návraty

Promise<ServiceGetStatisticsResponse>

Data odpovědi pro operaci Service Get Statistics

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

K DISPOZICI POUZE PŘI POUŽITÍ OVĚŘOVÁNÍ NOSNÝ TOKEN (TokenCredential). Načte klíč delegování uživatele pro službu Blob Service. Jedná se pouze o platnou operaci při použití ověřování nosný token.

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

Parametry

startsOn

Date

Počáteční čas SAS delegování uživatele. Musí být do 7 dnů od aktuálního času.

expiresOn

Date

Koncový čas SAS delegování uživatele. Musí být do 7 dnů od aktuálního času.

options
ServiceGetUserDelegationKeyOptions

Návraty

Promise<ServiceGetUserDelegationKeyResponse>

listContainers(ServiceListContainersOptions)

Vrátí asynchronní iterátor pro výpis všech kontejnerů v rámci zadaného účtu. .byPage() vrátí asynchronní iterátor pro výpis kontejnerů na stránkách.

Příklad s využitím for await syntaxe:

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

Příklad použití 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();
}

Příklad použití 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}`);
    }
  }
}

Příklad použití stránkování se značkou:

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

Možnosti výpisu kontejnerů

Návraty

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

AsyncIterableIterator, který podporuje stránkování.

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Nastaví vlastnosti pro koncový bod služby Blob Service účtu úložiště, včetně vlastností pro Analýza úložiště, pravidel CORS (Sdílení prostředků mezi zdroji) a nastavení obnovitelného odstranění.

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

Parametry

properties
BlobServiceProperties
options
ServiceSetPropertiesOptions

Možnosti operace Vlastnosti sady služeb.

Návraty

Promise<ServiceSetPropertiesResponse>

Data odpovědi pro operaci Vlastnosti sady služeb.

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Obnovení dříve odstraněného kontejneru objektů blob Toto rozhraní API je funkční jenom v případě, že je pro účet úložiště přidruženého ke kontejneru povolené obnovitelné odstranění kontejneru.

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions)

Parametry

deletedContainerName

string

Název dříve odstraněného kontejneru.

deletedContainerVersion

string

Verze dříve odstraněného kontejneru, která slouží k jednoznačné identifikaci odstraněného kontejneru.

options
ServiceUndeleteContainerOptions

Možnosti konfigurace operace obnovení kontejneru

Návraty

Promise<Object>

Odpověď na odstranění kontejneru