QueueServiceClient class

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

QueueServiceClient, kuyrukları işlemenize olanak sağlayan Azure Depolama Kuyruğu hizmetinin URL'sini temsil eder.

Extends

StorageClient

Oluşturucular

QueueServiceClient(string, Pipeline)

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

QueueServiceClient örneğini oluşturur.

Devralınan Özellikler

accountName
url

URL dizesi değeri.

Yöntemler

createQueue(string, QueueCreateOptions)

Belirtilen hesap altında yeni bir kuyruk oluşturur.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

Belirtilen kuyruğu kalıcı olarak siler.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
fromConnectionString(string, StoragePipelineOptions)

QueueServiceClient örneğini oluşturur.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen QueueServiceClient için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir hesap Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Depolama Analizi ve CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kurallarının özellikleri de dahil olmak üzere depolama hesabının Kuyruk hizmetinin özelliklerini alır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
getQueueClient(string)

QueueClient nesnesi oluşturur.
getStatistics(ServiceGetStatisticsOptions)

Kuyruk 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://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
listQueues(ServiceListQueuesOptions)

Belirtilen hesap altındaki tüm kuyrukları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage() sayfalardaki kuyrukları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

let i = 1;
for await (const item of queueServiceClient.listQueues()) {
  console.log(`Queue${i}: ${item.name}`);
  i++;
}

kullanma iter.next()örneği:

let i = 1;
let iterator = queueServiceClient.listQueues();
let item = await iterator.next();
while (!item.done) {
  console.log(`Queue${i}: ${iterator.value.name}`);
  i++;
  item = await iterator.next();
}

kullanma byPage()örneği:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  if (item2.queueItems) {
    for (const queueItem of item2.queueItems) {
      console.log(`Queue${i}: ${queueItem.name}`);
      i++;
    }
  }
}

İşaretçi ile disk belleği kullanma örneği:

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let item = (await iterator.next()).value;

// Prints 2 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
// Gets next marker
let marker = item.continuationToken;

// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
item = (await iterator.next()).value;

// Prints 10 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Depolama Analizi özellikleri, CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kuralları ve geçici silme ayarları dahil olmak üzere depolama hesabının Kuyruk hizmeti uç noktasının özelliklerini ayarlar.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties

Oluşturucu Ayrıntıları

QueueServiceClient(string, Pipeline)

QueueServiceClient örneğini oluşturur.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parametreler

url

string

"https://myaccount.queue.core.windows.net". gibi Azure Depolama kuyruğu hizmetine işaret eden bir URL dizesi. AnonymousCredential kullanıyorsanız SAS ekleyebilirsiniz; örneğin, "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için newPipeline() çağrısında bulunabilirsiniz.

QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

QueueServiceClient örneğini oluşturur.

new QueueServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametreler

url

string

"https://myaccount.queue.core.windows.net". gibi Azure Depolama kuyruğu hizmetine işaret eden bir URL dizesi. AnonymousCredential kullanıyorsanız SAS ekleyebilirsiniz; örneğin, "https://myaccount.queue.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

HTTP işlem hattını yapılandırma seçenekleri.

defaultAzureCredential kullanma örneği:@azure/identity

const account = "<account>";

const credential = new DefaultAzureCredential();

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  credential
}

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

const account = "<account>";

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

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  sharedKeyCredential,
  {
    retryOptions: { maxTries: 4 }, // Retry options
    telemetry: { value: "BasicSample/V11.0.0" } // Customized telemetry string
  }
);

Devralınan Özellik Detayları

accountName 

accountName: string

Özellik Değeri

string

Devralınan StorageClient.accountName

url

URL dizesi değeri.

url: string

Özellik Değeri

string

Devralınan StorageClient.url

Yöntem Ayrıntıları

createQueue(string, QueueCreateOptions)

Belirtilen hesap altında yeni bir kuyruk oluşturur.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

function createQueue(queueName: string, options?: QueueCreateOptions): Promise<QueueCreateResponse>

Parametreler

queueName

string

oluşturulacak kuyruğun adı

options
QueueCreateOptions

Kuyruk oluşturma işlemi seçenekleri.

Döndürülenler

Promise<QueueCreateResponse>

Kuyruk oluşturma işlemi için yanıt verileri.

deleteQueue(string, QueueDeleteOptions)

Belirtilen kuyruğu kalıcı olarak siler.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

function deleteQueue(queueName: string, options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

Parametreler

queueName

string

silinecek kuyruğun adı.

options
QueueDeleteOptions

Kuyruk silme işlemi seçenekleri.

Döndürülenler

Promise<QueueDeleteResponse>

Kuyruk silme işlemi için yanıt verileri.

fromConnectionString(string, StoragePipelineOptions)

QueueServiceClient örneğini oluşturur.

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

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

HTTP işlem hattını yapılandırma seçenekleri.

Döndürülenler

QueueServiceClient

Verilen bağlantı dizesinden yeni bir QueueServiceClient nesnesi.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen QueueServiceClient için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir hesap Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Parametreler

expiresOn

Date

İsteğe bağlı. Paylaşılan erişim imzasının geçersiz hale geldiği saat. Belirtilmezse 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.

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.

getProperties(ServiceGetPropertiesOptions)

Depolama Analizi ve CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kurallarının özellikleri de dahil olmak üzere depolama hesabının Kuyruk hizmetinin özelliklerini alır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

Parametreler

options
ServiceGetPropertiesOptions

Özellikler işlemini alma seçenekleri.

Döndürülenler

Promise<ServiceGetPropertiesResponse>

Kuyruk hizmeti özellikleri de dahil olmak üzere yanıt verileri.

getQueueClient(string)

QueueClient nesnesi oluşturur.

function getQueueClient(queueName: string): QueueClient

Parametreler

queueName

string

Döndürülenler

QueueClient

yeni bir QueueClient

Örnek kullanım: 

const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();

getStatistics(ServiceGetStatisticsOptions)

Kuyruk 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://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats

function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

Parametreler

options
ServiceGetStatisticsOptions

İstatistik işlemini alma seçenekleri.

Döndürülenler

Promise<ServiceGetStatisticsResponse>

İşlemin istatistiklerini almak için yanıt verileri.

listQueues(ServiceListQueuesOptions)

Belirtilen hesap altındaki tüm kuyrukları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage() sayfalardaki kuyrukları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

let i = 1;
for await (const item of queueServiceClient.listQueues()) {
  console.log(`Queue${i}: ${item.name}`);
  i++;
}

kullanma iter.next()örneği:

let i = 1;
let iterator = queueServiceClient.listQueues();
let item = await iterator.next();
while (!item.done) {
  console.log(`Queue${i}: ${iterator.value.name}`);
  i++;
  item = await iterator.next();
}

kullanma byPage()örneği:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  if (item2.queueItems) {
    for (const queueItem of item2.queueItems) {
      console.log(`Queue${i}: ${queueItem.name}`);
      i++;
    }
  }
}

İşaretçi ile disk belleği kullanma örneği:

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let item = (await iterator.next()).value;

// Prints 2 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
// Gets next marker
let marker = item.continuationToken;

// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
item = (await iterator.next()).value;

// Prints 10 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}

function listQueues(options?: ServiceListQueuesOptions): PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

Parametreler

options
ServiceListQueuesOptions

Kuyrukları listeleme işlemi seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

Disk belleğini destekleyen asyncIterableIterator.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Depolama Analizi özellikleri, CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kuralları ve geçici silme ayarları dahil olmak üzere depolama hesabının Kuyruk hizmeti uç noktasının özelliklerini ayarlar.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties

function setProperties(properties: QueueServiceProperties, options?: ServiceGetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Parametreler

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Özellikler işlemini ayarlama seçenekleri.

Döndürülenler

Promise<ServiceSetPropertiesResponse>

Özellikleri Ayarla işlemi için yanıt verileri.