Aracılığıyla paylaş

BlobServiceClient class

  • Başvuru
Paket:
@azure/storage-blob

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

BlobServiceClient(string, PipelineLike)

BlobServiceClient örneği oluşturur.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

BlobServiceClient örneği oluşturur.

Özellikler

accountName
credential

AnonymousCredential, StorageSharedKeyCredential veya hizmete yönelik isteklerin @azure/identity kimliğini doğrulamak için paketten herhangi bir kimlik bilgisi gibi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
url

Kodlanmış URL dizesi değeri.

Yöntemler

createContainer(string, ContainerCreateOptions)

Blob kapsayıcısı oluşturma.
deleteContainer(string, ContainerDeleteMethodOptions)

Blob kapsayıcısı siler.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

Belirtilen hesap 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.
fromConnectionString(string, StoragePipelineOptions)

Bağlantı dizesinden bir BlobServiceClient örneği oluşturur.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenmiş 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.
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, 2018-03-28 sürümünden itibaren hizmet sürümlerinde kullanılabilir.
getBlobBatchClient()

Toplu işlemleri gerçekleştirmek için bir BlobBatchClient nesnesi oluşturur.
getContainerClient(string)

Nesne oluşturur <xref:ContainerClient>
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.
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.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

YALNıZCA BEARER TOKEN AUTHENTICATION (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.
listContainers(ServiceListContainersOptions)

Belirtilen hesap altındaki tüm kapsayıcıları listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür. .byPage() sayfalardaki kapsayıcıları listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

let i = 1;
for await (const container of blobServiceClient.listContainers()) {
  console.log(`Container ${i++}: ${container.name}`);
}

kullanan iter.next()ö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();
}

kullanan byPage()ö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}`);
  }
}
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.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)

Daha önce silinmiş bir Blob kapsayıcıyı geri yükleyin. Bu API yalnızca kapsayıcıyla ilişkili 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 SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net?sasString".

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 SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential, StorageSharedKeyCredential veya hizmete yönelik isteklerin @azure/identity kimliğini doğrulamak için paketten alınan herhangi bir kimlik bilgisi gibi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.

options
StoragePipelineOptions

İsteğe bağlı. HTTP işlem hattını yapılandırma seçenekleri.

defaultAzureCredential kullanma örneği:@azure/identity

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  defaultAzureCredential
);

Hesap adı/anahtarı kullanma örneği:

const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");

const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  sharedKeyCredential
);

Özellik Ayrıntıları

accountName 

accountName: string

Özellik Değeri

string

credential

AnonymousCredential, StorageSharedKeyCredential veya hizmete yönelik isteklerin @azure/identity kimliğini doğrulamak için paketten herhangi bir kimlik bilgisi gibi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

url

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

string

Yöntem Ayrıntıları

createContainer(string, ContainerCreateOptions)

Blob kapsayıcısı oluşturma.

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

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

Kapsayıcı oluşturma yanıtı ve karşılık gelen kapsayıcı istemcisi.

deleteContainer(string, ContainerDeleteMethodOptions)

Blob kapsayıcısı siler.

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions)

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

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

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 filtresi söz diziminin yalnızca bir alt kümesi desteklenir.

options
ServiceFindBlobByTagsOptions

Blobları etiketlere göre bulma seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>

fromConnectionString(string, StoragePipelineOptions)

Bağlantı dizesinden bir BlobServiceClient örneği oluşturur.

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

Parametreler

connectionString

string

Hesap bağlantı dizesi veya Azure depolama hesabının 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 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS bağlantı dizesi örneği - 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

İsteğe bağlı. HTTP işlem hattını yapılandırma seçenekleri.

Döndürülenler

BlobServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenmiş 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.

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

Parametreler

expiresOn

Date

İsteğe bağlı. Paylaşılan erişim imzasının geçersiz olduğu saat. Sağlanmadıysa varsayılan olarak bir saat sonraya ayarlanır.

permissions
AccountSASPermissions

SAS ile ilişkilendirilecek izinlerin listesini belirtir.

resourceTypes

string

Paylaşılan erişim imzası ile ilişkili kaynak türlerini belirtir.

options
ServiceGenerateAccountSasUrlOptions

İ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, 2018-03-28 sürümünden itibaren hizmet sürümlerinde kullanılabilir.

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

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 gerçekleştirmek için bir BlobBatchClient nesnesi oluşturur.

function getBlobBatchClient()

Döndürülenler

BlobBatchClient

Bu hizmet için yeni bir BlobBatchClient nesnesi.

getContainerClient(string)

Nesne oluşturur <xref:ContainerClient>

function getContainerClient(containerName: string)

Parametreler

containerName

string

Kapsayıcı adı

Döndürülenler

ContainerClient

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.

function getProperties(options?: ServiceGetPropertiesOptions)

Parametreler

options
ServiceGetPropertiesOptions

Hizmet Özellikleri Al işleminin seçenekleri.

Döndürülenler

Promise<ServiceGetPropertiesResponse>

Hizmet Alma Özellikleri işleminin 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.

function getStatistics(options?: ServiceGetStatisticsOptions)

Parametreler

options
ServiceGetStatisticsOptions

Hizmet İstatistiklerini Al işleminin seçenekleri.

Döndürülenler

Promise<ServiceGetStatisticsResponse>

Service Get Statistics işlemi için yanıt verileri.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

YALNıZCA BEARER TOKEN AUTHENTICATION (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.

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

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

options
ServiceGetUserDelegationKeyOptions

Döndürülenler

Promise<ServiceGetUserDelegationKeyResponse>

listContainers(ServiceListContainersOptions)

Belirtilen hesap altındaki tüm kapsayıcıları listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür. .byPage() sayfalardaki kapsayıcıları listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

let i = 1;
for await (const container of blobServiceClient.listContainers()) {
  console.log(`Container ${i++}: ${container.name}`);
}

kullanan iter.next()ö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();
}

kullanan byPage()ö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)

Parametreler

options
ServiceListContainersOptions

Kapsayıcıları listeleme seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

Disk belleğini destekleyen bir 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.

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

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şkili depolama hesabı için Kapsayıcı Geçici Silme etkinleştirildiğinde çalışır.

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions)

Parametreler

deletedContainerName

string

Daha önce silinen kapsayıcının adı.

deletedContainerVersion

string

Daha önce silinen kapsayıcının, silinen kapsayıcıyı benzersiz olarak tanımlamak için kullanılan sürümü.

options
ServiceUndeleteContainerOptions

Kapsayıcı Geri Yükleme işlemini yapılandırma seçenekleri.

Döndürülenler

Promise<Object>

Kapsayıcı silme yanıtı.