BlobServiceClient class

  • Referens
Paket:
@azure/storage-blob

En BlobServiceClient representerar en klient för Azure Storage Blob-tjänsten så att du kan ändra blobcontainrar.

Extends

StorageClient

Konstruktorer

BlobServiceClient(string, PipelineLike)

Skapar en instans av BlobServiceClient.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar en instans av BlobServiceClient.

Ärvda egenskaper

accountName
credential

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

Kodat URL-strängvärde.

Metoder

createContainer(string, ContainerCreateOptions)

Skapa en blobcontainer.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
deleteContainer(string, ContainerDeleteMethodOptions)

Tar bort en blobcontainer.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

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}`);
  }
}
fromConnectionString(string, StoragePipelineOptions)

Skapar en instans av BlobServiceClient från anslutningssträngen.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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
getAccountInfo(ServiceGetAccountInfoOptions)

Å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
getBlobBatchClient()

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
getContainerClient(string)

Skapar ett ContainerClient-objekt
getProperties(ServiceGetPropertiesOptions)

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
getStatistics(ServiceGetStatisticsOptions)

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
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

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
listContainers(ServiceListContainersOptions)

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}`);
  }
}
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

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
undeleteContainer(string, string, ServiceUndeleteContainerOptions)

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

Konstruktorinformation

BlobServiceClient(string, PipelineLike)

Skapar en instans av BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parametrar

url

string

En klientsträng som pekar på Azure Storage-blobtjänsten, till exempel "https://myaccount.blob.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

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

Skapar en instans av BlobServiceClient.

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

Parametrar

url

string

En klientsträng som pekar på Azure Storage-blobtjänsten, till exempel "https://myaccount.blob.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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.

options
StoragePipelineOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

Exempel med defaultAzureCredential från @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Exempel med ett kontonamn/nyckel:

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

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

Information om ärvda egenskaper

accountName 

accountName: string

Egenskapsvärde

string

Ärvd från StorageClient.accountName

credential

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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ärvd från StorageClient.credential

url

Kodat URL-strängvärde.

url: string

Egenskapsvärde

string

Ärvd från StorageClient.url

Metodinformation

createContainer(string, ContainerCreateOptions)

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

containerName

string

Namnet på containern som ska skapas.

options
ContainerCreateOptions

Alternativ för att konfigurera åtgärden Skapa container.

Returer

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

Svar för att skapa containrar och motsvarande containerklient.

deleteContainer(string, ContainerDeleteMethodOptions)

Tar bort en blobcontainer.

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

Parametrar

containerName

string

Namnet på containern som ska tas bort.

options
ContainerDeleteMethodOptions

Alternativ för att konfigurera åtgärden Ta bort containrar.

Returer

Promise<ContainerDeleteResponse>

Svar på borttagning av containrar.

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

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

tagFilterSqlExpression

string

Med where-parametern kan anroparen fråga blobbar vars taggar matchar ett visst uttryck. Det givna uttrycket måste utvärderas till true för att en blob ska returneras i resultatet. Filtersyntaxregeln [OData – ABNF] definierar den formella grammatiken för värdet för frågeparametern where; Men endast en delmängd av OData-filtersyntaxen stöds i Blob-tjänsten.

options
ServiceFindBlobByTagsOptions

Alternativ för att hitta blobar efter taggar.

Returer

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse, PageSettings>

fromConnectionString(string, StoragePipelineOptions)

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

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

Parametrar

connectionString

string

Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto. [ Obs! Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net EXEMPEL på SAS-anslutningssträng – 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

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

Returer

BlobServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

expiresOn

Date

Valfritt. Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Standardvärdet är en timme senare om det inte anges.

permissions
AccountSASPermissions

Anger listan över behörigheter som ska associeras med SAS.

resourceTypes

string

Anger de resurstyper som är associerade med signaturen för delad åtkomst.

options
ServiceGenerateAccountSasUrlOptions

Valfria parametrar.

Returer

string

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.

getAccountInfo(ServiceGetAccountInfoOptions)

Å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

options
ServiceGetAccountInfoOptions

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

Returer

Promise<ServiceGetAccountInfoResponse>

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

getBlobBatchClient()

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

BlobBatchClient

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

getContainerClient(string)

Skapar ett ContainerClient-objekt

function getContainerClient(containerName: string): ContainerClient

Parametrar

containerName

string

Ett containernamn

Returer

ContainerClient

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

Exempel på användning:

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

getProperties(ServiceGetPropertiesOptions)

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

options
ServiceGetPropertiesOptions

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

Returer

Promise<ServiceGetPropertiesResponse>

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

getStatistics(ServiceGetStatisticsOptions)

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

options
ServiceGetStatisticsOptions

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

Returer

Promise<ServiceGetStatisticsResponse>

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

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

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

startsOn

Date

Starttiden för SAS för användardelegering. Måste vara inom 7 dagar från den aktuella tiden

expiresOn

Date

Sluttiden för SAS för användardelegering. Måste vara inom 7 dagar från den aktuella tiden

options
ServiceGetUserDelegationKeyOptions

Returer

Promise<ServiceGetUserDelegationKeyResponse>

listContainers(ServiceListContainersOptions)

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

options
ServiceListContainersOptions

Alternativ för att visa containrar.

Returer

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>

En asyncIterableIterator som stöder växling.

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

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

properties
BlobServiceProperties
options
ServiceSetPropertiesOptions

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

Returer

Promise<ServiceSetPropertiesResponse>

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

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Å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

deletedContainerName

string

Namnet på den tidigare borttagna containern.

deletedContainerVersion

string

Version av den tidigare borttagna containern som används för att unikt identifiera den borttagna containern.

options
ServiceUndeleteContainerOptions

Alternativ för att konfigurera återställning av containrar.

Returer

Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>

Svar på borttagning av containrar.