ServiceBusAdministrationClient Kelas
Gunakan klien ini untuk membuat, memperbarui, mencantumkan, dan menghapus sumber daya namespace ServiceBus.
- Warisan
-
builtins.objectServiceBusAdministrationClient
Konstruktor
ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: TokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)
Parameter
- fully_qualified_namespace
- str
Nama host yang sepenuhnya memenuhi syarat untuk namespace Bus Layanan.
- credential
- <xref:TokenCredential>
Untuk mengautentikasi untuk mengelola entitas namespace ServiceBus.
- api_version
- str atau ApiVersion
Versi API Azure Service Bus yang akan digunakan untuk permintaan. Nilai default adalah versi layanan terbaru yang kompatibel dengan SDK saat ini. Pengaturan ke versi yang lebih lama dapat mengakibatkan berkurangnya kompatibilitas fitur.
Metode
close | |
create_queue |
Buat antrean. |
create_rule |
Membuat aturan untuk langganan topik. |
create_subscription |
Membuat langganan topik. |
create_topic |
Membuat topik. |
delete_queue |
Hapus antrean. |
delete_rule |
Menghapus aturan langganan topik. |
delete_subscription |
Menghapus langganan topik. |
delete_topic |
Menghapus topik. |
from_connection_string |
Buat klien dari string koneksi. |
get_namespace_properties |
Mendapatkan properti namespace layanan |
get_queue |
Mendapatkan properti antrean. |
get_queue_runtime_properties |
Dapatkan informasi runtime antrean. |
get_rule |
Mendapatkan properti aturan langganan topik. |
get_subscription |
Mendapatkan properti langganan topik. |
get_subscription_runtime_properties |
Dapatkan info runtime langganan topik. |
get_topic |
Mendapatkan properti topik. |
get_topic_runtime_properties |
Dapatkan informasi runtime topik. |
list_queues |
Mencantumkan antrean namespace ServiceBus. |
list_queues_runtime_properties |
Mencantumkan informasi runtime antrean di namespace ServiceBus. |
list_rules |
Mencantumkan aturan langganan topik. |
list_subscriptions |
Mencantumkan langganan Topik ServiceBus. |
list_subscriptions_runtime_properties |
Mencantumkan informasi runtime langganan topik ServiceBus. |
list_topics |
Mencantumkan topik namespace ServiceBus. |
list_topics_runtime_properties |
Mencantumkan informasi runtime topik namespace ServiceBus. |
update_queue |
Memperbarui antrean. Sebelum memanggil metode ini, Anda harus menggunakan get_queue, create_queue , atau list_queues untuk mendapatkan instans QueueProperties , lalu memperbarui properti. Hanya sebagian properti yang dapat diperbarui. Lihat https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. Anda juga dapat meneruskan argumen kata kunci untuk memperbarui properti dalam bentuk <property_name>=<property_value> yang akan menimpa apa pun yang ditentukan dalam instans QueueProperties . Lihat ~azure.servicebus.management.QueueProperties untuk nama properti. |
update_rule |
Memperbarui aturan. Sebelum memanggil metode ini, Anda harus menggunakan get_rule, create_rule , atau list_rules untuk mendapatkan instans RuleProperties , lalu memperbarui properti. Anda juga dapat meneruskan argumen kata kunci untuk memperbarui properti dalam bentuk <property_name>=<property_value> yang akan menimpa apa pun yang ditentukan dalam instans RuleProperties . Lihat ~azure.servicebus.management.RuleProperties untuk nama properti. |
update_subscription |
Memperbarui langganan. Sebelum memanggil metode ini, Anda harus menggunakan get_subscription, update_subscription , atau list_subscription untuk mendapatkan instans SubscriptionProperties , lalu memperbarui properti. Anda juga dapat meneruskan argumen kata kunci untuk memperbarui properti dalam bentuk <property_name>=<property_value> yang akan mengambil alih apa pun yang ditentukan dalam instans SubscriptionProperties . Lihat ~azure.servicebus.management.SubscriptionProperties untuk nama properti. |
update_topic |
Memperbarui topik. Sebelum memanggil metode ini, Anda harus menggunakan get_topic, create_topic , atau list_topics untuk mendapatkan instans TopicProperties , lalu memperbarui properti. Hanya sebagian properti yang dapat diperbarui. Lihat https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. Anda juga dapat meneruskan argumen kata kunci untuk memperbarui properti dalam bentuk <property_name>=<property_value> yang akan menimpa apa pun yang ditentukan dalam instans TopicProperties . Lihat ~azure.servicebus.management.TopicProperties untuk nama properti. |
close
close() -> None
create_queue
Buat antrean.
create_queue(queue_name: str, *, authorization_rules: List[AuthorizationRule] | None = None, auto_delete_on_idle: timedelta | str | None = None, dead_lettering_on_message_expiration: bool | None = None, default_message_time_to_live: timedelta | str | None = None, duplicate_detection_history_time_window: timedelta | str | None = None, enable_batched_operations: bool | None = None, enable_express: bool | None = None, enable_partitioning: bool | None = None, lock_duration: timedelta | str | None = None, max_delivery_count: int | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, requires_session: bool | None = None, forward_to: str | None = None, user_metadata: str | None = None, forward_dead_lettered_messages_to: str | None = None, max_message_size_in_kilobytes: int | None = None, **kwargs: Any) -> QueueProperties
Parameter
- authorization_rules
- list[AuthorizationRule]
Aturan otorisasi untuk sumber daya.
Interval diam rentang waktu ISO 8601 setelah antrean dihapus secara otomatis. Durasi minimum adalah 5 menit. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
- dead_lettering_on_message_expiration
- bool
Nilai yang menunjukkan apakah antrean ini memiliki dukungan surat mati saat pesan kedaluwarsa.
Rentang waktu pesan default ISO 8601 untuk nilai langsung. Ini adalah durasi setelah pesan kedaluwarsa, dimulai dari saat pesan dikirim ke Azure Service Bus. Ini adalah nilai default yang digunakan ketika TimeToLive tidak diatur pada pesan itu sendiri. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
Struktur rentang waktu ISO 8601 yang menentukan durasi riwayat deteksi duplikat. Nilai defaultnya adalah 10 menit. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
- enable_batched_operations
- bool
Nilai yang menunjukkan apakah operasi batch sisi server diaktifkan.
- enable_express
- bool
Nilai yang menunjukkan apakah Entitas Ekspres diaktifkan. Antrean ekspres menyimpan pesan dalam memori untuk sementara sebelum menulisnya ke penyimpanan persisten.
- enable_partitioning
- bool
Nilai yang menunjukkan apakah antrean akan dipartisi di beberapa broker pesan.
Durasi rentang waktu ISO 8601 dari kunci intip; artinya, jumlah waktu pesan dikunci untuk penerima lain. Nilai maksimum untuk LockDuration adalah 5 menit; nilai defaultnya adalah 1 menit. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
- max_delivery_count
- int
Jumlah pengiriman maksimum. Pesan secara otomatis mengalami deadletter setelah jumlah pengiriman ini. Nilai defaultnya adalah 10.
- max_size_in_megabytes
- int
Ukuran maksimum antrean dalam megabyte, yang merupakan ukuran memori yang dialokasikan untuk antrean.
- requires_duplicate_detection
- bool
Nilai yang menunjukkan apakah antrean ini memerlukan deteksi duplikat.
- requires_session
- bool
Nilai yang menunjukkan apakah antrean mendukung konsep sesi.
- forward_to
- str
Nama entitas penerima tempat semua pesan yang dikirim ke antrean diteruskan.
- user_metadata
- str
Metdata kustom yang dapat dikaitkan pengguna dengan deskripsi. Panjang maksimum adalah 1024 karakter.
- forward_dead_lettered_messages_to
- str
Nama entitas penerima tempat semua pesan surat gagal langganan ini diteruskan.
- max_message_size_in_kilobytes
- int
Ukuran maksimum dalam kilobyte payload pesan yang dapat diterima oleh antrean. Fitur ini hanya tersedia saat menggunakan namespace Premium dan Service Bus API versi "2021-05" atau lebih tinggi. Nilai minimum yang diizinkan adalah 1024 sedangkan nilai maksimum yang diizinkan adalah 102400. Nilai defaultnya adalah 1024.
Tipe hasil
create_rule
Membuat aturan untuk langganan topik.
create_rule(topic_name: str, subscription_name: str, rule_name: str, *, filter: ~azure.servicebus.management._models.CorrelationRuleFilter | ~azure.servicebus.management._models.SqlRuleFilter = <azure.servicebus.management._models.TrueRuleFilter object>, action: ~azure.servicebus.management._models.SqlRuleAction | None = None, **kwargs: ~typing.Any) -> RuleProperties
Parameter
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
Filter aturan. Nilai defaultnya adalah ~azure.servicebus.management.TrueRuleFilter
- action
- Optional[SqlRuleAction]
Tindakan aturan.
Tipe hasil
create_subscription
Membuat langganan topik.
create_subscription(topic_name: str, subscription_name: str, *, lock_duration: timedelta | str | None = None, requires_session: bool | None = None, default_message_time_to_live: timedelta | str | None = None, dead_lettering_on_message_expiration: bool | None = None, dead_lettering_on_filter_evaluation_exceptions: bool | None = None, max_delivery_count: int | None = None, enable_batched_operations: bool | None = None, forward_to: str | None = None, user_metadata: str | None = None, forward_dead_lettered_messages_to: str | None = None, auto_delete_on_idle: timedelta | str | None = None, **kwargs: Any) -> SubscriptionProperties
Parameter
Durasi rentang waktu ISO 8601 dari kunci intip; artinya, jumlah waktu pesan dikunci untuk penerima lain. Nilai maksimum untuk LockDuration adalah 5 menit; nilai defaultnya adalah 1 menit. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
- requires_session
- bool
Nilai yang menunjukkan apakah antrean mendukung konsep sesi.
Rentang waktu pesan default ISO 8601 untuk nilai langsung. Ini adalah durasi setelah pesan kedaluwarsa, dimulai dari saat pesan dikirim ke Azure Service Bus. Ini adalah nilai default yang digunakan ketika TimeToLive tidak diatur pada pesan itu sendiri. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
- dead_lettering_on_message_expiration
- bool
Nilai yang menunjukkan apakah langganan ini memiliki dukungan surat gagal saat pesan kedaluwarsa.
- dead_lettering_on_filter_evaluation_exceptions
- bool
Nilai yang menunjukkan apakah langganan ini memiliki dukungan surat gagal saat pesan kedaluwarsa.
- max_delivery_count
- int
Jumlah pengiriman maksimum. Pesan secara otomatis mengalami deadletter setelah jumlah pengiriman ini. Nilai defaultnya adalah 10.
- enable_batched_operations
- bool
Nilai yang menunjukkan apakah operasi batch sisi server diaktifkan.
- forward_to
- str
Nama entitas penerima tempat semua pesan yang dikirim ke langganan diteruskan.
- user_metadata
- str
Metadata yang terkait dengan langganan. Jumlah karakter maksimum adalah 1024.
- forward_dead_lettered_messages_to
- str
Nama entitas penerima tempat semua pesan yang dikirim ke langganan diteruskan.
Interval diam rentang waktu ISO 8601 setelah langganan dihapus secara otomatis. Durasi minimum adalah 5 menit. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
Tipe hasil
create_topic
Membuat topik.
create_topic(topic_name: str, *, default_message_time_to_live: timedelta | str | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, duplicate_detection_history_time_window: timedelta | str | None = None, enable_batched_operations: bool | None = None, size_in_bytes: int | None = None, filtering_messages_before_publishing: bool | None = None, authorization_rules: List[AuthorizationRule] | None = None, support_ordering: bool | None = None, auto_delete_on_idle: timedelta | str | None = None, enable_partitioning: bool | None = None, enable_express: bool | None = None, user_metadata: str | None = None, max_message_size_in_kilobytes: int | None = None, **kwargs: Any) -> TopicProperties
Parameter
Rentang waktu pesan default ISO 8601 untuk nilai langsung. Ini adalah durasi setelah pesan kedaluwarsa, dimulai dari saat pesan dikirim ke Azure Service Bus. Ini adalah nilai default yang digunakan ketika TimeToLive tidak diatur pada pesan itu sendiri. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
- max_size_in_megabytes
- int
Ukuran maksimum topik dalam megabyte, yang merupakan ukuran memori yang dialokasikan untuk topik tersebut.
- requires_duplicate_detection
- bool
Nilai yang menunjukkan apakah topik ini memerlukan deteksi duplikat.
Struktur rentang waktu ISO 8601 yang menentukan durasi riwayat deteksi duplikat. Nilai defaultnya adalah 10 menit. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
- enable_batched_operations
- bool
Nilai yang menunjukkan apakah operasi batch sisi server diaktifkan.
- size_in_bytes
- int
Ukuran topik, dalam byte.
- filtering_messages_before_publishing
- bool
Memfilter pesan sebelum menerbitkan.
- authorization_rules
- list[AuthorizationRule]
Aturan otorisasi untuk sumber daya.
- support_ordering
- bool
Nilai yang menunjukkan apakah topik mendukung pengurutan.
Interval idle rentang waktu ISO 8601 setelah topik dihapus secara otomatis. Durasi minimum adalah 5 menit. Nilai input jenis ~datetime.timedelta atau string dalam format durasi ISO 8601 seperti "PT300S" diterima.
- enable_partitioning
- bool
Nilai yang menunjukkan apakah topik tersebut akan dipartisi di beberapa broker pesan.
- enable_express
- bool
Nilai yang menunjukkan apakah Entitas Ekspres diaktifkan. Antrean ekspres menyimpan pesan dalam memori untuk sementara sebelum menulisnya ke penyimpanan persisten.
- user_metadata
- str
Metadata yang terkait dengan topik.
- max_message_size_in_kilobytes
- int
Ukuran maksimum dalam kilobyte payload pesan yang dapat diterima oleh antrean. Fitur ini hanya tersedia saat menggunakan namespace Premium dan Service Bus API versi "2021-05" atau lebih tinggi. Nilai minimum yang diizinkan adalah 1024 sedangkan nilai maksimum yang diizinkan adalah 102400. Nilai defaultnya adalah 1024.
Tipe hasil
delete_queue
Hapus antrean.
delete_queue(queue_name: str, **kwargs: Any) -> None
Parameter
Tipe hasil
delete_rule
Menghapus aturan langganan topik.
delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None
Parameter
Tipe hasil
delete_subscription
Menghapus langganan topik.
delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None
Parameter
Tipe hasil
delete_topic
Menghapus topik.
delete_topic(topic_name: str, **kwargs: Any) -> None
Parameter
Tipe hasil
from_connection_string
Buat klien dari string koneksi.
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient
Parameter
- api_version
- str atau ApiVersion
Versi SERVICE Bus API yang akan digunakan untuk permintaan. Nilai default adalah versi layanan terbaru yang kompatibel dengan SDK saat ini. Pengaturan ke versi yang lebih lama dapat mengakibatkan kompatibilitas fitur yang berkurang.
Tipe hasil
get_namespace_properties
Mendapatkan properti namespace layanan
get_namespace_properties(**kwargs: Any) -> NamespaceProperties
Mengembalikan
Properti namespace.
Tipe hasil
get_queue
Mendapatkan properti antrean.
get_queue(queue_name: str, **kwargs: Any) -> QueueProperties
Parameter
Mengembalikan
Properti antrean.
Tipe hasil
get_queue_runtime_properties
Dapatkan informasi runtime antrean.
get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimeProperties
Parameter
Mengembalikan
Informasi runtime antrean.
Tipe hasil
get_rule
Mendapatkan properti aturan langganan topik.
get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties
Parameter
Mengembalikan
Properti aturan yang ditentukan.
Tipe hasil
get_subscription
Mendapatkan properti langganan topik.
get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties
Parameter
Mengembalikan
Instans SubscriptionProperties
Tipe hasil
get_subscription_runtime_properties
Dapatkan info runtime langganan topik.
get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties
Parameter
Mengembalikan
Instans SubscriptionRuntimeProperties
Tipe hasil
get_topic
Mendapatkan properti topik.
get_topic(topic_name: str, **kwargs: Any) -> TopicProperties
Parameter
Mengembalikan
Properti topik.
Tipe hasil
get_topic_runtime_properties
Dapatkan informasi runtime topik.
get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimeProperties
Parameter
Mengembalikan
Info runtime topik.
Tipe hasil
list_queues
Mencantumkan antrean namespace ServiceBus.
list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]
Mengembalikan
Respons QueueProperties yang dapat diulang (halaman otomatis).
Tipe hasil
list_queues_runtime_properties
Mencantumkan informasi runtime antrean di namespace ServiceBus.
list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]
Mengembalikan
Respons QueueRuntimeProperties yang dapat diulang (auto-paging).
Tipe hasil
list_rules
Mencantumkan aturan langganan topik.
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]
Parameter
Mengembalikan
Respons ruleProperties yang dapat diulang (auto-paging).
Tipe hasil
list_subscriptions
Mencantumkan langganan Topik ServiceBus.
list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]
Parameter
Mengembalikan
Respons subscriptionProperties yang dapat diulang (auto-paging).
Tipe hasil
list_subscriptions_runtime_properties
Mencantumkan informasi runtime langganan topik ServiceBus.
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]
Parameter
Mengembalikan
Respons subscriptionRuntimeProperties yang dapat diulang (halaman otomatis).
Tipe hasil
list_topics
Mencantumkan topik namespace ServiceBus.
list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]
Mengembalikan
Respons TopicProperties yang dapat diulang (halaman otomatis).
Tipe hasil
list_topics_runtime_properties
Mencantumkan informasi runtime topik namespace ServiceBus.
list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]
Mengembalikan
Respons topicRuntimeProperties yang dapat diulang (auto-paging).
Tipe hasil
update_queue
Memperbarui antrean.
Sebelum memanggil metode ini, Anda harus menggunakan get_queue, create_queue , atau list_queues untuk mendapatkan instans QueueProperties , lalu memperbarui properti. Hanya sebagian properti yang dapat diperbarui. Lihat https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. Anda juga dapat meneruskan argumen kata kunci untuk memperbarui properti dalam bentuk <property_name>=<property_value> yang akan menimpa apa pun yang ditentukan dalam instans QueueProperties . Lihat ~azure.servicebus.management.QueueProperties untuk nama properti.
update_queue(queue: QueueProperties | Mapping[str, Any], **kwargs: Any) -> None
Parameter
- queue
- QueueProperties
Antrean yang dikembalikan dari get_queue, create_queue , atau list_queues dan memiliki properti yang diperbarui.
Tipe hasil
update_rule
Memperbarui aturan.
Sebelum memanggil metode ini, Anda harus menggunakan get_rule, create_rule , atau list_rules untuk mendapatkan instans RuleProperties , lalu memperbarui properti. Anda juga dapat meneruskan argumen kata kunci untuk memperbarui properti dalam bentuk <property_name>=<property_value> yang akan menimpa apa pun yang ditentukan dalam instans RuleProperties . Lihat ~azure.servicebus.management.RuleProperties untuk nama properti.
update_rule(topic_name: str, subscription_name: str, rule: RuleProperties | Mapping[str, Any], **kwargs: Any) -> None
Parameter
- rule
- RuleProperties
Aturan yang dikembalikan dari get_rule, create_rule, atau list_rules dan memiliki properti yang diperbarui.
Tipe hasil
update_subscription
Memperbarui langganan.
Sebelum memanggil metode ini, Anda harus menggunakan get_subscription, update_subscription , atau list_subscription untuk mendapatkan instans SubscriptionProperties , lalu memperbarui properti. Anda juga dapat meneruskan argumen kata kunci untuk memperbarui properti dalam bentuk <property_name>=<property_value> yang akan mengambil alih apa pun yang ditentukan dalam instans SubscriptionProperties . Lihat ~azure.servicebus.management.SubscriptionProperties untuk nama properti.
update_subscription(topic_name: str, subscription: SubscriptionProperties | Mapping[str, Any], **kwargs: Any) -> None
Parameter
- subscription
- SubscriptionProperties
Langganan yang dikembalikan dari get_subscription, update_subscription , atau list_subscription dan memiliki properti yang diperbarui.
Tipe hasil
update_topic
Memperbarui topik.
Sebelum memanggil metode ini, Anda harus menggunakan get_topic, create_topic , atau list_topics untuk mendapatkan instans TopicProperties , lalu memperbarui properti. Hanya sebagian properti yang dapat diperbarui. Lihat https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. Anda juga dapat meneruskan argumen kata kunci untuk memperbarui properti dalam bentuk <property_name>=<property_value> yang akan menimpa apa pun yang ditentukan dalam instans TopicProperties . Lihat ~azure.servicebus.management.TopicProperties untuk nama properti.
update_topic(topic: TopicProperties | Mapping[str, Any], **kwargs: Any) -> None
Parameter
- topic
- TopicProperties
Topik yang dikembalikan dari get_topic, create_topic, atau list_topics dan memiliki properti yang diperbarui.
Tipe hasil
Azure SDK for Python
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk