Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Penting
API ini usang dan dihentikan pada 11/1/2021 dan tidak boleh lagi digunakan.
Membuat langganan baru. Setelah dibuat, manifes sumber daya langganan tidak dapat diubah. Operasi ini tidak idempotensi. Mengulangi panggilan buat setelah langganan dengan nama yang sama (di bawah topik dan namespace yang sama) telah berhasil dibuat, menghasilkan pesan kesalahan Konflik 409.
Jika Anda membuat langganan dengan nama yang berisi karakter khusus atau dikodekan (misalnya, "uji? Name=value&", yang dikodekan ke "test%3FName%3Dvalue%26"), pengecualian tidak sah (401) dihasilkan.
Perhatikan pembatasan nama langganan berikut:
Hanya boleh berisi huruf, angka, titik (.), tanda hubung (-), dan garis bawah (_).
Beberapa segmen tidak diizinkan.
Garis miring (/) tidak diizinkan sebagai awalan atau akhiran nama langganan.
Jumlah karakter maksimum adalah 50.
Minta
| Metode | Meminta URI | Versi HTTP |
|---|---|---|
| PUT | https://management.core.windows.net/{subscription ID}/services/ServiceBus/Namespaces/Topics/Subscriptions/{Subscription Name} | HTTP/1.1 |
Judul Permintaan
Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.
| Header Permintaan | Deskripsi |
|---|---|
| Jenis-Konten | application/xml;type=entry; charset=utf-8 |
| Ruang nama | Url Titik Akhir Manajemen |
| x-ms-version | 2012-03-01 |
Permintaan ini juga memerlukan sertifikat klien. Sertifikat ini harus cocok dengan sertifikat yang Anda unggah untuk langganan tertentu.
Isi Permintaan
Tabel berikut ini menjelaskan elemen kunci dari isi permintaan:
| Nama Properti | Jenis | Deskripsi |
|---|---|---|
| DefaultMessageTimeToLive | Tanggalwaktu XML | Berdasarkan apakah dead-lettering diaktifkan, jika pesan telah disimpan dalam topik selama lebih dari waktu yang ditentukan, pesan secara otomatis dipindahkan ke antrean dead letter, atau dihapus. Nilai ini ditimpa oleh TTL yang ditentukan pada pesan jika pesan TTL lebih kecil dari TTL yang ditetapkan pada topik. Nilai ini tidak dapat diubah setelah topik dibuat: - Rentang: 1 detik – 14 hari. - Default: 14 hari. |
| LockDuration | Tanggalwaktu XML | Pengaturan ini menentukan jumlah waktu, dalam detik, di mana pesan harus dikunci untuk diproses oleh penerima. Setelah periode ini, pesan dibuka kuncinya dan tersedia untuk dikonsumsi oleh penerima berikutnya. Hanya dapat diatur pada waktu pembuatan topik: - Rentang: 0–5 menit. 0 berarti pesan tidak terkunci. - Default: 30s. |
| RequiresSession | Boolean | Hanya dapat diatur pada waktu pembuatan topik. Jika diatur ke true, topik sadar sesi dan hanya SessionReceiver didukung. Topik yang sadar sesi tidak didukung melalui REST.- Default: False. |
| EnableDeadLetteringOnMessageExpiration | Boolean | Hanya dapat diatur pada waktu pembuatan langganan. - Default: False. Bidang ini menentukan bagaimana Azure Service Bus menangani pesan dengan TTL yang kedaluwarsa. Jika true dan pesan kedaluwarsa, Azure Service Bus memindahkan pesan dari topik ke subantrean surat mati untuk topik tersebut. Jika false, pesan dihapus secara permanen dari topik. |
| DeadLetteringOnFilterEvaluationExceptions | Menentukan cara Azure Service Bus menangani pesan yang menyebabkan pengecualian selama evaluasi filter langganan. Jika true, pesan yang menyebabkan pengecualian dipindahkan ke antrean surat gagal langganan. Jika tidak, itu dibuang. Secara default, parameter ini diatur ke true, memungkinkan Anda untuk menyelidiki penyebab pengecualian. Ini dapat terjadi dari pesan yang salah bentuk, atau asumsi yang salah dibuat dalam filter tentang bentuk pesan. Hanya dapat diatur pada waktu pembuatan topik.- Default: true |
|
| EnableBatchedOperations | Mengaktifkan atau menonaktifkan perilaku batching sisi layanan saat melakukan operasi untuk antrean tertentu. Saat diaktifkan, Azure Service Bus mengumpulkan/mengumpulkan beberapa operasi ke backend, agar lebih efisien dalam koneksi. Jika Anda menginginkan latensi operasi yang lebih rendah, Anda dapat menonaktifkan fitur ini. Default: false |
|
| MaxDeliveryCount | Bilangan Bulat Tidak Bertanda | Frekuensi maksimum Service Bus mencoba mengirimkan pesan sebelum pesan di-dead-letter atau dibuang. - Default: 10 |
| MessageCount | Bilangan Bulat Tidak Bertanda | Melaporkan jumlah pesan dalam langganan yang belum dihapus antreannya, seperti yang dilaporkan oleh sistem pemantauan. |
Respons
Respons mencakup kode status HTTP dan sekumpulan header respons.
Kode Respons
Catatan
Jika Anda membuat namespace dengan nama yang berisi karakter khusus atau dikodekan (misalnya, test?Name=value&, yang dikodekan ke test%3FName%3Dvalue%26), pengecualian (401) Tidak sah akan dihasilkan.
| Kode | Deskripsi |
|---|---|
| 201 | Langganan berhasil dibuat. |
| 400 | Isi permintaan tidak valid. |
| 401 | Kegagalan otorisasi. |
| 403 | Kuota terlampaui; langganan tidak dibuat. |
| 409 | Langganan yang ditentukan sudah ada (atau jalur yang ditentukan sudah ditempati). |
| 500 | Kesalahan internal. |
Untuk informasi tentang kode status, lihat Status dan Kode Kesalahan.
Header Respons
Tidak ada.
Isi Respons
Deskripsi langganan dikembalikan, karena ketika permintaan PUT tidak menentukan nilai untuk semua atribut langganan, beberapa properti deskripsi dapat berisi nilai default.