BlobServiceClient class
BlobServiceClient, Blob kapsayıcılarını işlemenize olanak sağlayan Azure Depolama Blob hizmetine yönelik bir İstemciyi temsil eder.
- Extends
-
StorageClient
Oluşturucular
Blob |
BlobServiceClient örneği oluşturur. |
Blob |
BlobServiceClient örneği oluşturur. |
Devralınan Özellikler
account |
|
credential | AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için |
url | Kodlanmış URL dizesi değeri. |
Yöntemler
create |
Blob kapsayıcısı oluşturma. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/create-container |
delete |
Blob kapsayıcıyı siler. |
find |
Belirtilen hesabın altında belirtilen etikete sahip tüm blobları bulmak için zaman uyumsuz bir yinelenebilir yineleyici döndürür. .byPage() sayfalardaki blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
İşaretçi ile disk belleği kullanma örneği:
|
from |
Bağlantı dizesinden bir BlobServiceClient örneği oluşturur. |
generate |
Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen BlobServiceClient için kullanılabilir. geçirilen istemci özelliklerine ve parametrelerine göre bir Blob hesabı Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
generate |
Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen BlobServiceClient için kullanılabilir. Bir Blob hesabı Paylaşılan Erişim İmzası (SAS) URI'sine imza atacak dizeyi, geçirilen istemci özelliklerine ve parametrelerine göre oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas |
get |
Hesap Bilgilerini Al işlemi, belirtilen hesap için sku adını ve hesap türünü döndürür. Hesap Bilgilerini Al işlemi, sürüm 2018-03-28 ile başlayan hizmet sürümlerinde kullanılabilir. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Toplu işlemleri yürütmek için bir BlobBatchClient nesnesi oluşturur. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch |
get |
ContainerClient nesnesi oluşturur |
get |
Depolama Analizi ve CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kurallarının özellikleri de dahil olmak üzere depolama hesabının Blob hizmetinin özelliklerini alır. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties |
get |
Blob hizmeti için çoğaltmayla ilgili istatistikleri alır. Yalnızca depolama hesabı için okuma erişimli coğrafi olarak yedekli çoğaltma etkinleştirildiğinde ikincil konum uç noktasında kullanılabilir. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats |
get |
YALNıZCA TAŞıYıCı BELIRTEÇ KIMLIK DOĞRULAMASı (TokenCredential) KULLANıLıRKEN KULLANıLABILIR. Blob hizmeti için bir kullanıcı temsilcisi anahtarı alır. Bu yalnızca taşıyıcı belirteç kimlik doğrulaması kullanılırken geçerli bir işlemdir. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key |
list |
Belirtilen hesap altındaki tüm kapsayıcıları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. .byPage(), kapsayıcıları sayfalarda listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
İşaretçi ile disk belleği kullanma örneği:
|
set |
Depolama Analizi, CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kuralları ve geçici silme ayarları gibi depolama hesabının Blob hizmet uç noktasının özelliklerini ayarlar. Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties |
undelete |
Daha önce silinmiş bir Blob kapsayıcıyı geri yükleyin. Bu API yalnızca kapsayıcıyla ilişkilendirilmiş depolama hesabı için Kapsayıcı Geçici Silme etkinleştirildiğinde çalışır. |
Oluşturucu Ayrıntıları
BlobServiceClient(string, PipelineLike)
BlobServiceClient örneği oluşturur.
new BlobServiceClient(url: string, pipeline: PipelineLike)
Parametreler
- url
-
string
"https://myaccount.blob.core.windows.net" gibi Azure Depolama blob hizmetine işaret eden bir İstemci dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.blob.core.windows.net?sasString" gibi bir SAS ekleyebilirsiniz.
- pipeline
- PipelineLike
Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için newPipeline() çağrısında bulunabilirsiniz.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
BlobServiceClient örneği oluşturur.
new BlobServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametreler
- url
-
string
"https://myaccount.blob.core.windows.net" gibi Azure Depolama blob hizmetine işaret eden bir İstemci dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.blob.core.windows.net?sasString" gibi bir SAS ekleyebilirsiniz.
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity
paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
- options
- StoragePipelineOptions
Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.
@azure/identity
defaultAzureCredential kullanma örneği:
const account = "<storage account name>";
const defaultAzureCredential = new DefaultAzureCredential();
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
defaultAzureCredential
);
Hesap adı/anahtarı kullanan örnek:
const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
sharedKeyCredential
);
Devralınan Özellik Detayları
accountName
accountName: string
Özellik Değeri
string
StorageClient.accountName'den Devralınan
credential
AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity
paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Özellik Değeri
StorageClient.credential'dan Devralınmış
url
Kodlanmış URL dizesi değeri.
url: string
Özellik Değeri
string
StorageClient.url'den Devralınan
Yöntem Ayrıntıları
createContainer(string, ContainerCreateOptions)
Blob kapsayıcısı oluşturma.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Parametreler
- containerName
-
string
Oluşturulacak kapsayıcının adı.
- options
- ContainerCreateOptions
Kapsayıcı Oluşturma işlemini yapılandırma seçenekleri.
Döndürülenler
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
Kapsayıcı oluşturma yanıtı ve karşılık gelen kapsayıcı istemcisi.
deleteContainer(string, ContainerDeleteMethodOptions)
Blob kapsayıcıyı siler.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
Parametreler
- containerName
-
string
Silinecek kapsayıcının adı.
- options
- ContainerDeleteMethodOptions
Kapsayıcı Silme işlemini yapılandırma seçenekleri.
Döndürülenler
Promise<ContainerDeleteResponse>
Kapsayıcı silme yanıtı.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
Belirtilen hesabın altında belirtilen etikete sahip tüm blobları bulmak için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
.byPage() sayfalardaki blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
for await
söz dizimi kullanan örnek:
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
iter.next()
kullanan örnek:
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();
}
byPage()
kullanan örnek:
// 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}`);
}
}
}
İşaretçi ile disk belleği kullanma örneği:
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>
Parametreler
- tagFilterSqlExpression
-
string
where parametresi, çağıranın etiketleri belirli bir ifadeyle eşleşen blobları sorgulamasını sağlar. Bir blob'un sonuçlarda döndürülebilmesi için verilen ifadenin true olarak değerlendirilmesi gerekir. [OData - ABNF] filtre söz dizimi kuralı, where sorgu parametresinin değeri için resmi dil bilgisini tanımlar; ancak Blob hizmetinde OData filtre söz diziminin yalnızca bir alt kümesi desteklenir.
- options
- ServiceFindBlobByTagsOptions
Blobları etiketlere göre bulma seçenekleri.
Döndürülenler
fromConnectionString(string, StoragePipelineOptions)
Bağlantı dizesinden bir BlobServiceClient örneği oluşturur.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
Parametreler
- connectionString
-
string
Bir Azure depolama hesabının hesap bağlantı dizesi veya SAS bağlantı dizesi.
[ Not - Hesap bağlantı dizesi yalnızca NODE.JS çalışma zamanında kullanılabilir. ] Hesap bağlantı dizesi örneği - SAS bağlantı dizesi örneği 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
Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.
Döndürülenler
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen BlobServiceClient için kullanılabilir.
geçirilen istemci özelliklerine ve parametrelerine göre bir Blob hesabı Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parametreler
- expiresOn
-
Date
Opsiyonel. Paylaşılan erişim imzasının geçersiz hale geldiği saat. Sağlanmadıysa varsayılan olarak bir saat sonraya ayarlanmıştır.
- permissions
- AccountSASPermissions
SAS ile ilişkilendirilecek izinlerin listesini belirtir.
- resourceTypes
-
string
Paylaşılan erişim imzası ile ilişkili kaynak türlerini belirtir.
İsteğe bağlı parametreler.
Döndürülenler
string
Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren bir hesap SAS URI'si.
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen BlobServiceClient için kullanılabilir.
Bir Blob hesabı Paylaşılan Erişim İmzası (SAS) URI'sine imza atacak dizeyi, geçirilen istemci özelliklerine ve parametrelerine göre oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parametreler
- expiresOn
-
Date
Opsiyonel. Paylaşılan erişim imzasının geçersiz hale geldiği saat. Sağlanmadıysa varsayılan olarak bir saat sonraya ayarlanmıştır.
- permissions
- AccountSASPermissions
SAS ile ilişkilendirilecek izinlerin listesini belirtir.
- resourceTypes
-
string
Paylaşılan erişim imzası ile ilişkili kaynak türlerini belirtir.
İsteğe bağlı parametreler.
Döndürülenler
string
Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren bir hesap SAS URI'si.
getAccountInfo(ServiceGetAccountInfoOptions)
Hesap Bilgilerini Al işlemi, belirtilen hesap için sku adını ve hesap türünü döndürür. Hesap Bilgilerini Al işlemi, sürüm 2018-03-28 ile başlayan hizmet sürümlerinde kullanılabilir.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
Parametreler
- options
- ServiceGetAccountInfoOptions
Hizmet Hesap Bilgilerini Al işleminin seçenekleri.
Döndürülenler
Promise<ServiceGetAccountInfoResponse>
Hizmet Hesap Bilgilerini Al işlemi için yanıt verileri.
getBlobBatchClient()
Toplu işlemleri yürütmek için bir BlobBatchClient nesnesi oluşturur.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
function getBlobBatchClient(): BlobBatchClient
Döndürülenler
Bu hizmet için yeni bir BlobBatchClient nesnesi.
getContainerClient(string)
ContainerClient nesnesi oluşturur
function getContainerClient(containerName: string): ContainerClient
Parametreler
- containerName
-
string
Kapsayıcı adı
Döndürülenler
Belirtilen kapsayıcı adı için yeni bir ContainerClient nesnesi.
Örnek kullanım:
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
Depolama Analizi ve CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kurallarının özellikleri de dahil olmak üzere depolama hesabının Blob hizmetinin özelliklerini alır.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Parametreler
- options
- ServiceGetPropertiesOptions
Hizmet Alma Özellikleri işleminin seçenekleri.
Döndürülenler
Promise<ServiceGetPropertiesResponse>
Hizmet Alma Özellikleri işlemi için yanıt verileri.
getStatistics(ServiceGetStatisticsOptions)
Blob hizmeti için çoğaltmayla ilgili istatistikleri alır. Yalnızca depolama hesabı için okuma erişimli coğrafi olarak yedekli çoğaltma etkinleştirildiğinde ikincil konum uç noktasında kullanılabilir.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>
Parametreler
- options
- ServiceGetStatisticsOptions
Hizmet İstatistikleri Al işleminin seçenekleri.
Döndürülenler
Promise<ServiceGetStatisticsResponse>
Hizmet İstatistiklerini Al işleminin yanıt verileri.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
YALNıZCA TAŞıYıCı BELIRTEÇ KIMLIK DOĞRULAMASı (TokenCredential) KULLANıLıRKEN KULLANıLABILIR.
Blob hizmeti için bir kullanıcı temsilcisi anahtarı alır. Bu yalnızca taşıyıcı belirteç kimlik doğrulaması kullanılırken geçerli bir işlemdir.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Parametreler
- startsOn
-
Date
Kullanıcı temsilcisi SAS'sinin başlangıç saati. Geçerli saatten sonra 7 gün içinde olmalıdır
- expiresOn
-
Date
Kullanıcı temsilcisi SAS'sinin bitiş saati. Geçerli saatten sonra 7 gün içinde olmalıdır
Döndürülenler
Promise<ServiceGetUserDelegationKeyResponse>
listContainers(ServiceListContainersOptions)
Belirtilen hesap altındaki tüm kapsayıcıları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
.byPage(), kapsayıcıları sayfalarda listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
for await
söz dizimi kullanan örnek:
let i = 1;
for await (const container of blobServiceClient.listContainers()) {
console.log(`Container ${i++}: ${container.name}`);
}
iter.next()
kullanan örnek:
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();
}
byPage()
kullanan örnek:
// 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}`);
}
}
}
İşaretçi ile disk belleği kullanma örneği:
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>
Parametreler
- options
- ServiceListContainersOptions
Kapsayıcıları listeleme seçenekleri.
Döndürülenler
Disk belleğini destekleyen asyncIterableIterator.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Depolama Analizi, CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kuralları ve geçici silme ayarları gibi depolama hesabının Blob hizmet uç noktasının özelliklerini ayarlar.
Bkz. https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
Parametreler
- properties
- BlobServiceProperties
- options
- ServiceSetPropertiesOptions
Hizmet Kümesi Özellikleri işleminin seçenekleri.
Döndürülenler
Promise<ServiceSetPropertiesResponse>
Hizmet Kümesi Özellikleri işlemi için yanıt verileri.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)
Daha önce silinmiş bir Blob kapsayıcıyı geri yükleyin. Bu API yalnızca kapsayıcıyla ilişkilendirilmiş depolama hesabı için Kapsayıcı Geçici Silme etkinleştirildiğinde çalışır.
function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Parametreler
- deletedContainerName
-
string
Daha önce silinen kapsayıcının adı.
- deletedContainerVersion
-
string
Daha önce silinen kapsayıcının sürümü, silinen kapsayıcıyı benzersiz olarak tanımlamak için kullanılır.
- options
- ServiceUndeleteContainerOptions
Kapsayıcı Geri Yükleme işlemini yapılandırma seçenekleri.
Döndürülenler
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
Kapsayıcı silme yanıtı.