Delen via

BlobServiceClient class

  • Referentie
Pakket:
@azure/storage-blob

Een BlobServiceClient vertegenwoordigt een client voor de Azure Storage Blob-service, zodat u blobcontainers kunt bewerken.

Extends
StorageClient

Constructors

BlobServiceClient(string, PipelineLike)

Hiermee maakt u een exemplaar van BlobServiceClient.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een exemplaar van BlobServiceClient.

Eigenschappen

accountName
credential

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

Gecodeerde URL-tekenreekswaarde.

Methoden

createContainer(string, ContainerCreateOptions)

Maak een Blob-container.
deleteContainer(string, ContainerDeleteMethodOptions)

Hiermee verwijdert u een blobcontainer.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

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

Hiermee maakt u een exemplaar van BlobServiceClient op basis van connection string.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

Hiermee maakt u een BlobBatchClient-object om batchbewerkingen uit te voeren.
getContainerClient(string)

Hiermee maakt u een <xref:ContainerClient> object
getProperties(ServiceGetPropertiesOptions)

Hiermee worden de eigenschappen van de Blob-service van een opslagaccount opgehaald, inclusief eigenschappen voor Opslaganalyse- en CORS-regels (Cross-Origin Resource Sharing).
getStatistics(ServiceGetStatisticsOptions)

Hiermee worden statistieken opgehaald met betrekking tot replicatie voor de Blob-service. Deze is alleen beschikbaar op het eindpunt van de secundaire locatie wanneer geografisch redundante replicatie met leestoegang is ingeschakeld voor het opslagaccount.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ALLEEN BESCHIKBAAR BIJ GEBRUIK VAN BEARER-TOKENVERIFICATIE (TokenCredential). Hiermee haalt u een sleutel voor gebruikersdelegatie op voor de Blob-service. Dit is alleen een geldige bewerking wanneer bearer-tokenverificatie wordt gebruikt.
listContainers(ServiceListContainersOptions)

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 met syntaxis for await :

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

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

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

Een eerder verwijderde blobcontainer herstellen. Deze API werkt alleen als Voorlopig verwijderen van container is ingeschakeld voor het opslagaccount dat is gekoppeld aan de container.

Constructordetails

BlobServiceClient(string, PipelineLike)

Hiermee maakt u een exemplaar van BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parameters

url

string

Een clienttekenreeks die verwijst naar de Blob-service van Azure Storage, zoals 'https://myaccount.blob.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Roep newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.

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

Hiermee maakt u een exemplaar van BlobServiceClient.

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

Parameters

url

string

Een clienttekenreeks die verwijst naar de Blob-service van Azure Storage, zoals 'https://myaccount.blob.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit 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.

options
StoragePipelineOptions

Optioneel. Opties voor het configureren van de HTTP-pijplijn.

Voorbeeld met defaultAzureCredential van @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Voorbeeld met behulp van een accountnaam/-sleutel:

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

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

Eigenschapdetails

accountName 

accountName: string

Waarde van eigenschap

string

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

Methodedetails

createContainer(string, ContainerCreateOptions)

Maak een Blob-container.

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

Parameters

containerName

string

Naam van de container die moet worden gemaakt.

options
ContainerCreateOptions

Opties voor het configureren van de bewerking Container maken.

Retouren

Promise<Object>

Antwoord voor het maken van containers en de bijbehorende containerclient.

deleteContainer(string, ContainerDeleteMethodOptions)

Hiermee verwijdert u een blobcontainer.

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

Parameters

containerName

string

Naam van de container die u wilt verwijderen.

options
ContainerDeleteMethodOptions

Opties voor het configureren van de bewerking Container Verwijderen.

Retouren

Promise<ContainerDeleteResponse>

Antwoord op containerverwijdering.

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

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

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

Parameters

tagFilterSqlExpression

string

Met de where-parameter kan de aanroeper query's uitvoeren op blobs waarvan de tags overeenkomen met een bepaalde expressie. De opgegeven expressie moet waar zijn om een blob te laten retourneren in de resultaten. De filtersyntaxisregel [OData - ABNF] definieert de formele grammatica voor de waarde van de parameter where-query; Er wordt echter slechts een subset van de OData-filtersyntaxis ondersteund in de Blob-service.

options
ServiceFindBlobByTagsOptions

Opties om blobs te zoeken op tags.

Retouren

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>

fromConnectionString(string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van BlobServiceClient op basis van connection string.

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

Parameters

connectionString

string

Account connection string of een SAS-connection string van een Azure-opslagaccount. [ Opmerking: account connection string kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -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

Optioneel. Opties voor het configureren van de HTTP-pijplijn.

Retouren

BlobServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

expiresOn

Date

Optioneel. Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Standaard ingesteld op een uur later als dit niet is opgegeven.

permissions
AccountSASPermissions

Hiermee geeft u de lijst met machtigingen die moeten worden gekoppeld aan de SAS.

resourceTypes

string

Hiermee geeft u de resourcetypen op die zijn gekoppeld aan de handtekening voor gedeelde toegang.

options
ServiceGenerateAccountSasUrlOptions

Optionele parameters.

Retouren

string

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

getAccountInfo(ServiceGetAccountInfoOptions)

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

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

Parameters

options
ServiceGetAccountInfoOptions

Opties voor de bewerking Service Accountgegevens ophalen.

Retouren

Promise<ServiceGetAccountInfoResponse>

Antwoordgegevens voor de bewerking Accountgegevens ophalen van service.

getBlobBatchClient()

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

function getBlobBatchClient()

Retouren

BlobBatchClient

Een nieuw BlobBatchClient-object voor deze service.

getContainerClient(string)

Hiermee maakt u een <xref:ContainerClient> object

function getContainerClient(containerName: string)

Parameters

containerName

string

Een containernaam

Retouren

ContainerClient

Een nieuw ContainerClient-object voor de opgegeven containernaam.

Gebruiksvoorbeeld:

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

getProperties(ServiceGetPropertiesOptions)

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

function getProperties(options?: ServiceGetPropertiesOptions)

Parameters

options
ServiceGetPropertiesOptions

Opties voor de bewerking Eigenschappen ophalen van service.

Retouren

Promise<ServiceGetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen ophalen van service.

getStatistics(ServiceGetStatisticsOptions)

Hiermee worden statistieken opgehaald met betrekking tot replicatie voor de Blob-service. Deze 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

options
ServiceGetStatisticsOptions

Opties voor de bewerking Service Statistieken ophalen.

Retouren

Promise<ServiceGetStatisticsResponse>

Antwoordgegevens voor de bewerking Statistieken ophalen van de service.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ALLEEN BESCHIKBAAR BIJ GEBRUIK VAN BEARER-TOKENVERIFICATIE (TokenCredential). Hiermee haalt u een sleutel voor gebruikersdelegatie op voor de Blob-service. Dit is alleen een geldige bewerking wanneer bearer-tokenverificatie wordt gebruikt.

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

Parameters

startsOn

Date

De begintijd voor de SAS voor gebruikersdelegatie. Moet binnen 7 dagen na de huidige tijd zijn

expiresOn

Date

De eindtijd voor de SAS voor gebruikersdelegatie. Moet binnen 7 dagen na de huidige tijd zijn

options
ServiceGetUserDelegationKeyOptions

Retouren

Promise<ServiceGetUserDelegationKeyResponse>

listContainers(ServiceListContainersOptions)

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 met syntaxis for await :

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

Voorbeeld met 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 met 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 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

options
ServiceListContainersOptions

Opties voor het weergeven van containers.

Retouren

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

Een asynchroneIterableIterator die paging ondersteunt.

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

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

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

Parameters

properties
BlobServiceProperties
options
ServiceSetPropertiesOptions

Opties voor de bewerking Eigenschappen van serviceset.

Retouren

Promise<ServiceSetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen van de serviceset.

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Een eerder verwijderde blobcontainer herstellen. Deze API werkt alleen als Voorlopig verwijderen van container is ingeschakeld voor het opslagaccount dat is gekoppeld aan de container.

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

Parameters

deletedContainerName

string

Naam van de eerder verwijderde container.

deletedContainerVersion

string

Versie van de eerder verwijderde container, die wordt gebruikt om de verwijderde container uniek te identificeren.

options
ServiceUndeleteContainerOptions

Opties voor het configureren van de containerherstelbewerking.

Retouren

Promise<Object>

Antwoord op containerverwijdering.