BlobServiceClient class

Vytvoří instanci BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parametry

Vytvoří instanci BlobServiceClient.

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

Parametry

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

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

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

accountName: string

Hodnota vlastnosti

Zděděno z StorageClient.accountName

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

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

url: string

Hodnota vlastnosti

Zděděno z StorageClient.url

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

Návraty

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

Odstraní kontejner objektů blob.

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

Parametry

Návraty

Odpověď na odstranění kontejneru

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

Návraty

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

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

Parametry

Návraty

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

Návraty

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.

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

Návraty

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

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.

Vytvoří objekt ContainerClient .

function getContainerClient(containerName: string): ContainerClient

Parametry

Návraty

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

Příklad použití:

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

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

Návraty

Data odpovědí pro operaci Service Get Properties

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

Návraty

Data odpovědí pro operaci Service Get Statistics

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

Návraty

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

Návraty

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

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

Návraty

Data odpovědí pro operaci Vlastnosti sady služeb.

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

Návraty

Odpověď na odstranění kontejneru