Megosztás a következőn keresztül:

BlobServiceClient class

  • Referencia
Csomag:
@azure/storage-blob

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

BlobServiceClient(string, PipelineLike)

Létrehoz egy BlobServiceClient-példányt.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehoz egy BlobServiceClient-példányt.

Tulajdonságok

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.
url

Kódolt URL-sztringérték.

Metódusok

createContainer(string, ContainerCreateOptions)

Blobtároló létrehozása.
deleteContainer(string, ContainerDeleteMethodOptions)

Blobtároló törlése.
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.
fromConnectionString(string, StoragePipelineOptions)

Létrehoz egy BlobServiceClient-példányt a kapcsolati sztring.
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á.
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.
getBlobBatchClient()

Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához.
getContainerClient(string)

Objektum létrehozása <xref:ContainerClient>
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.
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.
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.
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}`);
  }
}
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.
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.

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 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 csomag bármely hitelesítő adata a @azure/identity szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential felületet. Ha nincs megadva, az AnonymousCredential lesz használva.

options
StoragePipelineOptions

Választható. A HTTP-folyamat konfigurálásának beállításai.

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
);

Tulajdonság adatai

accountName 

accountName: string

Tulajdonság értéke

string

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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

Metódus adatai

createContainer(string, ContainerCreateOptions)

Blobtároló létrehozása.

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

Paraméterek

containerName

string

A létrehozandó tároló neve.

options
ContainerCreateOptions

A Container Create művelet konfigurálásának beállításai.

Válaszok

Promise<Object>

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)

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.

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

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. Az adott kifejezésnek igaz értékre kell kiértékelnie, 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 nyelvhelyességi értéké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 megkeresésének lehetőségei.

Válaszok

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>

fromConnectionString(string, StoragePipelineOptions)

Létrehoz egy BlobServiceClient-példányt a kapcsolati sztring.

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

Paraméterek

connectionString

string

Azure Storage-fiók fiók kapcsolati sztring vagy 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.netSAS 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

BlobServiceClient

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á.

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions)

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.

options
ServiceGenerateAccountSasUrlOptions

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.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

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.

function getBlobBatchClient()

Válaszok

BlobBatchClient

A szolgáltatás új BlobBatchClient objektuma.

getContainerClient(string)

Objektum létrehozása <xref:ContainerClient>

function getContainerClient(containerName: string)

Paraméterek

containerName

string

Tároló neve

Válaszok

ContainerClient

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.

function getProperties(options?: ServiceGetPropertiesOptions)

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.

function getStatistics(options?: ServiceGetStatisticsOptions)

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.

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

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

options
ServiceGetUserDelegationKeyOptions

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)

Paraméterek

options
ServiceListContainersOptions

Tárolók listázására szolgáló lehetőségek.

Válaszok

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

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.

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

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)

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<Object>

Tárolótörlésre adott válasz.