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

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 inget anges används AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Egenskapsvärde

Kodat URL-strängvärde.

url: string

Egenskapsvärde

Skapa en blobcontainer.

function createContainer(containerName: string, options?: ContainerCreateOptions)

Parametrar

Returer

Svar vid skapande av container och motsvarande containerklient.

Tar bort en blobcontainer.

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions)

Parametrar

Returer

Svar på borttagning av container.

Returnerar en asynkron iterbar iterator 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 en lista över blobarna på sidor.

function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions)

Parametrar

Returer

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

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

Parametrar

Returer

Endast tillgängligt för BlobServiceClient som skapats med autentiseringsuppgifter för delad nyckel. Genererar en URI för signatur för delad åtkomst (SAS) för blobkontot baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

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.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

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.

function getBlobBatchClient()

Returer

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

Skapar ett <xref:ContainerClient> objekt

function getContainerClient(containerName: string)

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 blobtjänst, inklusive egenskaper för Lagringsanalys och CORS-regler (resursdelning mellan ursprung).

function getProperties(options?: ServiceGetPropertiesOptions)

Parametrar

Returer

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

Hämtar statistik relaterad till replikering för Blob Service. Den är endast tillgänglig på den sekundära platsslutpunkten när geo-redundant replikering med läsbehörighet är aktiverad för lagringskontot.

function getStatistics(options?: ServiceGetStatisticsOptions)

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 Service. Detta är bara en giltig åtgärd när du använder ägartokenautentisering.

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions)

Parametrar

Returer

Returnerar en asynkron iterbar iterator för att visa en lista över alla containrar under det angivna kontot. .byPage() returnerar en asynkron itererbar iterator för att visa en lista över 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 sidindelning 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)

Parametrar

Returer

En asyncIterableIterator som stöder sidindelning.

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

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions)

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 lagringskontot som är associerat med containern.

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions)

Parametrar

Returer

Svar på borttagning av container.