QueueClient class

Paket:: @azure/storage-queue

QueueClient mewakili URL ke pesan Azure Storage Queue yang memungkinkan Anda memanipulasi pesannya.

Memperluas: StorageClient

Konstruktor

QueueClient(string, Pipeline)	Membuat instans QueueClient.
QueueClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Membuat instans QueueClient.
QueueClient(string, string, StoragePipelineOptions)	Membuat instans QueueClient.

Properti

name	Nama antrean.

Properti yang Diwariskan

accountName
url	Nilai string URL.

Metode

clearMessages(QueueClearMessagesOptions)	Hapus menghapus semua pesan dari antrean. Lihat https://learn.microsoft.com/rest/api/storageservices/clear-messages
create(QueueCreateOptions)	Membuat antrean baru di bawah akun yang ditentukan. Lihat https://learn.microsoft.com/rest/api/storageservices/create-queue4
createIfNotExists(QueueCreateOptions)	Membuat antrean baru di bawah akun yang ditentukan jika belum ada. Jika antrean sudah ada, antrean tidak diubah. Lihat https://learn.microsoft.com/rest/api/storageservices/create-queue4
delete(QueueDeleteOptions)	Menghapus antrean yang ditentukan secara permanen. Lihat https://learn.microsoft.com/rest/api/storageservices/delete-queue3
deleteIfExists(QueueDeleteOptions)	Menghapus antrean yang ditentukan secara permanen jika ada. Lihat https://learn.microsoft.com/rest/api/storageservices/delete-queue3
deleteMessage(string, string, QueueDeleteMessageOptions)	deleteMessage secara permanen menghapus pesan yang ditentukan dari antreannya. Lihat https://learn.microsoft.com/rest/api/storageservices/delete-message2
exists(QueueExistsOptions)	Mengembalikan true jika antrean yang ditentukan ada; false jika tidak. CATATAN: gunakan fungsi ini dengan hati-hati karena antrean yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya antrean baru mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.
generateSasStringToSign(QueueGenerateSasUrlOptions)	Hanya tersedia untuk QueueClient yang dibangun dengan kredensial kunci bersama. Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(QueueGenerateSasUrlOptions)	Hanya tersedia untuk QueueClient yang dibangun dengan kredensial kunci bersama. Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)	Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh input kredensial kunci delegasi pengguna. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)	Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh input kredensial kunci delegasi pengguna. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(QueueGetAccessPolicyOptions)	Mendapatkan detail tentang kebijakan akses tersimpan yang ditentukan pada antrean yang dapat digunakan dengan Tanda Tangan Akses Bersama. PERINGATAN: Tanggal JavaScript akan berpotensi kehilangan presisi saat mengurai string mulai dan kedaluwarsa. Misalnya, Tanggal baru("2018-12-31T03:44:23.8827891Z").toISOString() akan mendapatkan "2018-12-31T03:44:23.882Z". Lihat https://learn.microsoft.com/rest/api/storageservices/get-queue-acl
getProperties(QueueGetPropertiesOptions)	Mendapatkan semua metadata dan properti sistem yang ditentukan pengguna untuk antrean yang ditentukan. Metadata dikaitkan dengan antrean sebagai pasangan nama-nilai. Lihat https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata PERINGATAN: Objek `metadata` yang dikembalikan dalam respons akan memiliki kuncinya dalam huruf kecil, bahkan jika awalnya berisi karakter huruf besar. Ini berbeda dari kunci metadata yang dikembalikan oleh metode `listQueues`QueueServiceClient menggunakan opsi `includeMetadata`, yang akan mempertahankan casing aslinya.
peekMessages(QueuePeekMessagesOptions)	peekMessages mengambil satu atau beberapa pesan dari depan antrean tetapi tidak mengubah visibilitas pesan. Lihat https://learn.microsoft.com/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)	receiveMessages mengambil satu atau beberapa pesan dari bagian depan antrean. Lihat https://learn.microsoft.com/rest/api/storageservices/get-messages
sendMessage(string, QueueSendMessageOptions)	sendMessage menambahkan pesan baru ke bagian belakang antrean. Batas waktu visibilitas menentukan berapa lama pesan harus tidak terlihat oleh operasi Dequeue dan Peek. Konten pesan berukuran hingga 64KB, dan harus dalam format yang dapat disertakan dalam permintaan XML dengan pengodean UTF-8. Untuk menyertakan markup dalam pesan, konten pesan harus berupa XML-escaped atau Base64-encode. Lihat https://learn.microsoft.com/rest/api/storageservices/put-message
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	Mengatur kebijakan akses tersimpan untuk antrean yang dapat digunakan dengan Tanda Tangan Akses Bersama. Lihat https://learn.microsoft.com/rest/api/storageservices/set-queue-acl
setMetadata(Metadata, QueueSetMetadataOptions)	Mengatur satu atau beberapa pasangan nilai nama yang ditentukan pengguna untuk antrean yang ditentukan. Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter opsi, metadata antrean akan dihapus. Lihat https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	Pembaruan mengubah batas waktu visibilitas pesan dan konten. Konten pesan berukuran hingga 64KB, dan harus dalam format yang dapat disertakan dalam permintaan XML dengan pengodean UTF-8. Untuk menyertakan markup dalam pesan, konten pesan harus berupa XML-escaped atau Base64-encode. Lihat https://learn.microsoft.com/rest/api/storageservices/update-message

Detail Konstruktor

QueueClient(string, Pipeline)

Membuat instans QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parameter

url: string

String URL yang menunjuk ke antrean Azure Storage, seperti "https://myaccount.queue.core.windows.net/myqueue". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline: Pipeline

Panggil newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.

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

Membuat instans QueueClient.

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

Parameter

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.

options: StoragePipelineOptions

Opsi untuk mengonfigurasi alur HTTP.

QueueClient(string, string, StoragePipelineOptions)

Membuat instans QueueClient.

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

Parameter

connectionString: string

String koneksi akun atau string koneksi SAS dari akun penyimpanan Azure. [ Catatan - String koneksi akun hanya dapat digunakan dalam runtime NODE.JS. ] Contoh string koneksi akun - contoh string koneksi SAS 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

Nama antrean.

options: StoragePipelineOptions

Opsi untuk mengonfigurasi alur HTTP.

Detail Properti

name

Nama antrean.

string name

Nilai Properti

string

Detail Properti yang Diwariskan

accountName

accountName: string

Nilai Properti

string

Diwarisi Dari StorageClient.accountName

url

Nilai string URL.

url: string

Nilai Properti

string

Diwariskan Dari StorageClient.url

Detail Metode

clearMessages(QueueClearMessagesOptions)

Hapus menghapus semua pesan dari antrean.

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

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

Parameter

options: QueueClearMessagesOptions

Opsi untuk menghapus operasi pesan.

Mengembalikan

Promise<MessagesClearResponse>

Data respons untuk operasi pesan yang jelas.

create(QueueCreateOptions)

Membuat antrean baru di bawah akun yang ditentukan.

Lihat https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Parameter

options: QueueCreateOptions

Opsi untuk mengantre membuat operasi.

Mengembalikan

Promise<QueueCreateResponse>

Data respons untuk operasi pembuatan Antrean.

Contoh penggunaan:

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)

Membuat antrean baru di bawah akun yang ditentukan jika belum ada. Jika antrean sudah ada, antrean tidak diubah.

Lihat https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Parameter

options: QueueCreateOptions

Mengembalikan

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Menghapus antrean yang ditentukan secara permanen.

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Parameter

options: QueueDeleteOptions

Opsi untuk operasi penghapusan antrean.

Mengembalikan

Promise<QueueDeleteResponse>

Data respons untuk operasi penghapusan Antrean.

Contoh penggunaan:

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)

Menghapus antrean yang ditentukan secara permanen jika ada.

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Parameter

options: QueueDeleteOptions

Mengembalikan

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage secara permanen menghapus pesan yang ditentukan dari antreannya.

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-message2

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

Parameter

messageId: string

Id pesan.

popReceipt: string

Nilai tanda terima pop yang valid yang dikembalikan dari panggilan sebelumnya ke pesan penerima atau operasi perbarui pesan.

options: QueueDeleteMessageOptions

Opsi untuk menghapus operasi pesan.

Mengembalikan

Promise<MessageIdDeleteResponse>

Data respons untuk operasi hapus pesan.

exists(QueueExistsOptions)

Mengembalikan true jika antrean yang ditentukan ada; false jika tidak.

CATATAN: gunakan fungsi ini dengan hati-hati karena antrean yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya antrean baru mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.

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

Parameter

options: QueueExistsOptions

opsi untuk operasi Ada.

Mengembalikan

Promise<boolean>

generateSasStringToSign(QueueGenerateSasUrlOptions)

Hanya tersedia untuk QueueClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

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

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parameter

options: QueueGenerateSasUrlOptions

Parameter opsional.

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

generateSasUrl(QueueGenerateSasUrlOptions)

Hanya tersedia untuk QueueClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parameter

options: QueueGenerateSasUrlOptions

Parameter opsional.

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh input kredensial kunci delegasi pengguna.

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

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

Parameter

options: QueueGenerateSasUrlOptions

Parameter opsional.

userDelegationKey: UserDelegationKey

kunci delegasi pengguna yang digunakan untuk menandatangani URI SAS

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh input kredensial kunci delegasi pengguna.

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

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

Parameter

options: QueueGenerateSasUrlOptions

Parameter opsional.

userDelegationKey: UserDelegationKey

kunci delegasi pengguna yang digunakan untuk menandatangani URI SAS

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

getAccessPolicy(QueueGetAccessPolicyOptions)

Mendapatkan detail tentang kebijakan akses tersimpan yang ditentukan pada antrean yang dapat digunakan dengan Tanda Tangan Akses Bersama.

PERINGATAN: Tanggal JavaScript akan berpotensi kehilangan presisi saat mengurai string mulai dan kedaluwarsa. Misalnya, Tanggal baru("2018-12-31T03:44:23.8827891Z").toISOString() akan mendapatkan "2018-12-31T03:44:23.882Z".

Lihat https://learn.microsoft.com/rest/api/storageservices/get-queue-acl

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

Parameter

options: QueueGetAccessPolicyOptions

Opsi untuk Antrean mendapatkan operasi kebijakan akses.

Mengembalikan

Promise<QueueGetAccessPolicyResponse>

Data respons untuk antrean mendapatkan operasi kebijakan akses.

getProperties(QueueGetPropertiesOptions)

Mendapatkan semua metadata dan properti sistem yang ditentukan pengguna untuk antrean yang ditentukan. Metadata dikaitkan dengan antrean sebagai pasangan nama-nilai.

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

PERINGATAN: Objek metadata yang dikembalikan dalam respons akan memiliki kuncinya dalam huruf kecil, bahkan jika awalnya berisi karakter huruf besar. Ini berbeda dari kunci metadata yang dikembalikan oleh metode listQueuesQueueServiceClient menggunakan opsi includeMetadata, yang akan mempertahankan casing aslinya.

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

Parameter

options: QueueGetPropertiesOptions

Opsi untuk Mengantre mendapatkan operasi properti.

Mengembalikan

Promise<QueueGetPropertiesResponse>

Data respons untuk operasi Antrean mendapatkan properti.

peekMessages(QueuePeekMessagesOptions)

peekMessages mengambil satu atau beberapa pesan dari depan antrean tetapi tidak mengubah visibilitas pesan.

Lihat https://learn.microsoft.com/rest/api/storageservices/peek-messages

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

Parameter

options: QueuePeekMessagesOptions

Opsi untuk mengintip operasi pesan.

Mengembalikan

Promise<QueuePeekMessagesResponse>

Data respons untuk operasi mengintip pesan.

Contoh penggunaan:

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 mengambil satu atau beberapa pesan dari bagian depan antrean.

Lihat https://learn.microsoft.com/rest/api/storageservices/get-messages

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

Parameter

options: QueueReceiveMessageOptions

Opsi untuk menerima operasi pesan.

Mengembalikan

Promise<QueueReceiveMessageResponse>

Data respons untuk operasi terima pesan.

Contoh penggunaan:

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 menambahkan pesan baru ke bagian belakang antrean. Batas waktu visibilitas menentukan berapa lama pesan harus tidak terlihat oleh operasi Dequeue dan Peek. Konten pesan berukuran hingga 64KB, dan harus dalam format yang dapat disertakan dalam permintaan XML dengan pengodean UTF-8. Untuk menyertakan markup dalam pesan, konten pesan harus berupa XML-escaped atau Base64-encode.

Lihat https://learn.microsoft.com/rest/api/storageservices/put-message

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

Parameter

messageText: string

Teks pesan yang akan dikirim

options: QueueSendMessageOptions

Opsi untuk mengirim operasi pesan.

Mengembalikan

Promise<QueueSendMessageResponse>

Data respons untuk operasi kirim pesan.

Contoh penggunaan:

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)

Mengatur kebijakan akses tersimpan untuk antrean yang dapat digunakan dengan Tanda Tangan Akses Bersama.

Lihat https://learn.microsoft.com/rest/api/storageservices/set-queue-acl

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

Parameter

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

Opsi untuk Mengantre mengatur operasi kebijakan akses.

Mengembalikan

Promise<QueueSetAccessPolicyResponse>

Data respons untuk operasi kebijakan akses set antrean.

setMetadata(Metadata, QueueSetMetadataOptions)

Mengatur satu atau beberapa pasangan nilai nama yang ditentukan pengguna untuk antrean yang ditentukan.

Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter opsi, metadata antrean akan dihapus.

Lihat https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata

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

Parameter

metadata: Metadata

Jika tidak ada metadata yang disediakan, semua metadata yang ada akan dihapus.

options: QueueSetMetadataOptions

Opsi untuk Operasi metadata set antrean.

Mengembalikan

Promise<QueueSetMetadataResponse>

Data respons untuk operasi metadata set antrean.

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

Pembaruan mengubah batas waktu visibilitas pesan dan konten. Konten pesan berukuran hingga 64KB, dan harus dalam format yang dapat disertakan dalam permintaan XML dengan pengodean UTF-8. Untuk menyertakan markup dalam pesan, konten pesan harus berupa XML-escaped atau Base64-encode.

Lihat https://learn.microsoft.com/rest/api/storageservices/update-message

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

Parameter

messageId: string

Id pesan

popReceipt: string

Nilai tanda terima pop yang valid yang dikembalikan dari panggilan sebelumnya ke pesan penerima atau operasi perbarui pesan.

message: string

Pesan untuk diperbarui. Jika parameter ini tidak terdefinisi, konten pesan tidak akan diperbarui.

visibilityTimeout: number

Menentukan nilai batas waktu visibilitas baru, dalam detik, relatif terhadap waktu server. Nilai baru harus lebih besar dari atau sama dengan 0, dan tidak boleh lebih besar dari 7 hari. Batas waktu visibilitas pesan tidak dapat diatur ke nilai lebih lambat dari waktu kedaluwarsa. Pesan dapat diperbarui hingga dihapus atau telah kedaluwarsa.

options: QueueUpdateMessageOptions

Opsi untuk memperbarui operasi pesan.

Mengembalikan

Promise<MessageIdUpdateResponse>

Data respons untuk operasi pesan pembaruan.

Bagikan melalui

QueueClient class

Konstruktor

Properti

Properti yang Diwariskan

Metode

Detail Konstruktor

QueueClient(string, Pipeline)

Parameter

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

Parameter

QueueClient(string, string, StoragePipelineOptions)

Parameter

Detail Properti

name

Nilai Properti

Detail Properti yang Diwariskan

accountName

Nilai Properti

url

Nilai Properti

Detail Metode

clearMessages(QueueClearMessagesOptions)

Parameter

Mengembalikan

create(QueueCreateOptions)

Parameter

Mengembalikan

createIfNotExists(QueueCreateOptions)

Parameter

Mengembalikan

delete(QueueDeleteOptions)

Parameter

Mengembalikan

deleteIfExists(QueueDeleteOptions)

Parameter

Mengembalikan

deleteMessage(string, string, QueueDeleteMessageOptions)

Parameter

Mengembalikan

exists(QueueExistsOptions)

Parameter

Mengembalikan

generateSasStringToSign(QueueGenerateSasUrlOptions)

Parameter

Mengembalikan

generateSasUrl(QueueGenerateSasUrlOptions)

Parameter

Mengembalikan

generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)

Parameter

Mengembalikan

generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)

Parameter

Mengembalikan

getAccessPolicy(QueueGetAccessPolicyOptions)

Parameter

Mengembalikan

getProperties(QueueGetPropertiesOptions)

Parameter

Mengembalikan

peekMessages(QueuePeekMessagesOptions)

Parameter

Mengembalikan

receiveMessages(QueueReceiveMessageOptions)

Parameter

Mengembalikan

sendMessage(string, QueueSendMessageOptions)

Parameter

Mengembalikan

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Parameter

Mengembalikan

setMetadata(Metadata, QueueSetMetadataOptions)

Parameter

Mengembalikan

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

Parameter

Mengembalikan