BlobServiceClient class

Hiermee maakt u een exemplaar van BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parameters

Hiermee maakt u een exemplaar van BlobServiceClient.

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

Parameters

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

Waarde van eigenschap

Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

Maak een Blob-container.

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

Parameters

Retouren

Antwoord voor het maken van containers en de bijbehorende containerclient.

Hiermee verwijdert u een Blob-container.

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

Parameters

Retouren

Antwoord op het verwijderen van containers.

Retourneert een asynchrone iterator om alle blobs met opgegeven tag onder het opgegeven account te vinden. .byPage() retourneert een asynchrone iterator om de blobs in pagina's weer te geven.

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

Parameters

Retouren

Hiermee maakt u een exemplaar van BlobServiceClient op basis van de verbindingsreeks.

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

Parameters

Retouren

Alleen beschikbaar voor BlobServiceClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee wordt een SAS-URI (Shared Access Signature) voor een Blob-account gegenereerd op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

Parameters

Retouren

Een account-SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

De bewerking Accountgegevens ophalen retourneert de SKU-naam en het accounttype voor het opgegeven account. De bewerking Accountgegevens ophalen is beschikbaar in serviceversies vanaf versie 2018-03-28.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

Parameters

Retouren

Antwoordgegevens voor de bewerking Accountgegevens ophalen van service.

Hiermee maakt u een BlobBatchClient-object om batchbewerkingen uit te voeren.

function getBlobBatchClient()

Retouren

Een nieuw BlobBatchClient-object voor deze service.

Hiermee maakt u een <xref:ContainerClient>-object

function getContainerClient(containerName: string)

Parameters

Retouren

Een nieuw ContainerClient-object voor de opgegeven containernaam.

Voorbeeldgebruik:

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

Hiermee haalt u de eigenschappen op van de Blob-service van een opslagaccount, inclusief eigenschappen voor regels voor Opslaganalyse en CORS (Cross-Origin Resource Sharing).

function getProperties(options?: ServiceGetPropertiesOptions)

Parameters

Retouren

Antwoordgegevens voor de bewerking Eigenschappen van service ophalen.

Hiermee worden statistieken opgehaald die betrekking hebben op replicatie voor de Blob-service. Het is alleen beschikbaar op het eindpunt van de secundaire locatie wanneer geografisch redundante replicatie met leestoegang is ingeschakeld voor het opslagaccount.

function getStatistics(options?: ServiceGetStatisticsOptions)

Parameters

Retouren

Antwoordgegevens voor de bewerking Service Get Statistics.

ALLEEN BESCHIKBAAR BIJ HET GEBRUIK VAN BEARER-TOKENVERIFICATIE (TokenCredential). Hiermee haalt u een gebruikersdelegatiesleutel voor de Blob-service op. Dit is alleen een geldige bewerking bij het gebruik van bearer-tokenverificatie.

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

Parameters

Retouren

Retourneert een asynchrone iterator om alle containers onder het opgegeven account weer te geven. .byPage() retourneert een asynchrone iterator om de containers in pagina's weer te geven.

Voorbeeld van for await syntaxis:

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

Voorbeeld van 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();
}

Voorbeeld van 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}`);
    }
  }
}

Voorbeeld van het gebruik van paging met een markering:

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)

Parameters

Retouren

Een asyncIterableIterator die paging ondersteunt.

Hiermee stelt u eigenschappen in voor het Blob-service-eindpunt van een opslagaccount, inclusief eigenschappen voor Opslaganalyse, CORS-regels (Cross-Origin Resource Sharing) en instellingen voor voorlopig verwijderen.

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

Parameters

Retouren

Antwoordgegevens voor de bewerking Eigenschappen van de serviceset.

Een eerder verwijderde Blob-container herstellen. Deze API is alleen functioneel als Voorlopig verwijderen van containers is ingeschakeld voor het opslagaccount dat is gekoppeld aan de container.

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

Parameters

Retouren

Antwoord op het verwijderen van containers.