BlobServiceClient class

Skapar en instans av BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parametrar

Skapar en instans av BlobServiceClient.

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

Parametrar

import { DefaultAzureCredential } from "@azure/identity";
import { BlobServiceClient } from "@azure/storage-blob";

// Enter your storage account name
const account = "<account>";
const defaultAzureCredential = new DefaultAzureCredential();

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

import { StorageSharedKeyCredential, BlobServiceClient } from "@azure/storage-blob";

const account = "<account>";
const accountKey = "<accountkey>";

// Use StorageSharedKeyCredential with storage account and account key
// StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  sharedKeyCredential,
);

accountName: string

Egenskapsvärde

ärvd från StorageClient.accountName

Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Egenskapsvärde

ärvd från StorageClient.credential

Kodat URL-strängvärde.

url: string

Egenskapsvärde

ärvd från StorageClient.url

Skapa en blobcontainer.

Se https://free.blessedness.top/rest/api/storageservices/create-container

function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>

Parametrar

Returer

Svar på skapande av container och motsvarande containerklient.

Tar bort en blobcontainer.

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

Parametrar

Returer

Svar på borttagning av containrar.

Returnerar en iterbar iterator för asynkronisering för att hitta alla blobar med angiven tagg under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkront för att visa blobarna på sidor.

Se https://free.blessedness.top/rest/api/storageservices/get-blob-service-properties

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

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

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

// Use iter.next() to iterate the blobs
i = 1;
const iter = blobServiceClient.findBlobsByTags("tagkey='tagvalue'");
let { value, done } = await iter.next();
while (!done) {
  console.log(`Blob ${i++}: ${value.name}`);
  ({ value, done } = await iter.next());
}

// Use byPage() to iterate the blobs
i = 1;
for await (const page of blobServiceClient
  .findBlobsByTags("tagkey='tagvalue'")
  .byPage({ maxPageSize: 20 })) {
  for (const blob of page.blobs) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

// Use paging with a marker
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>

Parametrar

Returer

Skapar en instans av BlobServiceClient från anslutningssträngen.

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

Parametrar

Returer

Endast tillgängligt för BlobServiceClient som skapats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Signatur för delad åtkomst) för blobkonto baserat på klientegenskaperna och parametrarna som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://free.blessedness.top/rest/api/storageservices/create-account-sas

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

Parametrar

Returer

En SAS-URI för kontot som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Endast tillgängligt för BlobServiceClient som skapats med en delad nyckelautentiseringsuppgift.

Genererar sträng för att signera för en SAS-URI (Signatur för delad åtkomst) för blobkonto baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://free.blessedness.top/rest/api/storageservices/create-account-sas

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

Parametrar

Returer

En SAS-URI för kontot som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Åtgärden Hämta kontoinformation returnerar sku-namnet och kontotyp för det angivna kontot. Åtgärden Hämta kontoinformation är tillgänglig i tjänstversioner från och med version 2018-03-28.

Se https://free.blessedness.top/rest/api/storageservices/get-account-information

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

Parametrar

Returer

Svarsdata för åtgärden Hämta kontoinformation för tjänsten.

Skapar ett BlobBatchClient-objekt för att utföra batchåtgärder.

Se https://free.blessedness.top/rest/api/storageservices/blob-batch

function getBlobBatchClient(): BlobBatchClient

Returer

Ett nytt BlobBatchClient-objekt för den här tjänsten.

Skapar ett ContainerClient-objekt

function getContainerClient(containerName: string): ContainerClient

Parametrar

Returer

Ett nytt ContainerClient-objekt för det angivna containernamnet.

Exempel på användning:

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

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

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

Hämtar egenskaperna för ett lagringskontos blobtjänst, inklusive egenskaper för lagringsanalys och CORS-regler (resursdelning mellan ursprung).

Se https://free.blessedness.top/rest/api/storageservices/get-blob-service-properties

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

Parametrar

Returer

Svarsdata för åtgärden Hämta egenskaper för tjänsten.

Hämtar statistik som rör replikering för Blob-tjänsten. Den är endast tillgänglig på den sekundära platsslutpunkten när geo-redundant replikering med läsåtkomst är aktiverad för lagringskontot.

Se https://free.blessedness.top/rest/api/storageservices/get-blob-service-stats

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

Parametrar

Returer

Svarsdata för åtgärden Hämta statistik för tjänsten.

ENDAST TILLGÄNGLIGT NÄR DU ANVÄNDER BEARER TOKEN AUTHENTICATION (TokenCredential).

Hämtar en användardelegeringsnyckel för Blob-tjänsten. Detta är bara en giltig åtgärd när du använder ägartokenautentisering.

Se https://free.blessedness.top/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Parametrar

Returer

Returnerar en iterbar iterator som kan asynkroniseras för att visa en lista över alla containrar under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkront för att visa containrarna på sidor.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

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

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

// Use iter.next() to iterate the containers
i = 1;
const iter = blobServiceClient.listContainers();
let { value, done } = await iter.next();
while (!done) {
  console.log(`Container ${i++}: ${value.name}`);
  ({ value, done } = await iter.next());
}

// Use byPage() to iterate the containers
i = 1;
for await (const page of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
  for (const container of page.containerItems) {
    console.log(`Container ${i++}: ${container.name}`);
  }
}

// Use paging with a marker
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>

Parametrar

Returer

En asyncIterableIterator som stöder växling.

Anger egenskaper för ett lagringskontos blobtjänstslutpunkt, inklusive egenskaper för Lagringsanalys, CORS-regler (resursdelning mellan ursprung) och inställningar för mjuk borttagning.

Se https://free.blessedness.top/rest/api/storageservices/set-blob-service-properties

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

Parametrar

Returer

Svarsdata för åtgärden Egenskaper för tjänstuppsättning.

Återställ en tidigare borttagen blobcontainer. Det här API:et fungerar bara om mjuk borttagning av containrar är aktiverat för lagringskontot som är associerat med containern.

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

Parametrar

Returer

Svar på borttagning av containrar.