QueueClient class

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 örneği oluşturur.
QueueClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	QueueClient örneği oluşturur.
QueueClient(string, string, StoragePipelineOptions)	QueueClient örneği 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://learn.microsoft.com/rest/api/storageservices/clear-messages
create(QueueCreateOptions)	Belirtilen hesap altında yeni bir kuyruk oluşturur. Bkz. https://learn.microsoft.com/rest/api/storageservices/create-queue4
createIfNotExists(QueueCreateOptions)	Henüz mevcut değilse, belirtilen hesabın altında yeni bir kuyruk oluşturur. Kuyruk zaten varsa, değiştirilmez. Bkz. https://learn.microsoft.com/rest/api/storageservices/create-queue4
delete(QueueDeleteOptions)	Belirtilen kuyruğu kalıcı olarak siler. Bkz. https://learn.microsoft.com/rest/api/storageservices/delete-queue3
deleteIfExists(QueueDeleteOptions)	Varsa belirtilen kuyruğu kalıcı olarak siler. Bkz. https://learn.microsoft.com/rest/api/storageservices/delete-queue3
deleteMessage(string, string, QueueDeleteMessageOptions)	deleteMessage, belirtilen iletiyi kuyruğundan kalıcı olarak kaldırır. Bkz. https://learn.microsoft.com/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 diğer istemciler veya uygulamalar tarafından yeni kuyruklar eklenebilir.
generateSasStringToSign(QueueGenerateSasUrlOptions)	Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan QueueClient için kullanılabilir. Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır. Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
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://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)	geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır. Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)	geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır. Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(QueueGetAccessPolicyOptions)	Paylaşılan Erişim İmzaları ile kullanılabilecek kuyrukta belirtilen tüm depolanmış erişim ilkeleriyle ilgili ayrıntıları alır. UYARI: Başlangıç ve süre sonu dizesini ayrıştırı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://learn.microsoft.com/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, kuyrukla ad-değer çiftleri olarak ilişkilendirilir. Bkz. https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata UYARI: Yanıtta döndürülen `metadata` nesnesinin 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 `listQueues` seçeneğini kullanarak QueueServiceClient`includeMetadata` yöntemi tarafından 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://learn.microsoft.com/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)	receiveMessages, kuyruğun önünden bir veya daha fazla ileti alır. Bkz. https://learn.microsoft.com/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üreyle 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://learn.microsoft.com/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://learn.microsoft.com/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ğlanmadıysa veya seçenek parametresinde tanımlı meta veri yoksa, kuyruk meta verileri kaldırılır. Bkz. https://learn.microsoft.com/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://learn.microsoft.com/rest/api/storageservices/update-message

Oluşturucu Ayrıntıları

QueueClient(string, Pipeline)

QueueClient örneği 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" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.queue.core.windows.net/myqueue?sasString" gibi bir SAS ekleyebilirsiniz.

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 örneği oluşturur.

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

Parametreler

url: string

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

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

QueueClient(string, string, StoragePipelineOptions)

QueueClient örneği oluşturur.

new QueueClient(connectionString: string, queueName: string, options?: StoragePipelineOptions)

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

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'den Devralınan

url

URL dizesi değeri.

url: string

Özellik Değeri

string

StorageClient.url'den Devralınan

Yöntem Ayrıntıları

clearMessages(QueueClearMessagesOptions)

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

Bkz. https://learn.microsoft.com/rest/api/storageservices/clear-messages

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

Parametreler

options: QueueClearMessagesOptions

İletileri temizleme işlemi seçenekleri.

Döndürülenler

Promise<MessagesClearResponse>

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

create(QueueCreateOptions)

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

Bkz. https://learn.microsoft.com/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:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const createQueueResponse = await queueClient.create();
console.log(
  `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
);

createIfNotExists(QueueCreateOptions)

Henüz mevcut değilse, belirtilen hesabın altında yeni bir kuyruk oluşturur. Kuyruk zaten varsa, değiştirilmez.

Bkz. https://learn.microsoft.com/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://learn.microsoft.com/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:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const deleteQueueResponse = await queueClient.delete();
console.log(
  `Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`,
);

deleteIfExists(QueueDeleteOptions)

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

Bkz. https://learn.microsoft.com/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://learn.microsoft.com/rest/api/storageservices/delete-message2

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

Parametreler

messageId: string

İletinin kimliği.

popReceipt: string

İleti alma veya güncelleştirme iletisi işlemine önceki bir çağrıdan döndürülen geçerli bir pop receipt değeri.

options: QueueDeleteMessageOptions

İleti işlemini silme seçenekleri.

Döndürülenler

Promise<MessageIdDeleteResponse>

İ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 diğer istemciler veya uygulamalar tarafından yeni kuyruklar eklenebilir.

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

Parametreler

options: QueueExistsOptions

seçeneklerine tıklayın.

Döndürülenler

Promise<boolean>

generateSasStringToSign(QueueGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan QueueClient için kullanılabilir.

Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(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.

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://learn.microsoft.com/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.

generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: QueueGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametreler

options: QueueGenerateSasUrlOptions

İsteğe bağlı parametreler.

userDelegationKey: UserDelegationKey

SAS URI'sini imzalamak için kullanılan kullanıcı delegasyonu anahtarı

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.

generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationStringToSign(options: QueueGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametreler

options: QueueGenerateSasUrlOptions

İsteğe bağlı parametreler.

userDelegationKey: UserDelegationKey

SAS URI'sini imzalamak için kullanılan kullanıcı delegasyonu anahtarı

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)

Paylaşılan Erişim İmzaları ile kullanılabilecek kuyrukta belirtilen tüm depolanmış erişim ilkeleriyle ilgili ayrıntıları alır.

UYARI: Başlangıç ve süre sonu dizesini ayrıştırı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://learn.microsoft.com/rest/api/storageservices/get-queue-acl

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

Parametreler

options: QueueGetAccessPolicyOptions

Erişim ilkesi alma 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, kuyrukla ad-değer çiftleri olarak ilişkilendirilir.

Bkz. https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata

UYARI: Yanıtta döndürülen metadata nesnesinin 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 listQueues seçeneğini kullanarak QueueServiceClientincludeMetadata yöntemi tarafından döndürülen meta veri anahtarlarından farklıdır.

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

Parametreler

options: QueueGetPropertiesOptions

Kuyruk özellikleri alma işlemi seçenekleri.

Döndürülenler

Promise<QueueGetPropertiesResponse>

Kuyruk alma özellikleri 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://learn.microsoft.com/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:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
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://learn.microsoft.com/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:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
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üreyle 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://learn.microsoft.com/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:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
// Send a message into the queue using the sendMessage method.
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://learn.microsoft.com/rest/api/storageservices/set-queue-acl

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

Parametreler

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

Kuyruk ayarı 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ğlanmadıysa veya seçenek parametresinde tanımlı meta veri yoksa, kuyruk meta verileri kaldırılır.

Bkz. https://learn.microsoft.com/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://learn.microsoft.com/rest/api/storageservices/update-message

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

Parametreler

messageId: string

İletinin kimliği

popReceipt: string

İleti alma veya güncelleştirme iletisi işlemine önceki bir çağrıdan döndürülen geçerli bir pop receipt değeri.

message: string

Güncelleştirilecek ileti. Bu parametre tanımlanmamışsa iletinin içeriği güncelleştirilmez.

visibilityTimeout: number

Yeni görünürlük zaman aşımı değerini sunucu zamanına göre saniye olarak belirtir. Yeni değer 0'dan büyük veya buna eşit olmalıdır ve 7 günden uzun 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<MessageIdUpdateResponse>

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

Aracılığıyla paylaş

QueueClient class

Oluşturucular

Özellikler

Devralınan Özellikler

Yöntemler

Oluşturucu Ayrıntıları

QueueClient(string, Pipeline)

Parametreler

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

Parametreler

QueueClient(string, string, StoragePipelineOptions)

Parametreler

Özellik Ayrıntıları

name

Özellik Değeri

Devralınan Özellik Detayları

accountName

Özellik Değeri

url

Özellik Değeri

Yöntem Ayrıntıları

clearMessages(QueueClearMessagesOptions)

Parametreler

Döndürülenler

create(QueueCreateOptions)

Parametreler

Döndürülenler

createIfNotExists(QueueCreateOptions)

Parametreler

Döndürülenler

delete(QueueDeleteOptions)

Parametreler

Döndürülenler

deleteIfExists(QueueDeleteOptions)

Parametreler

Döndürülenler

deleteMessage(string, string, QueueDeleteMessageOptions)

Parametreler

Döndürülenler

exists(QueueExistsOptions)

Parametreler

Döndürülenler

generateSasStringToSign(QueueGenerateSasUrlOptions)

Parametreler

Döndürülenler

generateSasUrl(QueueGenerateSasUrlOptions)

Parametreler

Döndürülenler

generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)

Parametreler

Döndürülenler

generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)

Parametreler

Döndürülenler

getAccessPolicy(QueueGetAccessPolicyOptions)

Parametreler

Döndürülenler

getProperties(QueueGetPropertiesOptions)

Parametreler

Döndürülenler

peekMessages(QueuePeekMessagesOptions)

Parametreler

Döndürülenler

receiveMessages(QueueReceiveMessageOptions)

Parametreler

Döndürülenler

sendMessage(string, QueueSendMessageOptions)

Parametreler

Döndürülenler

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Parametreler

Döndürülenler

setMetadata(Metadata, QueueSetMetadataOptions)

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler