BlobServiceClient class
BlobServiceClient mewakili Klien ke layanan Azure Storage Blob yang memungkinkan Anda memanipulasi kontainer blob.
- Memperluas
-
StorageClient
Konstruktor
Blob |
Membuat instans BlobServiceClient. |
Blob |
Membuat instans BlobServiceClient. |
Properti yang Diwariskan
account |
|
credential | Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket |
url | Nilai string URL yang dikodekan. |
Metode
create |
Buat kontainer Blob. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/create-container |
delete |
Menghapus kontainer Blob. |
find |
Mengembalikan iterator yang dapat diulang asinkron untuk menemukan semua blob dengan tag yang ditentukan di bawah akun yang ditentukan. .byPage() mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan blob di halaman. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties Contoh menggunakan sintaks
Contoh menggunakan
Contoh menggunakan
Contoh menggunakan halaman dengan penanda:
|
from |
Membuat instans BlobServiceClient dari string koneksi. |
generate |
Hanya tersedia untuk BlobServiceClient yang dibangun dengan kredensial kunci bersama. Menghasilkan URI Tanda Tangan Akses Bersama (SAS) akun Blob berdasarkan properti dan parameter klien yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
generate |
Hanya tersedia untuk BlobServiceClient yang dibangun dengan kredensial kunci bersama. Menghasilkan string untuk menandatangani URI Tanda Tangan Akses Bersama (SAS) akun Blob berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
get |
Operasi Dapatkan Informasi Akun mengembalikan nama sku dan jenis akun untuk akun yang ditentukan. Operasi Dapatkan Informasi Akun tersedia pada versi layanan yang dimulai dengan versi 2018-03-28. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Membuat objek BlobBatchClient untuk melakukan operasi batch. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch |
get |
|
get |
Mendapatkan properti layanan Blob akun penyimpanan, termasuk properti untuk aturan Storage Analytics dan CORS (Berbagi Sumber Daya Lintas Asal). Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
Mengambil statistik yang terkait dengan replikasi untuk layanan Blob. Ini hanya tersedia di titik akhir lokasi sekunder ketika replikasi geo-redundan akses baca diaktifkan untuk akun penyimpanan. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats |
get |
HANYA TERSEDIA SAAT MENGGUNAKAN AUTENTIKASI TOKEN PEMBAWA (TokenCredential). Mengambil kunci delegasi pengguna untuk layanan Blob. Ini hanya operasi yang valid saat menggunakan autentikasi token pembawa. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key |
list |
Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua kontainer di bawah akun yang ditentukan. .byPage() mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan kontainer di halaman. Contoh menggunakan sintaks
Contoh menggunakan
Contoh menggunakan
Contoh menggunakan halaman dengan penanda:
|
set |
Mengatur properti untuk titik akhir layanan Blob akun penyimpanan, termasuk properti untuk aturan Storage Analytics, CORS (Berbagi Sumber Daya Lintas Asal), dan pengaturan penghapusan sementara. Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
Memulihkan kontainer Blob yang dihapus sebelumnya. API ini hanya berfungsi jika Penghapusan Sementara Kontainer diaktifkan untuk akun penyimpanan yang terkait dengan kontainer. |
Detail Konstruktor
BlobServiceClient(string, PipelineLike)
Membuat instans BlobServiceClient.
new BlobServiceClient(url: string, pipeline: PipelineLike)
Parameter
- url
-
string
String Klien yang menunjuk ke layanan blob Azure Storage, seperti "https://myaccount.blob.core.windows.net". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.blob.core.windows.net?sasString".
- pipeline
- PipelineLike
Panggil newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Membuat instans BlobServiceClient.
new BlobServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parameter
- url
-
string
String Klien yang menunjuk ke layanan blob Azure Storage, seperti "https://myaccount.blob.core.windows.net". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.blob.core.windows.net?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity
untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.
- options
- StoragePipelineOptions
Fakultatif. Opsi untuk mengonfigurasi alur HTTP.
Contoh menggunakan DefaultAzureCredential dari @azure/identity
:
const account = "<storage account name>";
const defaultAzureCredential = new DefaultAzureCredential();
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
defaultAzureCredential
);
Contoh menggunakan nama/kunci akun:
const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
sharedKeyCredential
);
Detail Properti yang Diwariskan
accountName
accountName: string
Nilai Properti
string
Diwarisi Dari StorageClient.accountName
credential
Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity
untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Nilai Properti
Diwarisi Dari StorageClient.credential
url
Nilai string URL yang dikodekan.
url: string
Nilai Properti
string
Diwariskan Dari StorageClient.url
Detail Metode
createContainer(string, ContainerCreateOptions)
Buat kontainer Blob.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Parameter
- containerName
-
string
Nama kontainer yang akan dibuat.
- options
- ContainerCreateOptions
Opsi untuk mengonfigurasi operasi Buat Kontainer.
Mengembalikan
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Respons pembuatan kontainer dan klien kontainer yang sesuai.
deleteContainer(string, ContainerDeleteMethodOptions)
Menghapus kontainer Blob.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
Parameter
- containerName
-
string
Nama kontainer yang akan dihapus.
- options
- ContainerDeleteMethodOptions
Opsi untuk mengonfigurasi operasi Penghapusan Kontainer.
Mengembalikan
Promise<ContainerDeleteResponse>
Respons penghapusan kontainer.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
Mengembalikan iterator yang dapat diulang asinkron untuk menemukan semua blob dengan tag yang ditentukan di bawah akun yang ditentukan.
.byPage() mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan blob di halaman.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
Contoh menggunakan sintaks for await
:
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
Contoh menggunakan 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();
}
Contoh menggunakan 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}`);
}
}
}
Contoh menggunakan halaman dengan penanda:
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>
Parameter
- tagFilterSqlExpression
-
string
Parameter di mana memungkinkan pemanggil untuk mengkueri blob yang tagnya cocok dengan ekspresi tertentu. Ekspresi yang diberikan harus mengevaluasi ke true agar blob dikembalikan dalam hasil. Aturan sintaks filter[OData - ABNF] menentukan tata bahasa formal untuk nilai parameter kueri di mana; namun, hanya subset sintaks filter OData yang didukung dalam layanan Blob.
- options
- ServiceFindBlobByTagsOptions
Opsi untuk menemukan blob menurut tag.
Mengembalikan
fromConnectionString(string, StoragePipelineOptions)
Membuat instans BlobServiceClient dari string koneksi.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
Parameter
- connectionString
-
string
String koneksi akun atau string koneksi SAS dari akun penyimpanan Azure.
[ Catatan - String koneksi akun hanya dapat digunakan dalam runtime NODE.JS. ] Contoh string koneksi akun - contoh string koneksi 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
Fakultatif. Opsi untuk mengonfigurasi alur HTTP.
Mengembalikan
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Hanya tersedia untuk BlobServiceClient yang dibangun dengan kredensial kunci bersama.
Menghasilkan URI Tanda Tangan Akses Bersama (SAS) akun Blob berdasarkan properti dan parameter klien yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parameter
- expiresOn
-
Date
Fakultatif. Waktu tanda tangan akses bersama menjadi tidak valid. Default ke satu jam kemudian jika tidak disediakan.
- permissions
- AccountSASPermissions
Menentukan daftar izin yang akan dikaitkan dengan SAS.
- resourceTypes
-
string
Menentukan jenis sumber daya yang terkait dengan tanda tangan akses bersama.
Parameter opsional.
Mengembalikan
string
Akun SAS URI yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti oleh token SAS yang dihasilkan.
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Hanya tersedia untuk BlobServiceClient yang dibangun dengan kredensial kunci bersama.
Menghasilkan string untuk menandatangani URI Tanda Tangan Akses Bersama (SAS) akun Blob berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parameter
- expiresOn
-
Date
Fakultatif. Waktu tanda tangan akses bersama menjadi tidak valid. Default ke satu jam kemudian jika tidak disediakan.
- permissions
- AccountSASPermissions
Menentukan daftar izin yang akan dikaitkan dengan SAS.
- resourceTypes
-
string
Menentukan jenis sumber daya yang terkait dengan tanda tangan akses bersama.
Parameter opsional.
Mengembalikan
string
Akun SAS URI yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti oleh token SAS yang dihasilkan.
getAccountInfo(ServiceGetAccountInfoOptions)
Operasi Dapatkan Informasi Akun mengembalikan nama sku dan jenis akun untuk akun yang ditentukan. Operasi Dapatkan Informasi Akun tersedia pada versi layanan yang dimulai dengan versi 2018-03-28.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
Parameter
- options
- ServiceGetAccountInfoOptions
Opsi untuk operasi Info Dapatkan Akun Layanan.
Mengembalikan
Promise<ServiceGetAccountInfoResponse>
Data respons untuk operasi Info Akun Get Service.
getBlobBatchClient()
Membuat objek BlobBatchClient untuk melakukan operasi batch.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
function getBlobBatchClient(): BlobBatchClient
Mengembalikan
Objek BlobBatchClient baru untuk layanan ini.
getContainerClient(string)
function getContainerClient(containerName: string): ContainerClient
Parameter
- containerName
-
string
Nama kontainer
Mengembalikan
Objek ContainerClient baru untuk nama kontainer yang diberikan.
Contoh penggunaan:
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
Mendapatkan properti layanan Blob akun penyimpanan, termasuk properti untuk aturan Storage Analytics dan CORS (Berbagi Sumber Daya Lintas Asal).
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Parameter
- options
- ServiceGetPropertiesOptions
Opsi untuk operasi Properti Dapatkan Layanan.
Mengembalikan
Promise<ServiceGetPropertiesResponse>
Data respons untuk operasi Properti Dapatkan Layanan.
getStatistics(ServiceGetStatisticsOptions)
Mengambil statistik yang terkait dengan replikasi untuk layanan Blob. Ini hanya tersedia di titik akhir lokasi sekunder ketika replikasi geo-redundan akses baca diaktifkan untuk akun penyimpanan.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>
Parameter
- options
- ServiceGetStatisticsOptions
Opsi untuk operasi Statistik Dapatkan Layanan.
Mengembalikan
Promise<ServiceGetStatisticsResponse>
Data respons untuk operasi Statistik Get Layanan.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
HANYA TERSEDIA SAAT MENGGUNAKAN AUTENTIKASI TOKEN PEMBAWA (TokenCredential).
Mengambil kunci delegasi pengguna untuk layanan Blob. Ini hanya operasi yang valid saat menggunakan autentikasi token pembawa.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Parameter
- startsOn
-
Date
Waktu mulai untuk SAS delegasi pengguna. Harus dalam waktu 7 hari dari waktu saat ini
- expiresOn
-
Date
Waktu akhir untuk SAS delegasi pengguna. Harus dalam waktu 7 hari dari waktu saat ini
Mengembalikan
Promise<ServiceGetUserDelegationKeyResponse>
listContainers(ServiceListContainersOptions)
Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua kontainer di bawah akun yang ditentukan.
.byPage() mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan kontainer di halaman.
Contoh menggunakan sintaks for await
:
let i = 1;
for await (const container of blobServiceClient.listContainers()) {
console.log(`Container ${i++}: ${container.name}`);
}
Contoh menggunakan 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();
}
Contoh menggunakan 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}`);
}
}
}
Contoh menggunakan halaman dengan penanda:
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>
Parameter
- options
- ServiceListContainersOptions
Opsi untuk mencantumkan kontainer.
Mengembalikan
AsyncIterableIterator yang mendukung halaman.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Mengatur properti untuk titik akhir layanan Blob akun penyimpanan, termasuk properti untuk aturan Storage Analytics, CORS (Berbagi Sumber Daya Lintas Asal), dan pengaturan penghapusan sementara.
Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
Parameter
- properties
- BlobServiceProperties
- options
- ServiceSetPropertiesOptions
Opsi untuk operasi Properti Set Layanan.
Mengembalikan
Promise<ServiceSetPropertiesResponse>
Data respons untuk operasi Properti Set Layanan.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)
Memulihkan kontainer Blob yang dihapus sebelumnya. API ini hanya berfungsi jika Penghapusan Sementara Kontainer diaktifkan untuk akun penyimpanan yang terkait dengan kontainer.
function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Parameter
- deletedContainerName
-
string
Nama kontainer yang dihapus sebelumnya.
- deletedContainerVersion
-
string
Versi kontainer yang dihapus sebelumnya, digunakan untuk mengidentifikasi kontainer yang dihapus secara unik.
- options
- ServiceUndeleteContainerOptions
Opsi untuk mengonfigurasi operasi Pemulihan Kontainer.
Mengembalikan
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Respons penghapusan kontainer.