BlobServiceClient class
Een BlobServiceClient vertegenwoordigt een client naar de Azure Storage Blob-service, zodat u blobcontainers kunt bewerken.
- Uitbreiding
-
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 referenties van het |
url | Gecodeerde URL-tekenreekswaarde. |
Methoden
create |
Maak een Blob-container. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
delete |
Hiermee verwijdert u een Blob-container. |
find |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties Voorbeeld van
Voorbeeld van
Voorbeeld van
Voorbeeld van het gebruik van paging met een markering:
|
from |
Hiermee maakt u een exemplaar van BlobServiceClient op basis van de verbindingsreeks. |
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 |
generate |
Alleen beschikbaar voor BlobServiceClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Shared Access Signature) van een Blob-account 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 in serviceversies vanaf versie 2018-03-28. 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 haalt u de eigenschappen op van de Blob-service van een opslagaccount, inclusief eigenschappen voor regels voor Opslaganalyse en CORS (Cross-Origin Resource Sharing). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats |
get |
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. 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 van
Voorbeeld van
Voorbeeld van
Voorbeeld van het gebruik van paging met een markering:
|
set |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
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. |
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 Azure Storage-blobservice, 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 geef een aangepaste pijplijn op.
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 Azure Storage-blobservice, 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 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.
- options
- StoragePipelineOptions
Facultatief. Opties voor het configureren van de HTTP-pijplijn.
Voorbeeld van het gebruik van DefaultAzureCredential uit @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 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
overgenomen van StorageClient.credential
url
Gecodeerde URL-tekenreekswaarde.
url: string
Waarde van eigenschap
string
overgenomen van StorageClient.url
Methodedetails
createContainer(string, ContainerCreateOptions)
Maak een Blob-container.
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
De 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 Blob-container.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
Parameters
- containerName
-
string
De naam van de container die u wilt verwijderen.
- options
- ContainerDeleteMethodOptions
Opties voor het configureren van de bewerking Container verwijderen.
Retouren
Promise<ContainerDeleteResponse>
Antwoord op het verwijderen van containers.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
Voorbeeld van for await
syntaxis:
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
Voorbeeld van 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 van 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 het gebruik 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 opleveren voor een blob die in de resultaten moet worden geretourneerd. De syntaxisregel [OData - ABNF] filter definieert de formele grammatica voor de waarde van de waar queryparameter; Er wordt echter alleen een subset van de OData-filtersyntaxis ondersteund in de Blob-service.
- options
- ServiceFindBlobByTagsOptions
Opties voor het zoeken van blobs op tags.
Retouren
fromConnectionString(string, StoragePipelineOptions)
Hiermee maakt u een exemplaar van BlobServiceClient op basis van de verbindingsreeks.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
Parameters
- connectionString
-
string
Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount.
[ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
SAS-verbindingsreeks - 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
Facultatief. 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
Facultatief. Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Standaard een uur later, indien niet opgegeven.
- permissions
- AccountSASPermissions
Hiermee geeft u de lijst met machtigingen die aan de SAS moeten worden gekoppeld.
- resourceTypes
-
string
Hiermee geeft u de resourcetypen op die zijn gekoppeld aan de handtekening voor gedeelde toegang.
Optionele parameters.
Retouren
string
Een account-SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Alleen beschikbaar voor BlobServiceClient die is samengesteld met een gedeelde sleutelreferentie.
Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Shared Access Signature) van een Blob-account 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 generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parameters
- expiresOn
-
Date
Facultatief. Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Standaard een uur later, indien niet opgegeven.
- permissions
- AccountSASPermissions
Hiermee geeft u de lijst met machtigingen die aan de SAS moeten worden gekoppeld.
- resourceTypes
-
string
Hiermee geeft u de resourcetypen op die zijn gekoppeld aan de handtekening voor gedeelde toegang.
Optionele parameters.
Retouren
string
Een account-SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, 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 in serviceversies vanaf versie 2018-03-28.
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 Accountgegevens ophalen van service.
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.
Voorbeeldgebruik:
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
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).
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 van service ophalen.
Retouren
Promise<ServiceGetPropertiesResponse>
Antwoordgegevens voor de bewerking Eigenschappen van service ophalen.
getStatistics(ServiceGetStatisticsOptions)
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.
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 Statistieken ophalen van service.
Retouren
Promise<ServiceGetStatisticsResponse>
Antwoordgegevens voor de bewerking Service Get Statistics.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
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.
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 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): PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>
Parameters
- options
- ServiceListContainersOptions
Opties voor het weergeven van containers.
Retouren
Een asyncIterableIterator die paging ondersteunt.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
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.
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 de serviceset.
Retouren
Promise<ServiceSetPropertiesResponse>
Antwoordgegevens voor de bewerking Eigenschappen van de serviceset.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)
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): 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 bewerking containerherstel.
Retouren
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Antwoord op het verwijderen van containers.