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

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

Egenskapsvärde

Ärvd från StorageClient.accountName

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity 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://docs.microsoft.com/en-us/rest/api/storageservices/create-container

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

Parametrar

Returer

Svar för att skapa containrar och motsvarande containerklient.

Tar bort en blobcontainer.

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

Parametrar

Returer

Svar på borttagning av containrar.

Returnerar en itererbar iterator för asynkron synkronisering för att hitta alla blobar med angiven tagg under det angivna kontot.

.byPage() returnerar en iterbar iterator som kan asynkroniseras för att lista blobarna på sidor.

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

Exempel med syntax for await :

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

Exempel med 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();
}

Exempel med 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}`);
    }
  }
}

Exempel med växling med en markör:

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>

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 autentiseringsuppgift med delad nyckel.

Genererar en SAS-URI (Blob Account Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://docs.microsoft.com/en-us/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.

Å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://docs.microsoft.com/en-us/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://docs.microsoft.com/en-us/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:

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

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

Se https://docs.microsoft.com/en-us/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äsbehörighet är aktiverad för lagringskontot.

Se https://docs.microsoft.com/en-us/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 ÄGARTOKENAUTENTISERING (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://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

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

Parametrar

Returer

Returnerar en itererbar iterator för asynkron synkronisering för att visa alla containrar under det angivna kontot.

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

Exempel med syntax for await :

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

Exempel med 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();
}

Exempel med 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}`);
    }
  }
}

Exempel med växling med en markör:

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>

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://docs.microsoft.com/en-us/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älla en tidigare borttagen blobcontainer. Det här API:et fungerar bara om mjuk borttagning av containrar är aktiverat för det lagringskonto 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.