BlobServiceClient class
A BlobServiceClient az Azure Storage Blob szolgáltatás ügyfele, amely lehetővé teszi a blobtárolók manipulálását.
- Extends
-
StorageClient
Konstruktorok
| Blob |
Létrehozza a BlobServiceClient egy példányát. |
| Blob |
Létrehozza a BlobServiceClient egy példányát. |
Örökölt tulajdonságok
| account |
|
| credential | Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a |
| url | Kódolt URL-sztringérték. |
Metódusok
| create |
Blobtároló létrehozása. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-container |
| delete |
Blobtároló törlése. |
| find |
Egy aszinkron iterátort ad vissza, amely megkeresi a megadott címkével rendelkező összes blobot a megadott fiók alatt. A .byPage() aszinkron iterátort ad vissza a lapok blobjainak listázásához. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties
|
| from |
Létrehoz egy BlobServiceClient-példányt a kapcsolati sztringből. |
| generate |
Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobServiceClient esetén érhető el. Létrehoz egy Blob-fiók megosztott hozzáférésű jogosultságkódját (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-account-sas |
| generate |
Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobServiceClient esetén érhető el. Sztringet hoz létre egy blobfiók közös hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-account-sas |
| get |
A Fiókadatok lekérése művelet a megadott fiók termékváltozatának nevét és típusát adja vissza. A Fiókadatok lekérése művelet a 2018-03-28-es verziójú szolgáltatásverziókban érhető el. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-account-information |
| get |
Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához. Lásd: https://learn.microsoft.com/rest/api/storageservices/blob-batch |
| get |
ContainerClient objektum létrehozása |
| get |
Lekéri a tárfiók Blob szolgáltatásának tulajdonságait, beleértve a Storage Analytics és a CORS (forrásközi erőforrás-megosztás) szabályok tulajdonságait is. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties |
| get |
Lekéri a Blob szolgáltatás replikációs statisztikáit. Csak akkor érhető el a másodlagos hely végpontján, ha az olvasási hozzáférésű georedundáns replikáció engedélyezve van a tárfiókhoz. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-service-stats |
| get |
CSAK TULAJDONOSI JOGKIVONAT-HITELESÍTÉS (TokenCredential) HASZNÁLATAKOR ÉRHETŐ EL. Lekéri a Blob szolgáltatás felhasználódelegálási kulcsát. Ez csak érvényes művelet, ha tulajdonosi jogkivonat-hitelesítést használ. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key |
| list |
Egy aszinkron iterátort ad vissza, amely felsorolja a megadott fiókban lévő összes tárolót. A .byPage() egy aszinkron iterátorral listázhatja a tárolókat a lapokban.
|
| set |
Beállítja a tárfiók blobszolgáltatás-végpontjának tulajdonságait, beleértve a Storage Analytics tulajdonságait, a CORS (forrásközi erőforrás-megosztás) szabályokat és a helyreállítható törlési beállításokat. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-service-properties |
| undelete |
Korábban törölt Blob-tároló visszaállítása. Ez az API csak akkor működik, ha a tárolóhoz társított tárfiók esetében engedélyezve van a tároló helyreállítható törlése. |
Konstruktor adatai
BlobServiceClient(string, PipelineLike)
Létrehozza a BlobServiceClient egy példányát.
new BlobServiceClient(url: string, pipeline: PipelineLike)
Paraméterek
- url
-
string
Egy Azure Storage-blobszolgáltatásra mutató ügyfélsztring, például "https://myaccount.blob.core.windows.net". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.blob.core.windows.net?sasString".
- pipeline
- PipelineLike
A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Létrehozza a BlobServiceClient egy példányát.
new BlobServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Paraméterek
- url
-
string
Egy Azure Storage-blobszolgáltatásra mutató ügyfélsztring, például "https://myaccount.blob.core.windows.net". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.blob.core.windows.net?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
- options
- StoragePipelineOptions
Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.
Példa a DefaultAzureCredential @azure/identity:
import { DefaultAzureCredential } from "@azure/identity";
import { BlobServiceClient } from "@azure/storage-blob";
// Enter your storage account name
const account = "<account>";
const defaultAzureCredential = new DefaultAzureCredential();
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
defaultAzureCredential,
);
Példa fióknév/kulcs használatával:
import { StorageSharedKeyCredential, BlobServiceClient } from "@azure/storage-blob";
const account = "<account>";
const accountKey = "<accountkey>";
// Use StorageSharedKeyCredential with storage account and account key
// StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
sharedKeyCredential,
);
Örökölt tulajdonság részletei
accountName
accountName: string
Tulajdonság értéke
string
örökölt StorageClient.accountName
credential
Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Tulajdonság értéke
örökölt StorageClient.credential
url
Kódolt URL-sztringérték.
url: string
Tulajdonság értéke
string
örökölt StorageClient.url-címről
Metódus adatai
createContainer(string, ContainerCreateOptions)
Blobtároló létrehozása.
Lásd: https://learn.microsoft.com/rest/api/storageservices/create-container
function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Paraméterek
- containerName
-
string
A létrehozandó tároló neve.
- options
- ContainerCreateOptions
A Tároló létrehozása művelet konfigurálásához szükséges beállítások.
Válaszok
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Tárolólétrehozási válasz és a megfelelő tárolóügyfél.
deleteContainer(string, ContainerDeleteMethodOptions)
Blobtároló törlése.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
Paraméterek
- containerName
-
string
A törölni kívánt tároló neve.
- options
- ContainerDeleteMethodOptions
A tárolótörlési művelet konfigurálására vonatkozó beállítások.
Válaszok
Promise<ContainerDeleteResponse>
Tárolótörlés válasza.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
Egy aszinkron iterátort ad vissza, amely megkeresi a megadott címkével rendelkező összes blobot a megadott fiók alatt.
A .byPage() aszinkron iterátort ad vissza a lapok blobjainak listázásához.
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties
import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";
const account = "<account>";
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
new DefaultAzureCredential(),
);
// Use for await to iterate the blobs
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${blob.name}`);
}
// Use iter.next() to iterate the blobs
i = 1;
const iter = blobServiceClient.findBlobsByTags("tagkey='tagvalue'");
let { value, done } = await iter.next();
while (!done) {
console.log(`Blob ${i++}: ${value.name}`);
({ value, done } = await iter.next());
}
// Use byPage() to iterate the blobs
i = 1;
for await (const page of blobServiceClient
.findBlobsByTags("tagkey='tagvalue'")
.byPage({ maxPageSize: 20 })) {
for (const blob of page.blobs) {
console.log(`Blob ${i++}: ${blob.name}`);
}
}
// Use paging with a marker
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>
Paraméterek
- tagFilterSqlExpression
-
string
A where paraméter lehetővé teszi, hogy a hívó lekérdezhesse azokat a blobokat, amelyek címkéi megegyeznek egy adott kifejezéssel. A megadott kifejezésnek igaznak kell lennie ahhoz, hogy egy blob vissza legyen adva az eredményekben. A[OData – ABNF] szűrőszintaxis-szabály a lekérdezési paraméter értékének formális nyelvtanát határozza meg; A Blob szolgáltatás azonban csak az OData-szűrőszintaxis egy részhalmazát támogatja.
- options
- ServiceFindBlobByTagsOptions
A blobok címkék szerinti keresésének lehetőségei.
Válaszok
fromConnectionString(string, StoragePipelineOptions)
Létrehoz egy BlobServiceClient-példányt a kapcsolati sztringből.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
Paraméterek
- connectionString
-
string
Fiókkapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztringje.
[ Megjegyzés – A fiókkapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Példa fiókkapcsolati sztringre –
DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS kapcsolati sztring példa – 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
Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.
Válaszok
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobServiceClient esetén érhető el.
Létrehoz egy Blob-fiók megosztott hozzáférésű jogosultságkódját (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.
Lásd: https://learn.microsoft.com/rest/api/storageservices/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Paraméterek
- expiresOn
-
Date
Optional. A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Alapértelmezés szerint egy órával később, ha nincs megadva.
- permissions
- AccountSASPermissions
Megadja az SAS-hez társítandó engedélyek listáját.
- resourceTypes
-
string
Megadja a közös hozzáférésű jogosultságkódhoz társított erőforrástípusokat.
Nem kötelező paraméterek.
Válaszok
string
Egy fiók SAS URI-ja, amely az ügyfél által képviselt erőforrás URI-ját tartalmazza, majd a létrehozott SAS-jogkivonatot.
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobServiceClient esetén érhető el.
Sztringet hoz létre egy blobfiók közös hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.
Lásd: https://learn.microsoft.com/rest/api/storageservices/create-account-sas
function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Paraméterek
- expiresOn
-
Date
Optional. A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Alapértelmezés szerint egy órával később, ha nincs megadva.
- permissions
- AccountSASPermissions
Megadja az SAS-hez társítandó engedélyek listáját.
- resourceTypes
-
string
Megadja a közös hozzáférésű jogosultságkódhoz társított erőforrástípusokat.
Nem kötelező paraméterek.
Válaszok
string
Egy fiók SAS URI-ja, amely az ügyfél által képviselt erőforrás URI-ját tartalmazza, majd a létrehozott SAS-jogkivonatot.
getAccountInfo(ServiceGetAccountInfoOptions)
A Fiókadatok lekérése művelet a megadott fiók termékváltozatának nevét és típusát adja vissza. A Fiókadatok lekérése művelet a 2018-03-28-es verziójú szolgáltatásverziókban érhető el.
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-account-information
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
Paraméterek
- options
- ServiceGetAccountInfoOptions
A Szolgáltatás lekérése fiókinformációs művelet beállításai.
Válaszok
Promise<ServiceGetAccountInfoResponse>
A Szolgáltatás lekérése fiókinformációs művelet válaszadatai.
getBlobBatchClient()
Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához.
Lásd: https://learn.microsoft.com/rest/api/storageservices/blob-batch
function getBlobBatchClient(): BlobBatchClient
Válaszok
A szolgáltatás új BlobBatchClient objektuma.
getContainerClient(string)
ContainerClient objektum létrehozása
function getContainerClient(containerName: string): ContainerClient
Paraméterek
- containerName
-
string
Tároló neve
Válaszok
Egy új ContainerClient-objektum a megadott tárolónévhez.
Példahasználat:
import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";
const account = "<account>";
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
new DefaultAzureCredential(),
);
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
Lekéri a tárfiók Blob szolgáltatásának tulajdonságait, beleértve a Storage Analytics és a CORS (forrásközi erőforrás-megosztás) szabályok tulajdonságait is.
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Paraméterek
- options
- ServiceGetPropertiesOptions
A Szolgáltatás lekérése tulajdonságok művelet beállításai.
Válaszok
Promise<ServiceGetPropertiesResponse>
A Szolgáltatás lekérése tulajdonságok művelet válaszadatai.
getStatistics(ServiceGetStatisticsOptions)
Lekéri a Blob szolgáltatás replikációs statisztikáit. Csak akkor érhető el a másodlagos hely végpontján, ha az olvasási hozzáférésű georedundáns replikáció engedélyezve van a tárfiókhoz.
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-service-stats
function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>
Paraméterek
- options
- ServiceGetStatisticsOptions
A Service Get Statistics művelet beállításai.
Válaszok
Promise<ServiceGetStatisticsResponse>
A Service Get Statistics művelet válaszadatai.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
CSAK TULAJDONOSI JOGKIVONAT-HITELESÍTÉS (TokenCredential) HASZNÁLATAKOR ÉRHETŐ EL.
Lekéri a Blob szolgáltatás felhasználódelegálási kulcsát. Ez csak érvényes művelet, ha tulajdonosi jogkivonat-hitelesítést használ.
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Paraméterek
- startsOn
-
Date
A felhasználói delegálási SAS kezdő időpontja. Az aktuális időponttól számított 7 napon belül kell lennie
- expiresOn
-
Date
A felhasználói delegálási SAS befejezési ideje. Az aktuális időponttól számított 7 napon belül kell lennie
Válaszok
Promise<ServiceGetUserDelegationKeyResponse>
listContainers(ServiceListContainersOptions)
Egy aszinkron iterátort ad vissza, amely felsorolja a megadott fiókban lévő összes tárolót.
A .byPage() egy aszinkron iterátorral listázhatja a tárolókat a lapokban.
import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";
const account = "<account>";
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
new DefaultAzureCredential(),
);
// Use for await to iterate the containers
let i = 1;
for await (const container of blobServiceClient.listContainers()) {
console.log(`Container ${i++}: ${container.name}`);
}
// Use iter.next() to iterate the containers
i = 1;
const iter = blobServiceClient.listContainers();
let { value, done } = await iter.next();
while (!done) {
console.log(`Container ${i++}: ${value.name}`);
({ value, done } = await iter.next());
}
// Use byPage() to iterate the containers
i = 1;
for await (const page of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
for (const container of page.containerItems) {
console.log(`Container ${i++}: ${container.name}`);
}
}
// Use paging with a marker
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>
Paraméterek
- options
- ServiceListContainersOptions
Tárolók listázásának lehetőségei.
Válaszok
Lapozást támogató asyncIterableIterator.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Beállítja a tárfiók blobszolgáltatás-végpontjának tulajdonságait, beleértve a Storage Analytics tulajdonságait, a CORS (forrásközi erőforrás-megosztás) szabályokat és a helyreállítható törlési beállításokat.
Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-service-properties
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
Paraméterek
- properties
- BlobServiceProperties
- options
- ServiceSetPropertiesOptions
A Szolgáltatáskészlet tulajdonságai művelet beállításai.
Válaszok
Promise<ServiceSetPropertiesResponse>
A Szolgáltatáskészlet tulajdonságai művelet válaszadatai.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)
Korábban törölt Blob-tároló visszaállítása. Ez az API csak akkor működik, ha a tárolóhoz társított tárfiók esetében engedélyezve van a tároló helyreállítható törlése.
function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Paraméterek
- deletedContainerName
-
string
A korábban törölt tároló neve.
- deletedContainerVersion
-
string
A korábban törölt tároló verziója, amely a törölt tároló egyedi azonosítására szolgál.
- options
- ServiceUndeleteContainerOptions
A tároló-visszaállítási művelet konfigurálásához szükséges beállítások.
Válaszok
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Tárolótörlés válasza.