BlobServiceClient class
BlobServiceClient mewakili Klien ke layanan Azure Storage Blob yang memungkinkan Anda memanipulasi kontainer blob.
- Extends
Konstruktor
Blob |
Membuat instans BlobServiceClient. |
Blob |
Membuat instans BlobServiceClient. |
Properti
account |
|
credential | Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari |
url | Nilai string URL yang dikodekan. |
Metode
create |
Buat kontainer Blob. |
delete |
Menghapus kontainer Blob. |
find |
Mengembalikan iterator yang dapat di-iterasi asinkron untuk menemukan semua blob dengan tag yang ditentukan di bawah akun yang ditentukan. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan blob di halaman. |
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. |
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. |
get |
Membuat objek BlobBatchClient untuk melakukan operasi batch. |
get |
<xref:ContainerClient> Membuat objek |
get |
Mendapatkan properti blob service akun penyimpanan, termasuk properti untuk aturan Storage Analytics dan CORS (Cross-Origin Resource Sharing). |
get |
Mengambil statistik yang terkait dengan replikasi untuk Blob service. Ini hanya tersedia di titik akhir lokasi sekunder ketika replikasi geo-redundan akses baca diaktifkan untuk akun penyimpanan. |
get |
HANYA TERSEDIA SAAT MENGGUNAKAN AUTENTIKASI TOKEN PEMBAWA (TokenCredential). Mengambil kunci delegasi pengguna untuk blob service. Ini hanya operasi yang valid saat menggunakan autentikasi token pembawa. |
list |
Mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan semua kontainer di bawah akun yang ditentukan. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan kontainer di halaman. Contoh menggunakan
Contoh menggunakan
Contoh menggunakan
Contoh menggunakan halaman dengan penanda:
|
set |
Mengatur properti untuk titik akhir Blob service akun penyimpanan, termasuk properti untuk aturan Storage Analytics, CORS (Berbagi Sumber Daya Lintas Asal), dan pengaturan penghapusan sementara. |
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 dikustomisasi.
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 @azure/identity
paket untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.
- options
- StoragePipelineOptions
Opsional. 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
accountName
accountName: string
Nilai Properti
string
credential
Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari @azure/identity
paket 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
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
url
Nilai string URL yang dikodekan.
url: string
Nilai Properti
string
Detail Metode
createContainer(string, ContainerCreateOptions)
Buat kontainer Blob.
function createContainer(containerName: string, options?: ContainerCreateOptions)
Parameter
- containerName
-
string
Nama kontainer yang akan dibuat.
- options
- ContainerCreateOptions
Opsi untuk mengonfigurasi operasi Buat Kontainer.
Mengembalikan
Promise<Object>
Respons pembuatan kontainer dan klien kontainer yang sesuai.
deleteContainer(string, ContainerDeleteMethodOptions)
Menghapus kontainer Blob.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions)
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 di-iterasi asinkron untuk menemukan semua blob dengan tag yang ditentukan di bawah akun yang ditentukan. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan blob di halaman.
function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions)
Parameter
- tagFilterSqlExpression
-
string
Parameter where 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 where; namun, hanya subset sintaks filter OData yang didukung dalam Blob service.
- options
- ServiceFindBlobByTagsOptions
Opsi untuk menemukan blob menurut tag.
Mengembalikan
PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>
fromConnectionString(string, StoragePipelineOptions)
Membuat instans BlobServiceClient dari string koneksi.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions)
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 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Contoh string koneksi SAS - 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
Opsional. 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.
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions)
Parameter
- expiresOn
-
Date
Opsional. Waktu saat 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 dengan 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.
function getAccountInfo(options?: ServiceGetAccountInfoOptions)
Parameter
- options
- ServiceGetAccountInfoOptions
Opsi untuk operasi Info Akun Get Service.
Mengembalikan
Promise<ServiceGetAccountInfoResponse>
Data respons untuk operasi Info Akun Get Service.
getBlobBatchClient()
Membuat objek BlobBatchClient untuk melakukan operasi batch.
function getBlobBatchClient()
Mengembalikan
Objek BlobBatchClient baru untuk layanan ini.
getContainerClient(string)
<xref:ContainerClient> Membuat objek
function getContainerClient(containerName: string)
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 blob service akun penyimpanan, termasuk properti untuk aturan Storage Analytics dan CORS (Cross-Origin Resource Sharing).
function getProperties(options?: ServiceGetPropertiesOptions)
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 Blob service. Ini hanya tersedia di titik akhir lokasi sekunder ketika replikasi geo-redundan akses baca diaktifkan untuk akun penyimpanan.
function getStatistics(options?: ServiceGetStatisticsOptions)
Parameter
- options
- ServiceGetStatisticsOptions
Opsi untuk operasi Statistik Get Layanan.
Mengembalikan
Promise<ServiceGetStatisticsResponse>
Data respons untuk operasi Statistik Dapatkan Layanan.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
HANYA TERSEDIA SAAT MENGGUNAKAN AUTENTIKASI TOKEN PEMBAWA (TokenCredential). Mengambil kunci delegasi pengguna untuk blob service. Ini hanya operasi yang valid saat menggunakan autentikasi token pembawa.
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions)
Parameter
- startsOn
-
Date
Waktu mulai untuk delegasi pengguna SAS. Harus dalam waktu 7 hari dari waktu saat ini
- expiresOn
-
Date
Waktu akhir untuk delegasi pengguna SAS. Harus dalam waktu 7 hari dari waktu saat ini
Mengembalikan
Promise<ServiceGetUserDelegationKeyResponse>
listContainers(ServiceListContainersOptions)
Mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan semua kontainer di bawah akun yang ditentukan. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan kontainer di halaman.
Contoh menggunakan for await
sintaks:
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)
Parameter
- options
- ServiceListContainersOptions
Opsi untuk mencantumkan kontainer.
Mengembalikan
PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>
AsyncIterableIterator yang mendukung paging.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Mengatur properti untuk titik akhir Blob service akun penyimpanan, termasuk properti untuk aturan Storage Analytics, CORS (Berbagi Sumber Daya Lintas Asal), dan pengaturan penghapusan sementara.
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions)
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)
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<Object>
Respons penghapusan kontainer.
Azure SDK for JavaScript