Aracılığıyla paylaş

QueueClient class

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

QueueClient, Azure Depolama Kuyruğu'nun iletilerini işlemenize olanak sağlayan bir URL'yi temsil eder.

Extends
StorageClient

Oluşturucular

QueueClient(string, Pipeline)

QueueClient'ın bir örneğini oluşturur.
QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

QueueClient'ın bir örneğini oluşturur.
QueueClient(string, string, StoragePipelineOptions)

QueueClient'ın bir örneğini oluşturur.

Özellikler

name

Kuyruğun adı.

Devralınan Özellikler

accountName
url

URL dizesi değeri.

Yöntemler

clearMessages(QueueClearMessagesOptions)

Temizle seçeneği kuyruktan tüm iletileri siler.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages
create(QueueCreateOptions)

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

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

Belirtilen hesap henüz yoksa, belirtilen hesap altında yeni bir kuyruk oluşturur. Kuyruk zaten varsa değiştirilmez.

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

Belirtilen kuyruğu kalıcı olarak siler.

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

Varsa belirtilen kuyruğu kalıcı olarak siler.

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

deleteMessage belirtilen iletiyi kuyruğundan kalıcı olarak kaldırır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2
exists(QueueExistsOptions)

Belirtilen kuyruk varsa true döndürür; false olarak ayarlayın. NOT: Mevcut bir kuyruk diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra yeni kuyruklar diğer istemciler veya uygulamalar tarafından eklenebilir.
generateSasUrl(QueueGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan QueueClient için kullanılabilir. geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet 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/constructing-a-service-sas
getAccessPolicy(QueueGetAccessPolicyOptions)

Kuyrukta belirtilen ve Paylaşılan Erişim İmzaları ile kullanılabilecek tüm saklı erişim ilkeleriyle ilgili ayrıntıları alır. UYARI: Başlangıç ve süre sonu dizesi ayrıştırılırken JavaScript Tarihi duyarlık kaybına neden olabilir. Örneğin, yeni Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z" değerini alır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
getProperties(QueueGetPropertiesOptions)

Belirtilen kuyruk için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini alır. Meta veriler, ad-değer çiftleri olarak kuyrukla ilişkilendirilir.

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

UYARI: Yanıtta metadata döndürülen nesnenin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak olan seçeneğini kullanma includeMetadata yöntemi QueueServiceClient tarafından listQueues döndürülen meta veri anahtarlarından farklıdır.
peekMessages(QueuePeekMessagesOptions)

peekMessages kuyruğun önünden bir veya daha fazla ileti alır ancak iletinin görünürlüğünü değiştirmez.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)

receiveMessages, kuyruğun önünden bir veya daha fazla ileti alır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages
sendMessage(string, QueueSendMessageOptions)

sendMessage kuyruğun arkasına yeni bir ileti ekler. Görünürlük zaman aşımı, iletinin Dequeue ve Peek işlemleri için ne kadar süre görünmez olacağını belirtir. İleti içeriğinin boyutu 64 KB'a kadardır ve UTF-8 kodlamalı bir XML isteğine dahil edilebilecek bir biçimde olmalıdır. İletiye işaretleme eklemek için, iletinin içeriği XML kaçışlı veya Base64 kodlu olmalıdır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/put-message
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Paylaşılan Erişim İmzaları ile kullanılabilecek kuyruk için depolanan erişim ilkelerini ayarlar.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
setMetadata(Metadata, QueueSetMetadataOptions)

Belirtilen kuyruk için bir veya daha fazla kullanıcı tanımlı ad-değer çifti ayarlar. Seçenek sağlanmazsa veya seçenek parametresinde tanımlı meta veri yoksa, kuyruk meta verileri kaldırılır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
updateMessage(string, string, string, number, QueueUpdateMessageOptions)

Güncelleştirme, iletinin görünürlük zaman aşımını ve içeriğini değiştirir. İleti içeriğinin boyutu 64 KB'a kadardır ve UTF-8 kodlamalı bir XML isteğine dahil edilebilecek bir biçimde olmalıdır. İletiye işaretleme eklemek için, iletinin içeriği XML kaçışlı veya Base64 kodlu olmalıdır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

Oluşturucu Ayrıntıları

QueueClient(string, Pipeline)

QueueClient'ın bir örneğini oluşturur.

new QueueClient(url: string, pipeline: Pipeline)

Parametreler

url

string

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

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

QueueClient'ın bir örneğini oluşturur.

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

Parametreler

url

string

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

QueueClient(string, string, StoragePipelineOptions)

QueueClient'ın bir örneğini oluşturur.

new QueueClient(connectionString: string, queueName: 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

queueName

string

Kuyruk adı.

options
StoragePipelineOptions

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

Özellik Ayrıntıları

name

Kuyruğun adı.

string name

Özellik Değeri

string

Devralınan Özellik Detayları

accountName 

accountName: string

Özellik Değeri

string

StorageClient.accountName'denDevralındı

url

URL dizesi değeri.

url: string

Özellik Değeri

string

StorageClient.url'den Devralındı

Yöntem Ayrıntıları

clearMessages(QueueClearMessagesOptions)

Temizle seçeneği kuyruktan tüm iletileri siler.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages

function clearMessages(options?: QueueClearMessagesOptions): Promise<QueueClearMessagesResponse>

Parametreler

options
QueueClearMessagesOptions

İletileri temizleme işlemi seçenekleri.

Döndürülenler

Promise<QueueClearMessagesResponse>

İletileri temizleme işlemi için yanıt verileri.

create(QueueCreateOptions)

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

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

function create(options?: QueueCreateOptions): Promise<QueueCreateResponse>

Parametreler

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.

Örnek kullanım: 

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

createIfNotExists(QueueCreateOptions)

Belirtilen hesap henüz yoksa, belirtilen hesap altında yeni bir kuyruk oluşturur. Kuyruk zaten varsa değiştirilmez.

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

function createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>

Parametreler

options
QueueCreateOptions

Döndürülenler

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Belirtilen kuyruğu kalıcı olarak siler.

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

function delete(options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

Parametreler

options
QueueDeleteOptions

Kuyruk silme işlemi seçenekleri.

Döndürülenler

Promise<QueueDeleteResponse>

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

Örnek kullanım: 

const deleteQueueResponse = await queueClient.delete();
console.log(
  "Delete queue successfully, service assigned request Id:", deleteQueueResponse.requestId
);

deleteIfExists(QueueDeleteOptions)

Varsa belirtilen kuyruğu kalıcı olarak siler.

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

function deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>

Parametreler

options
QueueDeleteOptions

Döndürülenler

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage belirtilen iletiyi kuyruğundan kalıcı olarak kaldırır.

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

function deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions): Promise<QueueDeleteMessageResponse>

Parametreler

messageId

string

İletinin kimliği.

popReceipt

string

Alma iletilerine veya güncelleştirme iletisi işlemine yapılan önceki bir çağrıdan döndürülen geçerli bir pop alındı bilgisi değeri.

options
QueueDeleteMessageOptions

İleti işlemini silme seçenekleri.

Döndürülenler

Promise<QueueDeleteMessageResponse>

İleti silme işlemi için yanıt verileri.

exists(QueueExistsOptions)

Belirtilen kuyruk varsa true döndürür; false olarak ayarlayın. NOT: Mevcut bir kuyruk diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra yeni kuyruklar diğer istemciler veya uygulamalar tarafından eklenebilir.

function exists(options?: QueueExistsOptions): Promise<boolean>

Parametreler

options
QueueExistsOptions

mevcut işlem seçeneklerine tıklayın.

Döndürülenler

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan QueueClient için kullanılabilir. geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet 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/constructing-a-service-sas

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parametreler

options
QueueGenerateSasUrlOptions

İ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 SAS URI'sini.

getAccessPolicy(QueueGetAccessPolicyOptions)

Kuyrukta belirtilen ve Paylaşılan Erişim İmzaları ile kullanılabilecek tüm saklı erişim ilkeleriyle ilgili ayrıntıları alır. UYARI: Başlangıç ve süre sonu dizesi ayrıştırılırken JavaScript Tarihi duyarlık kaybına neden olabilir. Örneğin, yeni Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z" değerini alır.

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

function getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>

Parametreler

options
QueueGetAccessPolicyOptions

Erişim ilkesi işlemini kuyruğa alma seçenekleri.

Döndürülenler

Promise<QueueGetAccessPolicyResponse>

Kuyruk erişim ilkesi alma işlemi için yanıt verileri.

getProperties(QueueGetPropertiesOptions)

Belirtilen kuyruk için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini alır. Meta veriler, ad-değer çiftleri olarak kuyrukla ilişkilendirilir.

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

UYARI: Yanıtta metadata döndürülen nesnenin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak olan seçeneğini kullanma includeMetadata yöntemi QueueServiceClient tarafından listQueues döndürülen meta veri anahtarlarından farklıdır.

function getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>

Parametreler

options
QueueGetPropertiesOptions

Özellikleri alma işlemini kuyruğa alma seçenekleri.

Döndürülenler

Promise<QueueGetPropertiesResponse>

Kuyruk özellikleri alma işlemi için yanıt verileri.

peekMessages(QueuePeekMessagesOptions)

peekMessages kuyruğun önünden bir veya daha fazla ileti alır ancak iletinin görünürlüğünü değiştirmez.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages

function peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>

Parametreler

options
QueuePeekMessagesOptions

İletilere göz atma işlemi seçenekleri.

Döndürülenler

Promise<QueuePeekMessagesResponse>

İletilere göz atma işlemi için yanıt verileri.

Örnek kullanım: 

const peekMessagesResponse = await queueClient.peekMessages();
console.log("The peeked message is:", peekMessagesResponse.peekedMessageItems[0].messageText);

receiveMessages(QueueReceiveMessageOptions)

receiveMessages, kuyruğun önünden bir veya daha fazla ileti alır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages

function receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>

Parametreler

options
QueueReceiveMessageOptions

İleti alma işlemi seçenekleri.

Döndürülenler

Promise<QueueReceiveMessageResponse>

İleti alma işlemi için yanıt verileri.

Örnek kullanım: 

const response = await queueClient.receiveMessages();
if (response.receivedMessageItems.length == 1) {
  const receivedMessageItem = response.receivedMessageItems[0];
  console.log("Processing & deleting message with content:", receivedMessageItem.messageText);
  const deleteMessageResponse = await queueClient.deleteMessage(
    receivedMessageItem.messageId,
    receivedMessageItem.popReceipt
  );
  console.log(
    "Delete message successfully, service assigned request Id:",
    deleteMessageResponse.requestId
  );
}

sendMessage(string, QueueSendMessageOptions)

sendMessage kuyruğun arkasına yeni bir ileti ekler. Görünürlük zaman aşımı, iletinin Dequeue ve Peek işlemleri için ne kadar süre görünmez olacağını belirtir. İleti içeriğinin boyutu 64 KB'a kadardır ve UTF-8 kodlamalı bir XML isteğine dahil edilebilecek bir biçimde olmalıdır. İletiye işaretleme eklemek için, iletinin içeriği XML kaçışlı veya Base64 kodlu olmalıdır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/put-message

function sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>

Parametreler

messageText

string

Gönderilecek iletinin metni

options
QueueSendMessageOptions

İleti gönderme işlemi seçenekleri.

Döndürülenler

Promise<QueueSendMessageResponse>

İleti gönderme işlemi için yanıt verileri.

Örnek kullanım: 

const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
  "service assigned request Id:", sendMessageResponse.requestId
);

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Paylaşılan Erişim İmzaları ile kullanılabilecek kuyruk için depolanan erişim ilkelerini ayarlar.

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

function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>

Parametreler

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

Kuyruk ayarlama erişim ilkesi işlemi seçenekleri.

Döndürülenler

Promise<QueueSetAccessPolicyResponse>

Kuyruk kümesi erişim ilkesi işlemi için yanıt verileri.

setMetadata(Metadata, QueueSetMetadataOptions)

Belirtilen kuyruk için bir veya daha fazla kullanıcı tanımlı ad-değer çifti ayarlar. Seçenek sağlanmazsa veya seçenek parametresinde tanımlı meta veri yoksa, kuyruk meta verileri kaldırılır.

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

function setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions): Promise<QueueSetMetadataResponse>

Parametreler

metadata
Metadata

Meta veri sağlanmazsa, var olan tüm meta veriler kaldırılır.

options
QueueSetMetadataOptions

Kuyruk kümesi meta veri işlemi seçenekleri.

Döndürülenler

Promise<QueueSetMetadataResponse>

Kuyruk kümesi meta veri işlemi için yanıt verileri.

updateMessage(string, string, string, number, QueueUpdateMessageOptions)

Güncelleştirme, iletinin görünürlük zaman aşımını ve içeriğini değiştirir. İleti içeriğinin boyutu 64 KB'a kadardır ve UTF-8 kodlamalı bir XML isteğine dahil edilebilecek bir biçimde olmalıdır. İletiye işaretleme eklemek için, iletinin içeriği XML kaçışlı veya Base64 kodlu olmalıdır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

function updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions): Promise<QueueUpdateMessageResponse>

Parametreler

messageId

string

İletinin kimliği

popReceipt

string

Alma iletilerine veya güncelleştirme iletisi işlemine yapılan önceki bir çağrıdan döndürülen geçerli bir pop alındı bilgisi değeri.

message

string

Güncelleştirilecek ileti. Bu parametre tanımsızsa, iletinin içeriği güncelleştirilmez.

visibilityTimeout

number

Sunucu süresine göre saniye olarak yeni görünürlük zaman aşımı değerini belirtir. Yeni değer 0'dan büyük veya buna eşit olmalı ve 7 günden büyük olamaz. İletinin görünürlük zaman aşımı süresi, süre sonu süresinden sonraki bir değere ayarlanamaz. İleti silinene veya süresi dolana kadar güncelleştirilebilir.

options
QueueUpdateMessageOptions

İleti işlemini güncelleştirme seçenekleri.

Döndürülenler

Promise<QueueUpdateMessageResponse>

Güncelleştirme iletisi işlemi için yanıt verileri.