Sdílet prostřednictvím


BlobServiceClient class

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.

Zděděné vlastnosti

accountName
credential

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.

url

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

Metody

createContainer(string, ContainerCreateOptions)

Vytvořte kontejner objektů blob.

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

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.

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

Příklad použití for await syntaxe:

let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
  console.log(`Blob ${i++}: ${container.name}`);
}

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

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

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

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}`);
  }
}
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ý pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) účtu objektu 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.

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

getAccountInfo(ServiceGetAccountInfoOptions)

Operace Získat informace 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žby počínaje verzí 2018-03-28.

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

getBlobBatchClient()

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

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

getContainerClient(string)

Vytvoří objekt ContainerClient .

getProperties(ServiceGetPropertiesOptions)

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-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 s přístupem pro čtení.

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

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

K DISPOZICI POUZE PŘI POUŽITÍ OVĚŘOVÁNÍ NOSNÝCH 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.

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

listContainers(ServiceListContainersOptions)

Vrátí asynchronní iterátor pro výpis všech kontejnerů v zadaném účtu.

.byPage() vrátí asynchronní iterátor pro výpis kontejnerů na stránkách.

Příklad použití 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í.

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

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ý 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 zděděných vlastností

accountName

accountName: string

Hodnota vlastnosti

string

Zděděno z StorageClient.accountName

credential

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

Zděděno z StorageClient.credential

url

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

url: string

Hodnota vlastnosti

string

Zděděno z StorageClient.url

Podrobnosti metody

createContainer(string, ContainerCreateOptions)

Vytvořte kontejner objektů blob.

Viz 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

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

options
ContainerCreateOptions

Možnosti konfigurace operace vytvoření kontejneru

Návraty

Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>

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

deleteContainer(string, ContainerDeleteMethodOptions)

Odstraní kontejner objektů blob.

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

Parametry

containerName

string

Název kontejneru, který chcete odstranit.

options
ContainerDeleteMethodOptions

Možnosti konfigurace operace odstranění kontejneru

Návraty

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.

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

Příklad použití for await syntaxe:

let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
  console.log(`Blob ${i++}: ${container.name}`);
}

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

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

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

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žň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

fromConnectionString(string, StoragePipelineOptions)

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

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

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

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

K dispozici pouze pro Objekt BlobServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) účtu objektu 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.

Viz 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

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 sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následně z vygenerovaného tokenu SAS.

getAccountInfo(ServiceGetAccountInfoOptions)

Operace Získat informace 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žby počínaje verzí 2018-03-28.

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

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

Parametry

options
ServiceGetAccountInfoOptions

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

Návraty

Data odpovědí pro operaci Získání informací o účtu služby

getBlobBatchClient()

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

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

function getBlobBatchClient(): BlobBatchClient

Návraty

Nový objekt BlobBatchClient pro tuto službu.

getContainerClient(string)

Vytvoří objekt ContainerClient .

function getContainerClient(containerName: string): ContainerClient

Parametry

containerName

string

Název kontejneru

Návraty

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 pravidla Analýza úložiště a CORS (Sdílení prostředků mezi zdroji).

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

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

Parametry

options
ServiceGetPropertiesOptions

Možnosti operace Service Get Properties

Návraty

Data odpovědí 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 s přístupem pro čtení.

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

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

Parametry

options
ServiceGetStatisticsOptions

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

Návraty

Data odpovědí pro operaci Service Get Statistics

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

K DISPOZICI POUZE PŘI POUŽITÍ OVĚŘOVÁNÍ NOSNÝCH 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.

Viz 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

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.

Návraty

listContainers(ServiceListContainersOptions)

Vrátí asynchronní iterátor pro výpis všech kontejnerů v zadaném účtu.

.byPage() vrátí asynchronní iterátor pro výpis kontejnerů na stránkách.

Příklad použití 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): PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>

Parametry

options
ServiceListContainersOptions

Možnosti pro výpis kontejnerů

Návraty

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í.

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

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

Parametry

options
ServiceSetPropertiesOptions

Možnosti operace Vlastnosti sady služeb

Návraty

Data odpovědí 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ý ke kontejneru povolené obnovitelné odstranění kontejneru.

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

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<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>

Odpověď na odstranění kontejneru