Dela via

ContainerClient class

  • Referens
Paket:
@azure/storage-blob

En ContainerClient representerar en URL till Azure Storage-containern så att du kan ändra dess blobar.

Extends

StorageClient

Konstruktorer

ContainerClient(string, PipelineLike)

Skapar en instans av ContainerClient. Den här metoden accepterar en URL som pekar på en container. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.
ContainerClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar en instans av ContainerClient. Den här metoden accepterar en URL som pekar på en container. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.
ContainerClient(string, string, StoragePipelineOptions)

Skapar en instans av ContainerClient.

Egenskaper

containerName

Namnet på containern.

Ärvda egenskaper

accountName
credential

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

Kodat URL-strängvärde.

Metoder

create(ContainerCreateOptions)

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns misslyckas åtgärden.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container namngivningsregler: Se https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
createIfNotExists(ContainerCreateOptions)

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns ändras den inte.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container namngivningsregler: Se https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
delete(ContainerDeleteMethodOptions)

Markerar den angivna containern för borttagning. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
deleteBlob(string, ContainerDeleteBlobOptions)

Markerar den angivna bloben eller ögonblicksbilden för borttagning. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(ContainerDeleteMethodOptions)

Markerar den angivna containern för borttagning om den finns. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
exists(ContainerExistsOptions)

Returnerar sant om Azure-containerresursen som representeras av den här klienten finns. annars falskt.

Obs! Använd den här funktionen med försiktighet eftersom en befintlig container kan tas bort av andra klienter eller program. Vice versa nya containrar med samma namn kan läggas till av andra klienter eller program när den här funktionen har slutförts.
findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Returnerar en itererbar iterator för asynkronisering för att hitta alla blobar med angiven tagg under den angivna containern.

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

Exempel med for await syntax:

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

Exempel med :iter.next()

let i = 1;
const iter = containerClient.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 containerClient.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 = containerClient.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 = containerClient
  .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}`);
  }
}
generateSasStringToSign(ContainerGenerateSasUrlOptions)

Endast tillgängligt för ContainerClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar sträng som ska signeras för en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ContainerGenerateSasUrlOptions)

Endast tillgängligt för ContainerClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(ContainerGenerateSasUrlOptions, UserDelegationKey)

Genererar sträng som ska signeras för en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(ContainerGenerateSasUrlOptions, UserDelegationKey)

Genererar en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ContainerGetAccessPolicyOptions)

Hämtar behörigheterna för den angivna containern. Behörigheterna anger om containerdata kan kommas åt offentligt.

VARNING! JavaScript-datum förlorar potentiellt precision vid parsning av startsOn och expiresOn-strängar. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
getAccountInfo(ContainerGetAccountInfoOptions)

Å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
getAppendBlobClient(string)

Skapar en AppendBlobClient-
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
getBlobClient(string)

Skapar en BlobClient-
getBlobLeaseClient(string)

Hämta en BlobLeaseClient- som hanterar lån på containern.
getBlockBlobClient(string)

Skapar en BlockBlobClient-
getPageBlobClient(string)

Skapar en PageBlobClient-
getProperties(ContainerGetPropertiesOptions)

Returnerar alla användardefinierade metadata och systemegenskaper för den angivna containern. De data som returneras innehåller inte containerns lista över blobar.

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

VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoden listContainers för BlobServiceClient med hjälp av alternativet includeMetadata, som behåller sitt ursprungliga hölje.
listBlobsByHierarchy(string, ContainerListBlobsOptions)

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

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

Exempel med for await syntax:

for await (const item of containerClient.listBlobsByHierarchy("/")) {
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}`);
  }
}

Exempel med :iter.next()

let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
let entity = await iter.next();
while (!entity.done) {
  let item = entity.value;
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}`);
  }
  entity = await iter.next();
}

Exempel med :byPage()

console.log("Listing blobs by hierarchy by page");
for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
  const segment = response.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

Exempel med växling med maximal sidstorlek:

console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");

let i = 1;
for await (const response of containerClient
  .listBlobsByHierarchy("/", { prefix: "prefix2/sub1/" })
  .byPage({ maxPageSize: 2 })) {
  console.log(`Page ${i++}`);
  const segment = response.segment;

  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }

  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}
listBlobsFlat(ContainerListBlobsOptions)

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

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

Exempel med for await syntax:

// Get the containerClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>");`
let i = 1;
for await (const blob of containerClient.listBlobsFlat()) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

Exempel med :iter.next()

let i = 1;
let iter = containerClient.listBlobsFlat();
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 containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

Exempel med växling med en markör:

let i = 1;
let iterator = containerClient.listBlobsFlat().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = containerClient.listBlobsFlat().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}
setAccessPolicy(PublicAccessType, SignedIdentifier[], ContainerSetAccessPolicyOptions)

Anger behörigheter för den angivna containern. Behörigheterna anger om blobar i en container kan nås offentligt.

När du anger behörigheter för en container ersätts de befintliga behörigheterna. Om ingen åtkomst eller containerAcl har angetts tas den befintliga container-ACL:n bort.

När du upprättar en lagrad åtkomstprincip på en container kan det ta upp till 30 sekunder att börja gälla. Under det här intervallet misslyckas en signatur för delad åtkomst som är associerad med den lagrade åtkomstprincipen med statuskoden 403 (förbjuden) tills åtkomstprincipen blir aktiv.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
setMetadata(Metadata, ContainerSetMetadataOptions)

Anger ett eller flera användardefinierade namn/värde-par för den angivna containern.

Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas containermetadata bort.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
uploadBlockBlob(string, RequestBodyType, number, BlockBlobUploadOptions)

Skapar en ny blockblob eller uppdaterar innehållet i en befintlig blockblob.

Om du uppdaterar en befintlig blockblob skrivs befintliga metadata över på bloben. Partiella uppdateringar stöds inte. innehållet i den befintliga bloben skrivs över med det nya innehållet. Om du vill utföra en partiell uppdatering av en blockblob använder du stageBlock och commitBlockList.

Det här är en icke-parallell uppladdningsmetod. Använd uploadFile, uploadStream eller uploadBrowserData för bättre prestanda vid samtidig uppladdning.

Se https://docs.microsoft.com/rest/api/storageservices/put-blob

Konstruktorinformation

ContainerClient(string, PipelineLike)

Skapar en instans av ContainerClient. Den här metoden accepterar en URL som pekar på en container. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.

new ContainerClient(url: string, pipeline: PipelineLike)

Parametrar

url

string

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

pipeline
PipelineLike

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

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

Skapar en instans av ContainerClient. Den här metoden accepterar en URL som pekar på en container. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.

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

Parametrar

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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.

options
StoragePipelineOptions

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

ContainerClient(string, string, StoragePipelineOptions)

Skapar en instans av ContainerClient.

new ContainerClient(connectionString: string, containerName: string, options?: StoragePipelineOptions)

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

containerName

string

Containernamn.

options
StoragePipelineOptions

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

Egenskapsinformation

containerName

Namnet på containern.

string containerName

Egenskapsvärde

string

Information om ärvda egenskaper

accountName 

accountName: string

Egenskapsvärde

string

ärvd från StorageClient.accountName

credential

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

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

create(ContainerCreateOptions)

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns misslyckas åtgärden.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container namngivningsregler: Se https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

function create(options?: ContainerCreateOptions): Promise<ContainerCreateResponse>

Parametrar

options
ContainerCreateOptions

Alternativ för åtgärden Skapa container.

Exempel på användning:

const containerClient = blobServiceClient.getContainerClient("<container name>");
const createContainerResponse = await containerClient.create();
console.log("Container was created successfully", createContainerResponse.requestId);

Returer

Promise<ContainerCreateResponse>

createIfNotExists(ContainerCreateOptions)

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns ändras den inte.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container namngivningsregler: Se https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

function createIfNotExists(options?: ContainerCreateOptions): Promise<ContainerCreateIfNotExistsResponse>

Parametrar

options
ContainerCreateOptions

Returer

Promise<ContainerCreateIfNotExistsResponse>

delete(ContainerDeleteMethodOptions)

Markerar den angivna containern för borttagning. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

function delete(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

Parametrar

options
ContainerDeleteMethodOptions

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

Returer

Promise<ContainerDeleteResponse>

deleteBlob(string, ContainerDeleteBlobOptions)

Markerar den angivna bloben eller ögonblicksbilden för borttagning. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteBlob(blobName: string, options?: ContainerDeleteBlobOptions): Promise<BlobDeleteResponse>

Parametrar

blobName

string

options
ContainerDeleteBlobOptions

Alternativ för blobborttagning.

Returer

Promise<BlobDeleteResponse>

Blockera svarsdata för borttagning av blobar.

deleteIfExists(ContainerDeleteMethodOptions)

Markerar den angivna containern för borttagning om den finns. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

function deleteIfExists(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteIfExistsResponse>

Parametrar

options
ContainerDeleteMethodOptions

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

Returer

Promise<ContainerDeleteIfExistsResponse>

exists(ContainerExistsOptions)

Returnerar sant om Azure-containerresursen som representeras av den här klienten finns. annars falskt.

Obs! Använd den här funktionen med försiktighet eftersom en befintlig container kan tas bort av andra klienter eller program. Vice versa nya containrar med samma namn kan läggas till av andra klienter eller program när den här funktionen har slutförts.

function exists(options?: ContainerExistsOptions): Promise<boolean>

Parametrar

options
ContainerExistsOptions

Returer

Promise<boolean>

findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Returnerar en itererbar iterator för asynkronisering för att hitta alla blobar med angiven tagg under den angivna containern.

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

Exempel med for await syntax:

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

Exempel med :iter.next()

let i = 1;
const iter = containerClient.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 containerClient.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 = containerClient.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 = containerClient
  .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?: ContainerFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

Parametrar

tagFilterSqlExpression

string

Med parametern Where kan anroparen fråga blobbar vars taggar matchar ett visst uttryck. Det angivna 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
ContainerFindBlobByTagsOptions

Alternativ för att hitta blobar efter taggar.

Returer

PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

generateSasStringToSign(ContainerGenerateSasUrlOptions)

Endast tillgängligt för ContainerClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar sträng som ska signeras för en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: ContainerGenerateSasUrlOptions): string

Parametrar

options
ContainerGenerateSasUrlOptions

Valfria parametrar.

Returer

string

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

generateSasUrl(ContainerGenerateSasUrlOptions)

Endast tillgängligt för ContainerClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ContainerGenerateSasUrlOptions): Promise<string>

Parametrar

options
ContainerGenerateSasUrlOptions

Valfria parametrar.

Returer

Promise<string>

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

generateUserDelegationSasStringToSign(ContainerGenerateSasUrlOptions, UserDelegationKey)

Genererar sträng som ska signeras för en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: ContainerGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametrar

options
ContainerGenerateSasUrlOptions

Valfria parametrar.

userDelegationKey
UserDelegationKey

Returvärde för blobServiceClient.getUserDelegationKey()

Returer

string

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

generateUserDelegationSasUrl(ContainerGenerateSasUrlOptions, UserDelegationKey)

Genererar en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: ContainerGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parametrar

options
ContainerGenerateSasUrlOptions

Valfria parametrar.

userDelegationKey
UserDelegationKey

Returvärde för blobServiceClient.getUserDelegationKey()

Returer

Promise<string>

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

getAccessPolicy(ContainerGetAccessPolicyOptions)

Hämtar behörigheterna för den angivna containern. Behörigheterna anger om containerdata kan kommas åt offentligt.

VARNING! JavaScript-datum förlorar potentiellt precision vid parsning av startsOn och expiresOn-strängar. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl

function getAccessPolicy(options?: ContainerGetAccessPolicyOptions): Promise<ContainerGetAccessPolicyResponse>

Parametrar

options
ContainerGetAccessPolicyOptions

Alternativ för åtgärden Hämta åtkomstprincip för container.

Returer

Promise<ContainerGetAccessPolicyResponse>

getAccountInfo(ContainerGetAccountInfoOptions)

Å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?: ContainerGetAccountInfoOptions): Promise<ContainerGetAccountInfoResponse>

Parametrar

options
ContainerGetAccountInfoOptions

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

Returer

Promise<ContainerGetAccountInfoResponse>

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

getAppendBlobClient(string)

Skapar en AppendBlobClient-

function getAppendBlobClient(blobName: string): AppendBlobClient

Parametrar

blobName

string

Ett tilläggsblobnamn

Returer

AppendBlobClient

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

getBlobClient(string)

Skapar en BlobClient-

function getBlobClient(blobName: string): BlobClient

Parametrar

blobName

string

Ett blobnamn

Returer

BlobClient

Ett nytt BlobClient-objekt för det angivna blobnamnet.

getBlobLeaseClient(string)

Hämta en BlobLeaseClient- som hanterar lån på containern.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametrar

proposeLeaseId

string

Ursprungligt föreslaget låne-ID.

Returer

BlobLeaseClient

Ett nytt BlobLeaseClient-objekt för att hantera lån på containern.

getBlockBlobClient(string)

Skapar en BlockBlobClient-

function getBlockBlobClient(blobName: string): BlockBlobClient

Parametrar

blobName

string

Ett blockblobnamn

Exempel på användning:

const content = "Hello world!";

const blockBlobClient = containerClient.getBlockBlobClient("<blob name>");
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

Returer

BlockBlobClient

getPageBlobClient(string)

Skapar en PageBlobClient-

function getPageBlobClient(blobName: string): PageBlobClient

Parametrar

blobName

string

Ett sidblobnamn

Returer

PageBlobClient

getProperties(ContainerGetPropertiesOptions)

Returnerar alla användardefinierade metadata och systemegenskaper för den angivna containern. De data som returneras innehåller inte containerns lista över blobar.

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

VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoden listContainers för BlobServiceClient med hjälp av alternativet includeMetadata, som behåller sitt ursprungliga hölje.

function getProperties(options?: ContainerGetPropertiesOptions): Promise<ContainerGetPropertiesResponse>

Parametrar

options
ContainerGetPropertiesOptions

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

Returer

Promise<ContainerGetPropertiesResponse>

listBlobsByHierarchy(string, ContainerListBlobsOptions)

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

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

Exempel med for await syntax:

for await (const item of containerClient.listBlobsByHierarchy("/")) {
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}`);
  }
}

Exempel med :iter.next()

let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
let entity = await iter.next();
while (!entity.done) {
  let item = entity.value;
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}`);
  }
  entity = await iter.next();
}

Exempel med :byPage()

console.log("Listing blobs by hierarchy by page");
for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
  const segment = response.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

Exempel med växling med maximal sidstorlek:

console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");

let i = 1;
for await (const response of containerClient
  .listBlobsByHierarchy("/", { prefix: "prefix2/sub1/" })
  .byPage({ maxPageSize: 2 })) {
  console.log(`Page ${i++}`);
  const segment = response.segment;

  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }

  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

function listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<({ kind: "prefix" } & BlobPrefix) | ({ kind: "blob" } & BlobItem), ContainerListBlobHierarchySegmentResponse, PageSettings>

Parametrar

delimiter

string

Tecknet eller strängen som används för att definiera den virtuella hierarkin

options
ContainerListBlobsOptions

Alternativ för att lista blobar.

Returer

PagedAsyncIterableIterator<({ kind: "prefix" } & BlobPrefix) | ({ kind: "blob" } & BlobItem), ContainerListBlobHierarchySegmentResponse, PageSettings>

listBlobsFlat(ContainerListBlobsOptions)

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

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

Exempel med for await syntax:

// Get the containerClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>");`
let i = 1;
for await (const blob of containerClient.listBlobsFlat()) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

Exempel med :iter.next()

let i = 1;
let iter = containerClient.listBlobsFlat();
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 containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

Exempel med växling med en markör:

let i = 1;
let iterator = containerClient.listBlobsFlat().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = containerClient.listBlobsFlat().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

function listBlobsFlat(options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Parametrar

options
ContainerListBlobsOptions

Alternativ för att lista blobar.

Returer

PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

En asyncIterableIterator som stöder växling.

setAccessPolicy(PublicAccessType, SignedIdentifier[], ContainerSetAccessPolicyOptions)

Anger behörigheter för den angivna containern. Behörigheterna anger om blobar i en container kan nås offentligt.

När du anger behörigheter för en container ersätts de befintliga behörigheterna. Om ingen åtkomst eller containerAcl har angetts tas den befintliga container-ACL:n bort.

När du upprättar en lagrad åtkomstprincip på en container kan det ta upp till 30 sekunder att börja gälla. Under det här intervallet misslyckas en signatur för delad åtkomst som är associerad med den lagrade åtkomstprincipen med statuskoden 403 (förbjuden) tills åtkomstprincipen blir aktiv.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl

function setAccessPolicy(access?: PublicAccessType, containerAcl?: SignedIdentifier[], options?: ContainerSetAccessPolicyOptions): Promise<ContainerSetAccessPolicyResponse>

Parametrar

access
PublicAccessType

Nivån för offentlig åtkomst till data i containern.

containerAcl

SignedIdentifier[]

Matris med element som var och en har ett unikt ID och information om åtkomstprincipen.

options
ContainerSetAccessPolicyOptions

Alternativ för åtgärden Ange åtkomstprincip för container.

Returer

Promise<ContainerSetAccessPolicyResponse>

setMetadata(Metadata, ContainerSetMetadataOptions)

Anger ett eller flera användardefinierade namn/värde-par för den angivna containern.

Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas containermetadata bort.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata

function setMetadata(metadata?: Metadata, options?: ContainerSetMetadataOptions): Promise<ContainerSetMetadataResponse>

Parametrar

metadata
Metadata

Ersätt befintliga metadata med det här värdet. Om inget värde anges tas befintliga metadata bort.

options
ContainerSetMetadataOptions

Alternativ för åtgärden Ange metadata för containrar.

Returer

Promise<ContainerSetMetadataResponse>

uploadBlockBlob(string, RequestBodyType, number, BlockBlobUploadOptions)

Skapar en ny blockblob eller uppdaterar innehållet i en befintlig blockblob.

Om du uppdaterar en befintlig blockblob skrivs befintliga metadata över på bloben. Partiella uppdateringar stöds inte. innehållet i den befintliga bloben skrivs över med det nya innehållet. Om du vill utföra en partiell uppdatering av en blockblob använder du stageBlock och commitBlockList.

Det här är en icke-parallell uppladdningsmetod. Använd uploadFile, uploadStream eller uploadBrowserData för bättre prestanda vid samtidig uppladdning.

Se https://docs.microsoft.com/rest/api/storageservices/put-blob

function uploadBlockBlob(blobName: string, body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<{ blockBlobClient: BlockBlobClient, response: BlockBlobUploadResponse }>

Parametrar

blobName

string

Namn på blockbloben som ska skapas eller uppdateras.

body
HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView eller en funktion som returnerar en ny läsbar ström vars förskjutning kommer från datakällans början.

contentLength

number

Längd på brödtext i byte. Använd Buffer.byteLength() för att beräkna brödtextlängden för en sträng, inklusive icke-Base64/Hex-kodade tecken.

options
BlockBlobUploadOptions

Alternativ för att konfigurera blockblobuppladdningsåtgärden.

Returer

Promise<{ blockBlobClient: BlockBlobClient, response: BlockBlobUploadResponse }>

Blockera blobuppladdningssvarsdata och motsvarande BlockBlobClient-instans.