BlobServiceClient class
A BlobServiceClient az Azure Storage Blob szolgáltatáshoz tartozó ügyfelet jelöli, amely lehetővé teszi a blobtárolók manipulálását.
- Extends
-
StorageClient
Konstruktorok
Blob |
Létrehoz egy BlobServiceClient-példányt. |
Blob |
Létrehoz egy BlobServiceClient-példányt. |
Örökölt tulajdonságok
account |
|
credential | Például AnonymousCredential, StorageSharedKeyCredential vagy bármilyen hitelesítő adat a csomagból a |
url | Kódolt URL-sztringérték. |
Metódusok
create |
Blobtároló létrehozása. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
delete |
Blobtároló törlése. |
find |
Egy aszinkron iterátorral adja vissza az összes olyan blobot, amely a megadott címkével rendelkezik a megadott fiók alatt. A .byPage() egy aszinkron iterátorral listázhatja a blobokat a lapokban. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties Példa szintaxis használatával
Példa a használatával
Példa a használatával
Példa jelölővel ellátott lapozásra:
|
from |
Létrehozza a BlobServiceClient egy példányát kapcsolati sztring. |
generate |
Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobServiceClient esetén érhető el. Létrehoz egy Blob-fiók közös hozzáférésű jogosultságkód (SAS) URI-já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://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
get |
A Fiókadatok lekérése művelet visszaadja a megadott fiók termékváltozatának nevét és fióktípusát. A Fiókadatok lekérése művelet a 2018-03-28-es verziótól kezdődő szolgáltatásverziókban érhető el. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
get |
ContainerClient objektum létrehozása |
get |
Lekéri egy tárfiók Blob szolgáltatásának tulajdonságait, beleértve a Storage Analytics és a CORS (eltérő eredetű erőforrás-megosztás) szabályok tulajdonságait. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
Lekéri a Blob szolgáltatás replikációval kapcsolatos 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ója engedélyezve van a tárfiókban. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats |
get |
CSAK TULAJDONOSI JOGKIVONAT-HITELESÍTÉS (TokenCredential) HASZNÁLATA ESETÉN ÉRHETŐ EL. Lekéri a Blob szolgáltatás felhasználódelegálási kulcsát. Ez csak a tulajdonosi jogkivonat-hitelesítés használatakor érvényes művelet. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key |
list |
Egy aszinkron iterálót ad vissza a megadott fiók összes tárolójának listázásához. A .byPage() egy aszinkron iterátorral listázhatja a tárolókat a lapokon. Példa szintaxis használatával
Példa a használatával
Példa a használatával
Példa jelölővel ellátott lapozásra:
|
set |
Beállítja a tárfiók Blob-szolgáltatásvé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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
Egy korábban törölt Blob-tároló visszaállítása. Ez az API csak akkor működik, ha a tároló helyreállítható törlése engedélyezve van a tárolóhoz társított tárfiókhoz. |
Konstruktor adatai
BlobServiceClient(string, PipelineLike)
Létrehoz egy BlobServiceClient-példányt.
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". Sas hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.blob.core.windows.net?sasString".
- pipeline
- PipelineLike
Hívja meg a newPipeline() parancsot egy alapértelmezett folyamat létrehozásához, vagy adjon meg egy testre szabott folyamatot.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Létrehoz egy BlobServiceClient-példányt.
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". Sas hozzáfűzhető, ha AnonymousCredential (pl. "https://myaccount.blob.core.windows.net?sasString") használatával használja.
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Például AnonymousCredential, StorageSharedKeyCredential vagy bármilyen hitelesítő adat a csomagból a @azure/identity
szolgáltatás felé irányuló kérések hitelesítéséhez. Megadhat egy objektumot is, amely implementálja a TokenCredential felületet. Ha nincs megadva, a rendszer AnonymousCredential értéket használ.
- options
- StoragePipelineOptions
Választható. A HTTP-folyamat konfigurálásának lehetőségei.
Példa a defaultAzureCredential parancsra a következőből @azure/identity
:
const account = "<storage account name>";
const defaultAzureCredential = new DefaultAzureCredential();
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
defaultAzureCredential
);
Példa fióknév/kulcs használatával:
const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
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 forrás StorageClient.accountName
credential
Például AnonymousCredential, StorageSharedKeyCredential vagy bármilyen hitelesítő adat a csomagból a @azure/identity
szolgáltatás felé irányuló kérések hitelesítéséhez. Megadhat egy objektumot is, amely implementálja a TokenCredential felületet. Ha nincs megadva, a rendszer AnonymousCredential értéket használ.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Tulajdonság értéke
Örökölt forrás StorageClient.credential
url
Kódolt URL-sztringérték.
url: string
Tulajdonság értéke
string
Örökölt forrás StorageClient.url
Metódus adatai
createContainer(string, ContainerCreateOptions)
Blobtároló létrehozása.
Lásd: https://docs.microsoft.com/en-us/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
Tároló-létrehozási művelet konfigurálásának beállításai.
Válaszok
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
A 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
Tárolótörlési művelet konfigurálásának beállításai.
Válaszok
Promise<ContainerDeleteResponse>
Tárolótörlésre adott válasz.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
Egy aszinkron iterátorral adja vissza az összes olyan blobot, amely a megadott címkével rendelkezik a megadott fiók alatt.
A .byPage() egy aszinkron iterátorral listázhatja a blobokat a lapokban.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
Példa szintaxis használatával for await
:
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
Példa a használatával 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();
}
Példa a használatával 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}`);
}
}
}
Példa jelölővel ellátott lapozásra:
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>
Paraméterek
- tagFilterSqlExpression
-
string
A where paraméterrel a hívó lekérdezheti azokat a blobokat, amelyek címkéi megegyeznek egy adott kifejezéssel. A megadott kifejezésnek igaz értéket kell adnia ahhoz, hogy egy blob vissza legyen adva az eredményekben. A[OData – ABNF] szűrőszintaxis-szabály a where 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
Blobok keresésének lehetőségei címkék szerint.
Válaszok
fromConnectionString(string, StoragePipelineOptions)
Létrehozza a BlobServiceClient egy példányát kapcsolati sztring.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
Paraméterek
- connectionString
-
string
Fiók kapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztring.
[ Megjegyzés – A fiók kapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Fiók kapcsolati sztring példa –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
Választható. A HTTP-folyamat konfigurálásának lehetőségei.
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 közös hozzáférésű jogosultságkód (SAS) URI-já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://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Paraméterek
- expiresOn
-
Date
Választható. 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.
Választható paraméterek.
Válaszok
string
Egy fiók SAS URI-ja, amely az ügyfél által képviselt erőforrás URI-ját, majd a létrehozott SAS-jogkivonatot tartalmazza.
getAccountInfo(ServiceGetAccountInfoOptions)
A Fiókadatok lekérése művelet visszaadja a megadott fiók termékváltozatának nevét és fióktípusát. A Fiókadatok lekérése művelet a 2018-03-28-es verziótól kezdődő szolgáltatásverziókban érhető el.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
Paraméterek
- options
- ServiceGetAccountInfoOptions
A Szolgáltatás fiókadatok lekérése művelet beállításai.
Válaszok
Promise<ServiceGetAccountInfoResponse>
A Szolgáltatás fiókadatok lekérése művelet válaszadatai.
getBlobBatchClient()
Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához.
Lásd: https://docs.microsoft.com/en-us/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:
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
Lekéri egy tárfiók Blob szolgáltatásának tulajdonságait, beleértve a Storage Analytics és a CORS (eltérő eredetű erőforrás-megosztás) szabályok tulajdonságait.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Paraméterek
- options
- ServiceGetPropertiesOptions
A Szolgáltatás tulajdonságainak lekérése művelet beállításai.
Válaszok
Promise<ServiceGetPropertiesResponse>
A Szolgáltatás tulajdonságainak lekérése művelet válaszadatai.
getStatistics(ServiceGetStatisticsOptions)
Lekéri a Blob szolgáltatás replikációval kapcsolatos 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ója engedélyezve van a tárfiókban.
Lásd: https://docs.microsoft.com/en-us/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ÁLATA ESETÉN ÉRHETŐ EL.
Lekéri a Blob szolgáltatás felhasználódelegálási kulcsát. Ez csak a tulajdonosi jogkivonat-hitelesítés használatakor érvényes művelet.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Paraméterek
- startsOn
-
Date
A felhasználó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ó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álót ad vissza a megadott fiók összes tárolójának listázásához.
A .byPage() egy aszinkron iterátorral listázhatja a tárolókat a lapokon.
Példa szintaxis használatával for await
:
let i = 1;
for await (const container of blobServiceClient.listContainers()) {
console.log(`Container ${i++}: ${container.name}`);
}
Példa a használatával 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();
}
Példa a használatával 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}`);
}
}
}
Példa jelölővel ellátott lapozásra:
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>
Paraméterek
- options
- ServiceListContainersOptions
Tárolók listázására szolgáló lehetőségek.
Válaszok
Lapozást támogató asyncIterableIterator.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Beállítja a tárfiók Blob-szolgáltatásvé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://docs.microsoft.com/en-us/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)
Egy korábban törölt Blob-tároló visszaállítása. Ez az API csak akkor működik, ha a tároló helyreállítható törlése engedélyezve van a tárolóhoz társított tárfiókhoz.
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
Tároló-visszaállítási művelet konfigurálásának beállításai.
Válaszok
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Tárolótörlésre adott válasz.