BlobServiceClient class
Een BlobServiceClient vertegenwoordigt een client voor de Azure Storage Blob-service, zodat u blobcontainers kunt bewerken.
- Extends
-
StorageClient
Constructors
Blob |
Hiermee maakt u een exemplaar van BlobServiceClient. |
Blob |
Hiermee maakt u een exemplaar van BlobServiceClient. |
Overgenomen eigenschappen
account |
|
credential | Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het |
url | Gecodeerde URL-tekenreekswaarde. |
Methoden
create |
Maak een blobcontainer. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
delete |
Hiermee verwijdert u een blobcontainer. |
find |
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 in pagina's weer te geven. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties Voorbeeld met syntaxis
Voorbeeld met
Voorbeeld met
Voorbeeld van paging met een markering:
|
from |
Hiermee maakt u een exemplaar van BlobServiceClient op basis van connection string. |
generate |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
get |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Hiermee maakt u een BlobBatchClient-object om batchbewerkingen uit te voeren. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
get |
Hiermee maakt u een ContainerClient-object |
get |
Hiermee worden de eigenschappen van de Blob-service van een opslagaccount opgehaald, inclusief eigenschappen voor Opslaganalyse- en CORS-regels (Cross-Origin Resource Sharing). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats |
get |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key |
list |
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
Voorbeeld met
Voorbeeld met
Voorbeeld van paging met een markering:
|
set |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
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 interface TokenCredential 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 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
);
Details van overgenomen eigenschap
accountName
accountName: string
Waarde van eigenschap
string
Overgenomen van StorageClient.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.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Waarde van eigenschap
Overgenomen van StorageClient.credential
url
Gecodeerde URL-tekenreekswaarde.
url: string
Waarde van eigenschap
string
Overgenomen van StorageClient.url
Methodedetails
createContainer(string, ContainerCreateOptions)
Maak een blobcontainer.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Parameters
- containerName
-
string
Naam van de container die moet worden gemaakt.
- options
- ContainerCreateOptions
Opties voor het configureren van de bewerking Container Maken.
Retouren
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Antwoord voor het maken van containers en de bijbehorende containerclient.
deleteContainer(string, ContainerDeleteMethodOptions)
Hiermee verwijdert u een blobcontainer.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
Parameters
- containerName
-
string
Naam van de container die moet worden verwijderd.
- options
- ContainerDeleteMethodOptions
Opties voor het configureren van de container verwijderen bewerking.
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 in pagina's weer te geven.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
Voorbeeld met syntaxis for await
:
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
Voorbeeld met 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();
}
Voorbeeld met 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}`);
}
}
}
Voorbeeld van paging met een markering:
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>
Parameters
- tagFilterSqlExpression
-
string
Met de parameter where 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 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 voor het zoeken naar blobs op tags.
Retouren
fromConnectionString(string, StoragePipelineOptions)
Hiermee maakt u een exemplaar van BlobServiceClient op basis van connection string.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
Parameters
- connectionString
-
string
Account connection string of een SAS-connection string van een Azure-opslagaccount.
[ Opmerking: account connection string kunnen alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Voorbeeld 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
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
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.
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
function getBlobBatchClient(): BlobBatchClient
Retouren
Een nieuw BlobBatchClient-object voor deze service.
getContainerClient(string)
Hiermee maakt u een ContainerClient-object
function getContainerClient(containerName: string): ContainerClient
Parameters
- containerName
-
string
Een containernaam
Retouren
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).
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
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
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): PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>
Parameters
- options
- ServiceListContainersOptions
Opties voor het weergeven van containers.
Retouren
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
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): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
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<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Antwoord op containerverwijdering.