@azure/storage-queue package

Kelas

AccountSASPermissions	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Ini adalah kelas pembantu untuk membuat string yang mewakili izin yang diberikan oleh AccountSAS. Mengatur nilai ke true berarti bahwa setiap SAS yang menggunakan izin ini akan memberikan izin untuk operasi tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan ditetapkan sebagai bidang izin pada objek AccountSASSignatureValues. Dimungkinkan untuk membangun string izin tanpa kelas ini, tetapi urutan izin khusus dan kelas ini menjamin kebenaran.
AccountSASResourceTypes	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Ini adalah kelas pembantu untuk membuat string yang mewakili sumber daya yang dapat diakses oleh AccountSAS. Mengatur nilai ke true berarti bahwa setiap SAS yang menggunakan izin ini akan memberikan akses ke jenis sumber daya tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan ditetapkan sebagai bidang sumber daya pada objek AccountSASSignatureValues. Dimungkinkan untuk membangun string sumber daya tanpa kelas ini, tetapi urutan sumber daya khusus dan kelas ini menjamin kebenaran.
AccountSASServices	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Ini adalah kelas pembantu untuk membuat string yang mewakili layanan yang dapat diakses oleh AccountSAS. Mengatur nilai ke true berarti bahwa SETIAP SAS yang menggunakan izin ini akan memberikan akses ke layanan tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan ditetapkan sebagai bidang layanan pada objek AccountSASSignatureValues. Dimungkinkan untuk membangun string layanan tanpa kelas ini, tetapi urutan layanan khusus dan kelas ini menjamin kebenaran.
AnonymousCredential	AnonymousCredential menyediakan anggota credentialPolicyCreator yang digunakan untuk membuat objek AnonymousCredentialPolicy. AnonymousCredentialPolicy digunakan dengan permintaan HTTP (S) yang membaca sumber daya publik atau untuk digunakan dengan Tanda Tangan Akses Bersama (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy digunakan dengan permintaan HTTP (S) yang membaca sumber daya publik atau untuk digunakan dengan Tanda Tangan Akses Bersama (SAS).
BaseRequestPolicy	Kelas dasar dari mana semua kebijakan permintaan berasal.
Credential	Info masuk adalah kelas abstrak untuk penandatanganan permintaan HTTP Azure Storage. Kelas ini akan menghosting pabrik credentialPolicyCreator yang menghasilkan CredentialPolicy.
CredentialPolicy	Kebijakan kredensial yang digunakan untuk menandatangani permintaan HTTP sebelum mengirim. Ini adalah kelas abstrak.
Pipeline	Kelas Alur yang berisi kebijakan permintaan HTTP. Anda dapat membuat Alur default dengan memanggil newPipeline. Atau Anda dapat membuat Alur dengan kebijakan Anda sendiri oleh konstruktor Alur. Lihat newPipeline dan kebijakan yang disediakan sebelum menerapkan Alur yang disesuaikan.
QueueClient	QueueClient mewakili URL ke pesan Azure Storage Queue yang memungkinkan Anda memanipulasi pesannya.
QueueSASPermissions	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Ini adalah kelas pembantu untuk membuat string yang mewakili izin yang diberikan oleh ServiceSAS ke Antrean. Mengatur nilai ke true berarti bahwa setiap SAS yang menggunakan izin ini akan memberikan izin untuk operasi tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan diatur sebagai bidang izin pada objek QueueSASSSignatureValues. Dimungkinkan untuk membangun string izin tanpa kelas ini, tetapi urutan izin khusus dan kelas ini menjamin kebenaran.
QueueServiceClient	QueueServiceClient mewakili URL ke layanan Antrean Azure Storage yang memungkinkan Anda memanipulasi antrean.
SASQueryParameters	Mewakili komponen yang membentuk parameter kueri Azure Storage SAS. Jenis ini tidak dibangun langsung oleh pengguna; ini hanya dihasilkan oleh AccountSASSignatureValues dan jenis QueueSASSignatureValues. Setelah dibuat, itu dapat dikodekan ke dalam toString() dan ditambahkan ke URL secara langsung (meskipun hati-hati harus diambil di sini jika ada parameter kueri yang ada, yang mungkin memengaruhi cara yang sesuai untuk menambahkan parameter kueri ini). CATATAN: Instans kelas ini tidak dapat diubah.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory adalah kelas pabrik yang membantu menghasilkan objek StorageBrowserPolicy.
StorageRetryPolicy	Coba lagi kebijakan dengan coba lagi eksponensial dan coba lagi linier yang diterapkan.
StorageRetryPolicyFactory	StorageRetryPolicyFactory adalah kelas pabrik yang membantu menghasilkan storageRetryPolicy objek.
StorageSharedKeyCredential	HANYA TERSEDIA DALAM RUNTIME NODE.JS. StorageSharedKeyCredential untuk otorisasi kunci akun layanan Azure Storage.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy adalah kebijakan yang digunakan untuk menandatangani permintaan HTTP dengan kunci bersama.

Antarmuka

AccessPolicy	Kebijakan Akses
AccountSASSignatureValues	HANYA TERSEDIA DALAM RUNTIME NODE.JS. AccountSASSignatureValues digunakan untuk menghasilkan Tanda Tangan Akses Bersama (SAS) untuk akun Azure Storage. Setelah semua nilai di sini diatur dengan tepat, panggil generateSASQueryParameters() untuk mendapatkan representasi SAS yang sebenarnya dapat diterapkan ke url antrean. Catatan: bahwa kelas ini dan SASQueryParameters ada karena yang pertama dapat diubah dan representasi logis sementara yang terakhir tidak dapat diubah dan digunakan untuk menghasilkan permintaan REST yang sebenarnya. Lihat https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 untuk informasi konseptual selengkapnya tentang SAS Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas untuk deskripsi parameter, termasuk yang diperlukan
CommonOptions	Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
CorsRule	CORS adalah fitur HTTP yang memungkinkan aplikasi web yang berjalan di bawah satu domain untuk mengakses sumber daya di domain lain. Browser web menerapkan pembatasan keamanan yang dikenal sebagai kebijakan asal yang sama yang mencegah halaman web memanggil API di domain lain; CORS menyediakan cara aman untuk mengizinkan satu domain (domain asal) untuk memanggil API di domain lain
DequeuedMessageItem	Objek yang dikembalikan dalam array QueueMessageList saat memanggil Dapatkan Pesan pada Antrean.
EnqueuedMessage	Objek yang dikembalikan dalam array QueueMessageList saat memanggil Letakkan Pesan pada Antrean
GeoReplication	Geo-Replication informasi untuk Layanan Penyimpanan Sekunder
HttpHeaders	Kumpulan pasangan kunci/nilai header HTTP.
HttpOperationResponse	Respons Http yang kompatibel dengan core-v1(core-http).
HttpResponse	Representasi respons HTTP yang menyertakan referensi ke permintaan yang berasal darinya.
ListQueuesSegmentResponse	Objek dikembalikan saat memanggil Daftar Antrean pada Layanan Antrean.
Logging	Pengaturan Pengelogan Azure Analytics.
MessageIdDeleteHeaders	Menentukan header untuk operasi MessageId_delete.
MessageIdUpdateHeaders	Menentukan header untuk operasi MessageId_update.
MessagesClearHeaders	Menentukan header untuk operasi Messages_clear.
MessagesDequeueHeaders	Menentukan header untuk operasi Messages_dequeue.
MessagesDequeueOptionalParams	Parameter opsional.
MessagesEnqueueHeaders	Menentukan header untuk operasi Messages_enqueue.
MessagesEnqueueOptionalParams	Parameter opsional.
MessagesPeekHeaders	Menentukan header untuk operasi Messages_peek.
MessagesPeekOptionalParams	Parameter opsional.
Metadata	Kumpulan pasangan string nilai kunci.
Metrics	Antarmuka yang mewakili Metrik.
PeekedMessageItem	Objek yang dikembalikan dalam array QueueMessageList saat memanggil Pesan Intip pada Antrean
PipelineLike	Antarmuka untuk kelas Alur yang berisi kebijakan permintaan HTTP. Anda dapat membuat Alur default dengan memanggil newPipeline. Atau Anda dapat membuat Alur dengan kebijakan Anda sendiri oleh konstruktor Alur. Lihat newPipeline dan kebijakan yang disediakan sebelum menerapkan Alur yang disesuaikan.
PipelineOptions	Antarmuka opsi untuk konstruktor Alur.
QueueClearMessagesOptions	Opsi untuk mengonfigurasi operasi clearMessages
QueueCreateHeaders	Menentukan header untuk operasi Queue_create.
QueueCreateIfNotExistsResponse	Berisi data respons untuk operasi createIfNotExists.
QueueCreateOptions	Opsi untuk mengonfigurasi operasi membuat
QueueDeleteHeaders	Menentukan header untuk operasi Queue_delete.
QueueDeleteIfExistsResponse	Berisi data respons untuk operasi deleteIfExists.
QueueDeleteMessageOptions	Opsi untuk mengonfigurasi operasi deleteMessage
QueueDeleteOptions	Opsi untuk mengonfigurasi operasi penghapusan
QueueExistsOptions	Opsi untuk mengonfigurasi ada operasi
QueueGenerateSasUrlOptions	Opsi untuk mengonfigurasi menghasilkan operasi SasUrl.
QueueGetAccessPolicyHeaders	Menentukan header untuk operasi Queue_getAccessPolicy.
QueueGetAccessPolicyOptions	Opsi untuk mengonfigurasi operasi getAccessPolicy
QueueGetPropertiesHeaders	Menentukan header untuk operasi Queue_getProperties.
QueueGetPropertiesOptions	Opsi untuk mengonfigurasi operasi getProperties
QueueItem	Antrean Azure Storage.
QueuePeekMessagesOptions	Opsi untuk mengonfigurasi operasi peekMessages
QueueReceiveMessageOptions	Opsi untuk mengonfigurasi operasi receiveMessages
QueueSASSignatureValues	HANYA TERSEDIA DALAM RUNTIME NODE.JS. QueueSASSSignatureValues digunakan untuk membantu menghasilkan token SAS layanan Antrean untuk antrean.
QueueSendMessageOptions	Opsi untuk mengonfigurasi operasi sendMessage
QueueServiceProperties	Properti Layanan Penyimpanan.
QueueServiceStatistics	Statistik untuk layanan penyimpanan.
QueueSetAccessPolicyHeaders	Menentukan header untuk operasi Queue_setAccessPolicy.
QueueSetAccessPolicyOptions	Opsi untuk mengonfigurasi setAccessPolicy operasi
QueueSetMetadataHeaders	Menentukan header untuk operasi Queue_setMetadata.
QueueSetMetadataOptions	Opsi untuk mengonfigurasi operasi setMetadata
QueueUpdateMessageOptions	Opsi untuk mengonfigurasi operasi updateMessage
RequestPolicy	Antarmuka yang kompatibel untuk kebijakan permintaan core-http
RequestPolicyFactory	Antarmuka untuk kompatibilitas dengan RequestPolicyFactory core-http
RequestPolicyOptions	Antarmuka untuk kompatibilitas dengan RequestPolicy
ResponseLike	Objek dengan properti _response sederhana.
ResponseWithBody	Objek dengan properti _response yang memiliki isi dan header sudah diurai ke dalam jenis yang diketahui.
ResponseWithHeaders	Objek dengan properti _response yang memiliki header sudah diurai ke dalam objek yang dititik.
RetentionPolicy	kebijakan penyimpanan
SasIPRange	Rentang IP yang diizinkan untuk SAS.
ServiceClientOptions	Subset dari `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Opsi untuk mengonfigurasi operasi generateAccountSasUrl.
ServiceGetPropertiesHeaders	Menentukan header untuk operasi Service_getProperties.
ServiceGetPropertiesOptions	Opsi untuk mengonfigurasi operasi getProperties
ServiceGetStatisticsHeaders	Menentukan header untuk operasi Service_getStatistics.
ServiceGetStatisticsOptions	Opsi untuk mengonfigurasi operasi getStatistics
ServiceGetUserDelegationKeyHeaders	Menentukan header untuk operasi Service_getUserDelegationKey.
ServiceGetUserDelegationKeyOptions	Opsi untuk mengonfigurasi Layanan - Dapatkan Kunci Delegasi Pengguna.
ServiceListQueuesOptions	Opsi untuk mengonfigurasi operasi listQueues
ServiceListQueuesSegmentHeaders	Menentukan header untuk operasi Service_listQueuesSegment.
ServiceSetPropertiesHeaders	Menentukan header untuk operasi Service_setProperties.
ServiceSetPropertiesOptions	Opsi untuk mengonfigurasi operasi setProperties
SignedIdentifier	Pengidentifikasi yang ditandatangani.
SignedIdentifierModel	ID yang ditandatangani
StoragePipelineOptions	Antarmuka opsi untuk fungsi newPipeline.
StorageRetryOptions	Antarmuka opsi coba lagi Storage Blob.
UserDelegationKey	Kunci delegasi pengguna.
UserDelegationKeyModel	Kunci delegasi pengguna
WebResource	Deskripsi permintaan HTTP yang akan dibuat ke server jarak jauh.

Alias Jenis

CredentialPolicyCreator	Fungsi pabrik yang membuat CredentialPolicy baru yang menggunakan nextPolicy yang disediakan.
GeoReplicationStatusType	Menentukan nilai untuk GeoReplicationStatusType.
HttpRequestBody	Jenis isi yang didukung pada permintaan. NodeJS.ReadableStream dan () => NodeJS.ReadableStream hanya node. Blob, ReadableStream<Uint8Array>, dan () => ReadableStream<Uint8Array> hanya browser.
ListQueuesIncludeType	Menentukan nilai untuk ListQueuesIncludeType. Nilai yang mungkin termasuk: 'metadata'
MessageIdDeleteResponse	Berisi data respons untuk operasi penghapusan.
MessageIdUpdateResponse	Berisi data respons untuk operasi pembaruan.
MessagesClearResponse	Berisi data respons untuk operasi yang jelas.
QueueClearMessagesResponse	Berisi data respons untuk operasi clearMessages.
QueueCreateResponse	Berisi data respons untuk operasi pembuatan.
QueueDeleteMessageResponse	Berisi data respons untuk operasi deleteMessage.
QueueDeleteResponse	Berisi data respons untuk operasi penghapusan.
QueueGetAccessPolicyResponse	Berisi data respons untuk operasi getAccessPolicy.
QueueGetPropertiesResponse	Berisi data respons untuk operasi getProperties.
QueuePeekMessagesResponse	Berisi data respons untuk operasi peekMessages.
QueueReceiveMessageResponse	Berisi data respons untuk operasi receiveMessages.
QueueSendMessageResponse	Berisi data respons untuk operasi sendMessage.
QueueSetAccessPolicyResponse	Berisi data respons untuk operasi setAccessPolicy.
QueueSetMetadataResponse	Berisi data respons untuk operasi setMetadata.
QueueUpdateMessageResponse	Berisi data respons untuk operasi updateMessage.
ReceivedMessageItem	Objek yang dikembalikan dalam array `receivedMessageItems` saat memanggil receiveMessages. Lihat: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	Berisi data respons untuk operasi getProperties.
ServiceGetStatisticsResponse	Berisi data respons untuk operasi getStatistics.
ServiceGetUserDelegationKeyResponse	Berisi data respons untuk getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) operasi.
ServiceListQueuesSegmentResponse	Berisi data respons untuk operasi listQueuesSegment.
ServiceSetPropertiesResponse	Berisi data respons untuk operasi setProperties.
WithResponse	Jenis yang mewakili hasil operasi dengan properti _response yang diketahui.

Enum

SASProtocol	Protokol untuk SAS yang dihasilkan.
StorageQueueAudience	Menentukan audiens cloud yang diketahui untuk Storage.
StorageRetryPolicyType	RetryPolicy jenis.

Fungsi

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Menghasilkan objek SASQueryParameters yang berisi semua parameter kueri SAS yang diperlukan untuk membuat permintaan REST yang sebenarnya. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, UserDelegationKey, string)	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Membuat instans SASQueryParameters. Hanya menerima pengaturan yang diperlukan untuk membuat SAS. Untuk pengaturan opsional, atur properti yang sesuai secara langsung, seperti izin, startsOn, dan pengidentifikasi. PERINGATAN: Ketika pengidentifikasi tidak disediakan, izin dan expiresOn diperlukan. Anda HARUS menetapkan nilai untuk pengidentifikasi atau kedaluwarsa Izin & secara manual jika Anda menginisialisasi dengan konstruktor ini.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
getQueueServiceAccountAudience(string)	Untuk mendapatkan audiens OAuth untuk akun penyimpanan untuk layanan antrean.
isPipelineLike(unknown)	Pembantu untuk memutuskan apakah argumen tertentu memenuhi kontrak Alur
newPipeline(StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Membuat objek Alur baru dengan Kredensial yang disediakan.

Variabel

RestError	Jenis kesalahan kustom untuk permintaan alur yang gagal.
StorageOAuthScopes	Cakupan OAuth untuk digunakan dengan Azure Storage.
logger	Konfigurasi `@azure/logger` untuk paket ini.

Detail Fungsi

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Menghasilkan objek SASQueryParameters yang berisi semua parameter kueri SAS yang diperlukan untuk membuat permintaan REST yang sebenarnya.

Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameter

accountSASSignatureValues: AccountSASSignatureValues

Nilai Tanda Tangan SAS akun

sharedKeyCredential: StorageSharedKeyCredential

Kredensial kunci bersama.

Mengembalikan

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, UserDelegationKey, string)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Membuat instans SASQueryParameters.

Hanya menerima pengaturan yang diperlukan untuk membuat SAS. Untuk pengaturan opsional, atur properti yang sesuai secara langsung, seperti izin, startsOn, dan pengidentifikasi.

PERINGATAN: Ketika pengidentifikasi tidak disediakan, izin dan expiresOn diperlukan. Anda HARUS menetapkan nilai untuk pengidentifikasi atau kedaluwarsa Izin & secara manual jika Anda menginisialisasi dengan konstruktor ini.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Parameter

queueSASSignatureValues: QueueSASSignatureValues

userDelegationKey: UserDelegationKey

accountName: string

Mengembalikan

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameter

queueSASSignatureValues: QueueSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Mengembalikan

SASQueryParameters

getQueueServiceAccountAudience(string)

Untuk mendapatkan audiens OAuth untuk akun penyimpanan untuk layanan antrean.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parameter

storageAccountName: string

Mengembalikan

string

isPipelineLike(unknown)

Pembantu untuk memutuskan apakah argumen tertentu memenuhi kontrak Alur

function isPipelineLike(pipeline: unknown): pipeline

Parameter

pipeline: unknown

Argumen yang mungkin berupa Alur

Mengembalikan

pipeline

true ketika argumen memenuhi kontrak Alur

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Membuat objek Alur baru dengan Kredensial yang disediakan.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parameter

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.

pipelineOptions: StoragePipelineOptions

Optional. Options.

Mengembalikan

Pipeline

Objek Alur baru.

Variable Details

RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.

RestError: RestErrorConstructor

Jenis

RestErrorConstructor

StorageOAuthScopes

Cakupan OAuth untuk digunakan dengan Azure Storage.

StorageOAuthScopes: string | string[]

Jenis

string | string[]

logger

Konfigurasi @azure/logger untuk paket ini.

logger: AzureLogger

Jenis

AzureLogger

Bagikan melalui

@azure/storage-queue package

Kelas

Antarmuka

Alias Jenis

Enum

Fungsi

Variabel

Detail Fungsi

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parameter

Mengembalikan

generateQueueSASQueryParameters(QueueSASSignatureValues, UserDelegationKey, string)

Parameter

Mengembalikan

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

Parameter

Mengembalikan

getQueueServiceAccountAudience(string)

Parameter

Mengembalikan

isPipelineLike(unknown)

Parameter

Mengembalikan

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parameter

Mengembalikan

Variable Details

RestError

Jenis

StorageOAuthScopes

Jenis

logger

Jenis