ServiceBusAdministrationClient Класс
Этот клиент используется для создания, обновления, перечисления и удаления ресурсов пространства имен ServiceBus.
- Наследование
-
builtins.objectServiceBusAdministrationClient
Конструктор
ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: AsyncTokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)
Параметры
- credential
- <xref:AsyncTokenCredential>
Проверка подлинности для управления сущностями пространства имен ServiceBus.
- api_version
- str или ApiVersion
Версия API служебной шины, используемая для запросов. Значение по умолчанию — последняя версия службы, совместимая с текущим пакетом SDK. Установка более старой версии может привести к снижению совместимости функций.
Методы
close | |
create_queue |
Создайте очередь. |
create_rule |
Создайте правило для подписки темы. |
create_subscription |
Создайте подписку раздела. |
create_topic |
Создайте раздел. |
delete_queue |
Удаление очереди. |
delete_rule |
Удаление правила подписки раздела. |
delete_subscription |
Удаление подписки раздела. |
delete_topic |
Удаление раздела. |
from_connection_string |
Создайте клиент из строки подключения. |
get_namespace_properties |
Получение свойств пространства имен |
get_queue |
Получение свойств очереди. |
get_queue_runtime_properties |
Получение сведений о среде выполнения очереди. |
get_rule |
Получение свойств правила подписки раздела. |
get_subscription |
Получение свойств подписки раздела. |
get_subscription_runtime_properties |
Получение сведений о среде выполнения подписки раздела. |
get_topic |
Получение свойств раздела. |
get_topic_runtime_properties |
Получение сведений о среде выполнения раздела. |
list_queues |
Вывод списка очередей пространства имен ServiceBus. |
list_queues_runtime_properties |
Вывод сведений о среде выполнения очередей в пространстве имен ServiceBus. |
list_rules |
Вывод списка правил подписки раздела. |
list_subscriptions |
Вывод списка подписок раздела ServiceBus. |
list_subscriptions_runtime_properties |
Вывод списка сведений о среде выполнения подписок служебной шины. |
list_topics |
Список разделов пространства имен ServiceBus. |
list_topics_runtime_properties |
Перечисление сведений о среде выполнения разделов пространства имен ServiceBus. |
update_queue |
Обновление очереди. Перед вызовом этого метода следует использовать get_queue, create_queue или list_queues , чтобы получить экземпляр QueueProperties , а затем обновить свойства. Обновить можно только часть свойств. См. https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. Можно также передать ключевое слово аргументы для обновления свойств в виде <property_name>=<property_value> который переопределит все, что было указано в экземпляре QueueProperties. Имена свойств см. в статье ~azure.servicebus.management.QueueProperties. |
update_rule |
Обновите правило. Перед вызовом этого метода следует использовать get_rule, create_rule или list_rules , чтобы получить экземпляр RuleProperties , а затем обновить свойства. Можно также передать ключевое слово аргументы для обновления свойств в виде <property_name>=<property_value> который переопределит все, что было указано в экземпляре RuleProperties. Имена свойств см. в разделе ~azure.servicebus.management.RuleProperties. |
update_subscription |
Обновление подписки. Перед вызовом этого метода следует использовать get_subscription, update_subscription или list_subscription , чтобы получить экземпляр SubscriptionProperties , а затем обновить свойства. Можно также передать ключевое слово аргументы для обновления свойств в виде <property_name>=<property_value> который переопределит все, что было указано в экземпляре SubscriptionProperties. Имена свойств см. в разделе ~azure.servicebus.management.SubscriptionProperties. |
update_topic |
Обновление раздела. Перед вызовом этого метода следует использовать get_topic, create_topic или list_topics , чтобы получить экземпляр TopicProperties , а затем обновить свойства. Обновить можно только часть свойств. См. https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. Можно также передать ключевое слово аргументы для обновления свойств в виде <property_name>=<property_value> который переопределит все, что было указано в экземпляре TopicProperties. Имена свойств см. в разделе ~azure.servicebus.management.TopicProperties. |
close
async close() -> None
create_queue
Создайте очередь.
async 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
Параметры
- authorization_rules
- list[AuthorizationRule]
Правила авторизации для ресурса.
Интервал времени бездействия iso 8601, по истечении которого очередь автоматически удаляется. Минимальная длительность составляет 5 минут. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
- dead_lettering_on_message_expiration
- bool
Значение типа , указывающее, поддерживает ли эта очередь недоставленные письма по истечении срока действия сообщения.
Время действия сообщения по умолчанию по стандарту ISO 8601 — динамическое значение. Это время, по истечении которого истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию используется, если TimeToLive не задано для самого сообщения. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
Iso 8601 timeSpan структура, которая определяет длительность журнала обнаружения дубликатов. Значение по умолчанию — 10 минут. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
- enable_batched_operations
- bool
Значение, указывающее, включены ли пакетные операции на стороне сервера.
- enable_express
- bool
Значение типа , указывающее, включены ли экспресс-сущности. Экспресс-очередь временно хранит сообщение в памяти, прежде чем записывать его в постоянное хранилище.
- enable_partitioning
- bool
Значение типа , указывающее, следует ли секционировать очередь между несколькими брокерами сообщений.
По стандарту ISO 8601— длительность блокировки при просмотре; то есть время, в течение которого сообщение блокируется для других получателей. Максимальное значение параметра LockDuration — 5 минут; Значение по умолчанию — 1 минута. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
- max_delivery_count
- int
Максимальное число доставок. Сообщение автоматически считается недоставленным после этого числа доставок. Значение по умолчанию — 10.
- max_size_in_megabytes
- int
Максимальный размер очереди в мегабайтах, то есть объем памяти, выделенной для очереди.
- requires_duplicate_detection
- bool
Значение, указывающее, требуется ли для этой очереди обнаружение дубликатов.
- requires_session
- bool
Значение типа , указывающее, поддерживает ли очередь концепцию сеансов.
- forward_to
- str
Имя сущности получателя, которой перенаправляются все сообщения, отправленные в очередь.
- user_metadata
- str
Пользовательские метданные, которые пользователь может связать с описанием. Максимальная длина составляет 1024 символа.
- forward_dead_lettered_messages_to
- str
Имя сущности получателя, в которую перенаправляются все недоставленные сообщения этой подписки.
- max_message_size_in_kilobytes
- int
Максимальный размер полезных данных сообщения в килобайтах, которые могут быть приняты очередью. Эта функция доступна только при использовании пространства имен Premium и API служебной шины версии 2021-05 или более поздней. Минимальное допустимое значение — 1024, а максимально допустимое — 102400. Значение по умолчанию — 1024.
Возвращаемый тип
create_rule
Создайте правило для подписки темы.
async 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
Параметры
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
Фильтр правила. Значение по умолчанию — ~azure.servicebus.management.TrueRuleFilter
- action
- Optional[SqlRuleAction]
Действие правила.
Возвращаемый тип
create_subscription
Создайте подписку раздела.
async 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
Параметры
По стандарту ISO 8601— длительность блокировки при просмотре; то есть время, в течение которого сообщение блокируется для других получателей. Максимальное значение параметра LockDuration — 5 минут; Значение по умолчанию — 1 минута. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
- requires_session
- bool
Значение типа , указывающее, поддерживает ли очередь концепцию сеансов.
Время действия сообщения по умолчанию по стандарту ISO 8601 — динамическое значение. Это время, по истечении которого истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию используется, если TimeToLive не задано для самого сообщения. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
- dead_lettering_on_message_expiration
- bool
Значение типа , указывающее, поддерживается ли в этой подписке поддержка недоставленных сообщений по истечении срока действия сообщения.
- dead_lettering_on_filter_evaluation_exceptions
- bool
Значение типа , указывающее, поддерживается ли в этой подписке поддержка недоставленных сообщений по истечении срока действия сообщения.
- max_delivery_count
- int
Максимальное число доставок. Сообщение автоматически считается недоставленным после этого числа доставок. Значение по умолчанию — 10.
- enable_batched_operations
- bool
Значение, указывающее, включены ли пакетные операции на стороне сервера.
- forward_to
- str
Имя сущности получателя, в которую перенаправляются все сообщения, отправленные в подписку.
- user_metadata
- str
Метаданные, связанные с подпиской. Максимальное количество знаков — 1024.
- forward_dead_lettered_messages_to
- str
Имя сущности получателя, в которую перенаправляются все сообщения, отправленные в подписку.
Интервал времени простоя по стандарту ISO 8601, по истечении которого подписка автоматически удаляется. Минимальная длительность составляет 5 минут. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
Возвращаемый тип
create_topic
Создайте раздел.
async 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
Параметры
Время действия сообщения по умолчанию по стандарту ISO 8601 — динамическое значение. Это время, по истечении которого истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию используется, если TimeToLive не задано для самого сообщения. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
- max_size_in_megabytes
- int
Максимальный размер раздела в мегабайтах, то есть объем памяти, выделенной для раздела.
- requires_duplicate_detection
- bool
Значение, указывающее, требуется ли для этого раздела обнаружение дубликатов.
Iso 8601 timeSpan структура, которая определяет длительность журнала обнаружения дубликатов. Значение по умолчанию — 10 минут. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
- enable_batched_operations
- bool
Значение, указывающее, включены ли пакетные операции на стороне сервера.
- size_in_bytes
- int
Размер раздела в байтах.
- filtering_messages_before_publishing
- bool
Фильтрация сообщений перед публикацией.
- authorization_rules
- list[AuthorizationRule]
Правила авторизации для ресурса.
- support_ordering
- bool
Значение типа , указывающее, поддерживает ли раздел упорядочение.
Интервал времени бездействия iso 8601, по истечении которого раздел автоматически удаляется. Минимальная длительность составляет 5 минут. Принимается входное значение типа ~datetime.timedelta или строки в формате длительности ISO 8601, например "PT300S".
- enable_partitioning
- bool
Значение типа , указывающее, следует ли секционировать раздел по нескольким брокерам сообщений.
- enable_express
- bool
Значение типа , указывающее, включены ли экспресс-сущности. Экспресс-очередь временно хранит сообщение в памяти, прежде чем записывать его в постоянное хранилище.
- user_metadata
- str
Метаданные, связанные с разделом.
- max_message_size_in_kilobytes
- int
Максимальный размер полезных данных сообщения в килобайтах, которые могут быть приняты очередью. Эта функция доступна только при использовании пространства имен Premium и API служебной шины версии 2021-05 или более поздней. Минимальное допустимое значение — 1024, а максимально допустимое — 102400. Значение по умолчанию — 1024.
Возвращаемый тип
delete_queue
Удаление очереди.
async delete_queue(queue_name: str, **kwargs: Any) -> None
Параметры
Возвращаемый тип
delete_rule
Удаление правила подписки раздела.
async delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None
Параметры
Возвращаемый тип
delete_subscription
Удаление подписки раздела.
async delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None
Параметры
Возвращаемый тип
delete_topic
Удаление раздела.
async delete_topic(topic_name: str, **kwargs: Any) -> None
Параметры
Возвращаемый тип
from_connection_string
Создайте клиент из строки подключения.
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient
Параметры
- api_version
- str или ApiVersion
Версия API служебной шины, используемая для запросов. Значение по умолчанию — последняя версия службы, совместимая с текущим пакетом SDK. Установка более старой версии может привести к снижению совместимости функций.
Возвращаемое значение
A ServiceBusAdministrationClient.
Возвращаемый тип
get_namespace_properties
Получение свойств пространства имен
async get_namespace_properties(**kwargs: Any) -> NamespaceProperties
Возвращаемое значение
Свойства пространства имен.
Возвращаемый тип
get_queue
Получение свойств очереди.
async get_queue(queue_name: str, **kwargs: Any) -> QueueProperties
Параметры
Возвращаемое значение
Свойства очереди.
Возвращаемый тип
get_queue_runtime_properties
Получение сведений о среде выполнения очереди.
async get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimeProperties
Параметры
Возвращаемое значение
Сведения о среде выполнения очереди.
Возвращаемый тип
get_rule
Получение свойств правила подписки раздела.
async get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties
Параметры
Возвращаемое значение
Свойства правила подписки раздела.
Возвращаемый тип
get_subscription
Получение свойств подписки раздела.
async get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties
Параметры
Возвращаемое значение
Экземпляр SubscriptionProperties.
Возвращаемый тип
get_subscription_runtime_properties
Получение сведений о среде выполнения подписки раздела.
async get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties
Параметры
Возвращаемое значение
Экземпляр SubscriptionRuntimeProperties.
Возвращаемый тип
get_topic
Получение свойств раздела.
async get_topic(topic_name: str, **kwargs: Any) -> TopicProperties
Параметры
Возвращаемое значение
Свойства раздела.
Возвращаемый тип
get_topic_runtime_properties
Получение сведений о среде выполнения раздела.
async get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimeProperties
Параметры
Возвращаемое значение
Сведения о среде выполнения раздела.
Возвращаемый тип
list_queues
Вывод списка очередей пространства имен ServiceBus.
list_queues(**kwargs: Any) -> AsyncItemPaged[QueueProperties]
Возвращаемое значение
Итерируемый (автоматический) ответ QueueProperties.
Возвращаемый тип
list_queues_runtime_properties
Вывод сведений о среде выполнения очередей в пространстве имен ServiceBus.
list_queues_runtime_properties(**kwargs: Any) -> AsyncItemPaged[QueueRuntimeProperties]
Возвращаемое значение
Итерируемый (автоматически разбиение по страницам) ответа QueueRuntimeProperties.
Возвращаемый тип
list_rules
Вывод списка правил подписки раздела.
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> AsyncItemPaged[RuleProperties]
Параметры
Возвращаемое значение
Итерируемый (автоматически разбиение по страницам) ответа RuleProperties.
Возвращаемый тип
list_subscriptions
Вывод списка подписок раздела ServiceBus.
list_subscriptions(topic_name: str, **kwargs: Any) -> AsyncItemPaged[SubscriptionProperties]
Параметры
Возвращаемое значение
Итерируемый (автоматический) ответ ПодпискиСвойства.
Возвращаемый тип
list_subscriptions_runtime_properties
Вывод списка сведений о среде выполнения подписок служебной шины.
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> AsyncItemPaged[SubscriptionRuntimeProperties]
Параметры
Возвращаемое значение
Итерируемый (автоматический) ответ subscriptionRuntimeProperties.
Возвращаемый тип
list_topics
Список разделов пространства имен ServiceBus.
list_topics(**kwargs: Any) -> AsyncItemPaged[TopicProperties]
Возвращаемое значение
Итерируемый (автоматический) ответ TopicProperties.
Возвращаемый тип
list_topics_runtime_properties
Перечисление сведений о среде выполнения разделов пространства имен ServiceBus.
list_topics_runtime_properties(**kwargs: Any) -> AsyncItemPaged[TopicRuntimeProperties]
Возвращаемое значение
Итерируемый (автоматический) ответ topicRuntimeProperties.
Возвращаемый тип
update_queue
Обновление очереди.
Перед вызовом этого метода следует использовать get_queue, create_queue или list_queues , чтобы получить экземпляр QueueProperties , а затем обновить свойства. Обновить можно только часть свойств. См. https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. Можно также передать ключевое слово аргументы для обновления свойств в виде <property_name>=<property_value> который переопределит все, что было указано в экземпляре QueueProperties. Имена свойств см. в статье ~azure.servicebus.management.QueueProperties.
async update_queue(queue: QueueProperties | Mapping[str, Any], **kwargs: Any) -> None
Параметры
- queue
- QueueProperties
Очередь, возвращаемая из get_queue, create_queue или list_queues с обновленными свойствами.
Возвращаемый тип
update_rule
Обновите правило.
Перед вызовом этого метода следует использовать get_rule, create_rule или list_rules , чтобы получить экземпляр RuleProperties , а затем обновить свойства. Можно также передать ключевое слово аргументы для обновления свойств в виде <property_name>=<property_value> который переопределит все, что было указано в экземпляре RuleProperties. Имена свойств см. в разделе ~azure.servicebus.management.RuleProperties.
async update_rule(topic_name: str, subscription_name: str, rule: RuleProperties | Mapping[str, Any], **kwargs: Any) -> None
Параметры
- rule
- RuleProperties
Правило, возвращаемое из get_rule, create_rule или list_rules с обновленными свойствами.
Возвращаемый тип
update_subscription
Обновление подписки.
Перед вызовом этого метода следует использовать get_subscription, update_subscription или list_subscription , чтобы получить экземпляр SubscriptionProperties , а затем обновить свойства. Можно также передать ключевое слово аргументы для обновления свойств в виде <property_name>=<property_value> который переопределит все, что было указано в экземпляре SubscriptionProperties. Имена свойств см. в разделе ~azure.servicebus.management.SubscriptionProperties.
async update_subscription(topic_name: str, subscription: SubscriptionProperties | Mapping[str, Any], **kwargs: Any) -> None
Параметры
- subscription
- SubscriptionProperties
Подписка, возвращаемая get_subscription, update_subscription или list_subscription с обновленными свойствами.
Возвращаемый тип
update_topic
Обновление раздела.
Перед вызовом этого метода следует использовать get_topic, create_topic или list_topics , чтобы получить экземпляр TopicProperties , а затем обновить свойства. Обновить можно только часть свойств. См. https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. Можно также передать ключевое слово аргументы для обновления свойств в виде <property_name>=<property_value> который переопределит все, что было указано в экземпляре TopicProperties. Имена свойств см. в разделе ~azure.servicebus.management.TopicProperties.
async update_topic(topic: TopicProperties | Mapping[str, Any], **kwargs: Any) -> None
Параметры
- topic
- TopicProperties
Раздел, возвращаемый из get_topic, create_topic или list_topics с обновленными свойствами.
Возвращаемый тип
Azure SDK for Python