BlobServiceClient class
BlobServiceClient představuje klienta do služby Azure Storage Blob Service, která umožňuje manipulovat s kontejnery objektů blob.
- Extends
-
StorageClient
Konstruktory
Blob |
Vytvoří instanci BlobServiceClient. |
Blob |
Vytvoří instanci BlobServiceClient. |
Zděděné vlastnosti
account |
|
credential | Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku |
url | Zakódovaná hodnota řetězce adresy URL. |
Metody
create |
Vytvořte kontejner objektů blob. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
delete |
Odstraní kontejner objektů blob. |
find |
Vrátí asynchronní iterátor pro vyhledání všech objektů blob se zadanou značkou pod zadaným účtem. .byPage() vrátí asynchronní iterátor pro výpis objektů blob na stránkách. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties Příklad použití syntaxe
Příklad použití
Příklad použití
Příklad použití stránkování se značkou:
|
from |
Vytvoří instanci BlobServiceClient z připojovacího řetězce. |
generate |
K dispozici pouze pro objekt BlobServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu účtu objektu blob na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
generate |
K dispozici pouze pro objekt BlobServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje řetězec pro podepsání identifikátoru URI SDÍLENÉHO přístupového podpisu (SAS) účtu objektu blob na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
get |
Operace Získat informace o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služby od verze 2018-03-28. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Vytvoří objekt BlobBatchClient pro provádění dávkových operací. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
get |
Vytvoří objekt ContainerClient. |
get |
Získá vlastnosti služby Blob služby účtu úložiště, včetně vlastností pro pravidla analýzy úložiště a CORS (sdílení prostředků mezi zdroji). Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
Načte statistiky související s replikací pro službu Blob Service. Je k dispozici pouze na koncovém bodu sekundárního umístění, pokud je pro účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats |
get |
K DISPOZICI POUZE PŘI POUŽITÍ OVĚŘOVÁNÍ NOSNÝ TOKEN (TokenCredential). Načte klíč delegování uživatele pro službu Blob Service. Jedná se pouze o platnou operaci při použití ověřování nosné tokeny. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key |
list |
Vrátí asynchronní iterátor pro výpis všech kontejnerů v rámci zadaného účtu. .byPage() vrátí asynchronní iterátor pro výpis kontejnerů na stránkách. Příklad použití syntaxe
Příklad použití
Příklad použití
Příklad použití stránkování se značkou:
|
set |
Nastaví vlastnosti pro koncový bod služby Blob service účtu úložiště, včetně vlastností pro analýzy úložiště, pravidel CORS (sdílení prostředků mezi zdroji) a nastavení obnovitelného odstranění. Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
Obnovení dříve odstraněného kontejneru objektů blob Toto rozhraní API je funkční pouze v případě, že pro účet úložiště přidruženého k kontejneru je povolené obnovitelné odstranění kontejneru. |
Podrobnosti konstruktoru
BlobServiceClient(string, PipelineLike)
Vytvoří instanci BlobServiceClient.
new BlobServiceClient(url: string, pipeline: PipelineLike)
Parametry
- url
-
string
Řetězec klienta odkazující na službu Objektů blob služby Azure Storage, například "https://myaccount.blob.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net?sasString".
- pipeline
- PipelineLike
Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený kanál.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Vytvoří instanci BlobServiceClient.
new BlobServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametry
- url
-
string
Řetězec klienta odkazující na službu Objektů blob služby Azure Storage, například "https://myaccount.blob.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity
k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
- options
- StoragePipelineOptions
Volitelný. Možnosti konfigurace kanálu HTTP
Příklad použití DefaultAzureCredential z @azure/identity
:
const account = "<storage account name>";
const defaultAzureCredential = new DefaultAzureCredential();
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
defaultAzureCredential
);
Příklad použití názvu nebo klíče účtu:
const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
sharedKeyCredential
);
Podrobnosti zděděných vlastností
accountName
accountName: string
Hodnota vlastnosti
string
zděděno ze StorageClient.accountName
credential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity
k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Hodnota vlastnosti
zděděné z StorageClient.credential
url
Zakódovaná hodnota řetězce adresy URL.
url: string
Hodnota vlastnosti
string
zděděno ze StorageClient.url
Podrobnosti metody
createContainer(string, ContainerCreateOptions)
Vytvořte kontejner objektů blob.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Parametry
- containerName
-
string
Název kontejneru, který se má vytvořit.
- options
- ContainerCreateOptions
Možnosti konfigurace operace vytvoření kontejneru
Návraty
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Odpověď na vytvoření kontejneru a odpovídající klient kontejneru
deleteContainer(string, ContainerDeleteMethodOptions)
Odstraní kontejner objektů blob.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
Parametry
- containerName
-
string
Název kontejneru, který chcete odstranit.
- options
- ContainerDeleteMethodOptions
Možnosti konfigurace operace odstranění kontejneru
Návraty
Promise<ContainerDeleteResponse>
Odpověď na odstranění kontejneru
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
Vrátí asynchronní iterátor pro vyhledání všech objektů blob se zadanou značkou pod zadaným účtem.
.byPage() vrátí asynchronní iterátor pro výpis objektů blob na stránkách.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
Příklad použití syntaxe for await
:
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
Příklad použití 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říklad použití 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říklad použití stránkování se značkou:
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>
Parametry
- tagFilterSqlExpression
-
string
Parametr where volajícímu umožňuje dotazovat se na objekty blob, jejichž značky odpovídají danému výrazu. Daný výraz musí být vyhodnocen jako true, aby se objekt blob vrátil ve výsledcích. Pravidlo syntaxe filtru [OData - ABNF] definuje formální gramatiku pro hodnotu parametru dotazu where; Ale pouze podmnožina syntaxe filtru OData je podporována ve službě Blob Service.
- options
- ServiceFindBlobByTagsOptions
Možnosti vyhledání objektů blob podle značek
Návraty
fromConnectionString(string, StoragePipelineOptions)
Vytvoří instanci BlobServiceClient z připojovacího řetězce.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
Parametry
- connectionString
-
string
Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure.
[ Poznámka: Připojovací řetězec účtu lze použít pouze v NODE.JS modulu runtime. ] Příklad připojovacího řetězce účtu – Příklad připojovacího řetězce SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
– 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
Volitelný. Možnosti konfigurace kanálu HTTP
Návraty
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
K dispozici pouze pro objekt BlobServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.
Vygeneruje identifikátor URI sdíleného přístupového podpisu účtu objektu blob na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parametry
- expiresOn
-
Date
Volitelný. Čas, kdy se sdílený přístupový podpis stane neplatným. Výchozí hodnota je hodina později, pokud není k dispozici.
- permissions
- AccountSASPermissions
Určuje seznamoprávněních
- resourceTypes
-
string
Určuje typy prostředků přidružené ke sdílenému přístupovém podpisu.
Volitelné parametry.
Návraty
string
Identifikátor URI SAS účtu, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
K dispozici pouze pro objekt BlobServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.
Vygeneruje řetězec pro podepsání identifikátoru URI SDÍLENÉHO přístupového podpisu (SAS) účtu objektu blob na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parametry
- expiresOn
-
Date
Volitelný. Čas, kdy se sdílený přístupový podpis stane neplatným. Výchozí hodnota je hodina později, pokud není k dispozici.
- permissions
- AccountSASPermissions
Určuje seznamoprávněních
- resourceTypes
-
string
Určuje typy prostředků přidružené ke sdílenému přístupovém podpisu.
Volitelné parametry.
Návraty
string
Identifikátor URI SAS účtu, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.
getAccountInfo(ServiceGetAccountInfoOptions)
Operace Získat informace o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služby od verze 2018-03-28.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
Parametry
- options
- ServiceGetAccountInfoOptions
Možnosti operace Získání informací o účtu služby
Návraty
Promise<ServiceGetAccountInfoResponse>
Data odpovědí pro operaci Získání informací o účtu služby
getBlobBatchClient()
Vytvoří objekt BlobBatchClient pro provádění dávkových operací.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
function getBlobBatchClient(): BlobBatchClient
Návraty
Nový objekt BlobBatchClient pro tuto službu.
getContainerClient(string)
Vytvoří objekt ContainerClient.
function getContainerClient(containerName: string): ContainerClient
Parametry
- containerName
-
string
Název kontejneru
Návraty
Nový objekt ContainerClient pro daný název kontejneru.
Příklad použití:
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
Získá vlastnosti služby Blob služby účtu úložiště, včetně vlastností pro pravidla analýzy úložiště a CORS (sdílení prostředků mezi zdroji).
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Parametry
- options
- ServiceGetPropertiesOptions
Možnosti operace Získání vlastností služby
Návraty
Promise<ServiceGetPropertiesResponse>
Data odpovědí pro operaci Získání vlastností služby
getStatistics(ServiceGetStatisticsOptions)
Načte statistiky související s replikací pro službu Blob Service. Je k dispozici pouze na koncovém bodu sekundárního umístění, pokud je pro účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>
Parametry
- options
- ServiceGetStatisticsOptions
Možnosti operace Získání statistiky služby
Návraty
Promise<ServiceGetStatisticsResponse>
Data odpovědí pro operaci Získání statistiky služby
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
K DISPOZICI POUZE PŘI POUŽITÍ OVĚŘOVÁNÍ NOSNÝ TOKEN (TokenCredential).
Načte klíč delegování uživatele pro službu Blob Service. Jedná se pouze o platnou operaci při použití ověřování nosné tokeny.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Parametry
- startsOn
-
Date
Čas zahájení sdíleného přístupového podpisu delegování uživatele Musí být do 7 dnů od aktuálního času.
- expiresOn
-
Date
Koncový čas sdíleného přístupového podpisu delegování uživatele. Musí být do 7 dnů od aktuálního času.
Návraty
Promise<ServiceGetUserDelegationKeyResponse>
listContainers(ServiceListContainersOptions)
Vrátí asynchronní iterátor pro výpis všech kontejnerů v rámci zadaného účtu.
.byPage() vrátí asynchronní iterátor pro výpis kontejnerů na stránkách.
Příklad použití syntaxe for await
:
let i = 1;
for await (const container of blobServiceClient.listContainers()) {
console.log(`Container ${i++}: ${container.name}`);
}
Příklad použití 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říklad použití 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říklad použití stránkování se značkou:
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>
Parametry
- options
- ServiceListContainersOptions
Možnosti pro výpis kontejnerů
Návraty
AsyncIterableIterator, který podporuje stránkování.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Nastaví vlastnosti pro koncový bod služby Blob service účtu úložiště, včetně vlastností pro analýzy úložiště, pravidel CORS (sdílení prostředků mezi zdroji) a nastavení obnovitelného odstranění.
Podívejte se na https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
Parametry
- properties
- BlobServiceProperties
- options
- ServiceSetPropertiesOptions
Možnosti operace Vlastnosti sady služeb
Návraty
Promise<ServiceSetPropertiesResponse>
Data odpovědí pro operaci vlastností sady služeb.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)
Obnovení dříve odstraněného kontejneru objektů blob Toto rozhraní API je funkční pouze v případě, že pro účet úložiště přidruženého k kontejneru je povolené obnovitelné odstranění kontejneru.
function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Parametry
- deletedContainerName
-
string
Název dříve odstraněného kontejneru
- deletedContainerVersion
-
string
Verze dříve odstraněného kontejneru, která slouží k jednoznačné identifikaci odstraněného kontejneru.
- options
- ServiceUndeleteContainerOptions
Možnosti konfigurace operace obnovení kontejneru
Návraty
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Odpověď na odstranění kontejneru