Bagikan melalui

@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 diatur sebagai bidang izin pada objek <xref: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 <xref: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 <xref:AccountSASSignatureValues>. Dimungkinkan untuk membangun string layanan tanpa kelas ini, tetapi urutan layanan khusus dan kelas ini menjamin kebenaran.
AnonymousCredential

AnonymousCredential menyediakan anggota <xref:CredentialPolicyCreator> yang digunakan untuk membuat objek <xref:AnonymousCredentialPolicy>. <xref:AnonymousCredentialPolicy> digunakan dengan permintaan HTTP 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).
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 berikan kebijakan sebagai referensi 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 ditetapkan sebagai bidang izin pada objek <xref:QueueSASSignatureValues>. 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 jenis <xref:AccountSASSignatureValues> dan <xref:QueueSASSignatureValues>. Setelah dibuat, itu dapat dikodekan ke dalam <xref:String> 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.
StorageBrowserPolicy

StorageBrowserPolicy akan menangani perbedaan antara Node.js dan runtime browser, termasuk:

  1. Browser menyimpan permintaan GET/HEAD dengan menambahkan header kondisional seperti 'IF_MODIFIED_SINCE'. StorageBrowserPolicy adalah kebijakan yang digunakan untuk menambahkan kueri tanda waktu ke URL permintaan GET/HEAD sehingga menghindari cache browser.

  2. Hapus header cookie untuk keamanan

  3. Menghapus header panjang konten untuk menghindari peringatan browser
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory adalah kelas pabrik yang membantu menghasilkan objek <xref:StorageBrowserPolicy>.
StorageClient

StorageClient mewakili kelas klien berbasis untuk <xref:QueueServiceClient>, <xref:QueueClient>, dll.
StorageClientContext
StorageRetryPolicy

Coba lagi kebijakan dengan coba lagi eksponensial dan coba lagi linier yang diterapkan.
StorageRetryPolicyFactory

StorageRetryPolicyFactory adalah kelas pabrik yang membantu menghasilkan objek <xref:StorageRetryPolicy>.
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 <xref:SASQueryParameters> ada karena yang pertama dapat diubah dan representasi logis sementara yang terakhir tidak dapat diubah dan digunakan untuk menghasilkan permintaan REST yang sebenarnya.
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
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
PipelineOptions

Antarmuka opsi untuk konstruktor Alur.
QueueClearMessagesOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.clearMessages>
QueueCreateHeaders

Menentukan header untuk operasi Queue_create.
QueueCreateIfNotExistsResponse

Berisi data respons untuk operasi <xref:QueueClient.createIfNotExists>.
QueueCreateOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.create>
QueueDeleteHeaders

Menentukan header untuk operasi Queue_delete.
QueueDeleteIfExistsResponse

Berisi data respons untuk operasi <xref:QueueClient.deleteIfExists>.
QueueDeleteMessageOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.deleteMessage>
QueueDeleteOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.delete>
QueueExistsOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.exists>
QueueGenerateSasUrlOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.generateSasUrl>.
QueueGetAccessPolicyHeaders

Menentukan header untuk operasi Queue_getAccessPolicy.
QueueGetAccessPolicyOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.getAccessPolicy>
QueueGetPropertiesHeaders

Menentukan header untuk operasi Queue_getProperties.
QueueGetPropertiesOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.getProperties>
QueueItem

Antrean Azure Storage.
QueuePeekMessagesOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.peekMessages>
QueueReceiveMessageOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.receiveMessages>
QueueSASSignatureValues

HANYA TERSEDIA DALAM RUNTIME NODE.JS. QueueSASSSignatureValues digunakan untuk membantu menghasilkan token SAS layanan Antrean untuk antrean.
QueueSendMessageOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.sendMessage>
QueueServiceProperties

Properti Layanan Penyimpanan.
QueueServiceStatistics

Statistik untuk layanan penyimpanan.
QueueSetAccessPolicyHeaders

Menentukan header untuk operasi Queue_setAccessPolicy.
QueueSetAccessPolicyOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.setAccessPolicy>
QueueSetMetadataHeaders

Menentukan header untuk operasi Queue_setMetadata.
QueueSetMetadataOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.setMetadata>
QueueUpdateMessageOptions

Opsi untuk mengonfigurasi operasi <xref:QueueClient.updateMessage>
RetentionPolicy

kebijakan penyimpanan
SasIPRange

Rentang IP yang diizinkan untuk SAS.
ServiceGenerateAccountSasUrlOptions

Opsi untuk mengonfigurasi operasi <xref:QueueServiceClient.generateAccountSasUrl>.
ServiceGetPropertiesHeaders

Menentukan header untuk operasi Service_getProperties.
ServiceGetPropertiesOptions

Opsi untuk mengonfigurasi operasi <xref:QueueServiceClient.getProperties>
ServiceGetStatisticsHeaders

Menentukan header untuk operasi Service_getStatistics.
ServiceGetStatisticsOptions

Opsi untuk mengonfigurasi operasi <xref:QueueServiceClient.getStatistics>
ServiceListQueuesOptions

Opsi untuk mengonfigurasi operasi <xref:QueueServiceClient.listQueues>
ServiceListQueuesSegmentHeaders

Menentukan header untuk operasi Service_listQueuesSegment.
ServiceSetPropertiesHeaders

Menentukan header untuk operasi Service_setProperties.
ServiceSetPropertiesOptions

Opsi untuk mengonfigurasi operasi <xref:QueueServiceClient.setProperties>
SignedIdentifier

Pengidentifikasi yang ditandatangani.
SignedIdentifierModel

pengidentifikasi yang ditandatangani
StorageClientOptionalParams

Parameter opsional.
StoragePipelineOptions

Antarmuka opsi untuk metode newPipeline().
StorageRetryOptions

Antarmuka opsi coba lagi Antrean Penyimpanan.

Alias Jenis

CredentialPolicyCreator

Fungsi pabrik yang membuat CredentialPolicy baru yang menggunakan nextPolicy yang disediakan.
GeoReplicationStatusType

Menentukan nilai untuk GeoReplicationStatusType.
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 <xref:QueueClient.clearMessages>.
QueueCreateResponse

Berisi data respons untuk operasi pembuatan.
QueueDeleteMessageResponse

Berisi data respons untuk operasi <xref:QueueClient.deleteMessage>.
QueueDeleteResponse

Berisi data respons untuk operasi penghapusan.
QueueGetAccessPolicyResponse

Berisi data respons untuk operasi <xref:QueueClient.getAccessPolicy>.
QueueGetPropertiesResponse

Berisi data respons untuk operasi getProperties.
QueuePeekMessagesResponse

Berisi data respons untuk operasi <xref:QueueClient.peekMessages>.
QueueReceiveMessageResponse

Berisi data respons untuk operasi <xref:QueueClient.receiveMessages>.
QueueSendMessageResponse

Berisi data respons untuk operasi <xref:QueueClient.sendMessage>.
QueueSetAccessPolicyResponse

Berisi data respons untuk operasi setAccessPolicy.
QueueSetMetadataResponse

Berisi data respons untuk operasi setMetadata.
QueueUpdateMessageResponse

Berisi data respons untuk operasi <xref:QueueClient.updateMessage>.
ReceivedMessageItem

Objek yang dikembalikan dalam array receivedMessageItems saat memanggil <xref:QueueClient.receiveMessages>. Lihat: <xref:QueueReceiveMessageResponse>
ServiceGetPropertiesResponse

Berisi data respons untuk operasi getProperties.
ServiceGetStatisticsResponse

Berisi data respons untuk operasi getStatistics.
ServiceListQueuesSegmentResponse

Berisi data respons untuk operasi listQueuesSegment.
ServiceSetPropertiesResponse

Berisi data respons untuk operasi setProperties.

Enum

SASProtocol

Protokol untuk SAS yang dihasilkan.
StorageRetryPolicyType

Jenis RetryPolicy.

Fungsi

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

HANYA TERSEDIA DALAM RUNTIME NODE.JS. Menghasilkan objek <xref:SASQueryParameters> yang berisi semua parameter kueri SAS yang diperlukan untuk membuat permintaan REST yang sebenarnya.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

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.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Membuat objek Alur baru dengan Kredensial yang disediakan.

Detail Fungsi

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

HANYA TERSEDIA DALAM RUNTIME NODE.JS. Menghasilkan objek <xref:SASQueryParameters> yang berisi semua parameter kueri SAS yang diperlukan untuk membuat permintaan REST yang sebenarnya.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parameter

accountSASSignatureValues
AccountSASSignatureValues

Nilai Tanda Tangan SAS akun

sharedKeyCredential
StorageSharedKeyCredential

Kredensial kunci bersama.

Mengembalikan

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

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, sharedKeyCredential: StorageSharedKeyCredential)

Parameter

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Mengembalikan

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Membuat objek Alur baru dengan Kredensial yang disediakan.

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

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

Pilihan.

Mengembalikan

Pipeline

Objek Alur baru.