Spec-Zone.ru › Ansible 2.9

azure_rm_servicebus_info – Получение фактов о servicebus

Новая в версии 2.9.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Получение фактов для конкретного servicebus или всех servicebus в группе ресурсов или подписке.

Псевдонимы: azure_rm_servicebus_facts

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
adfs_authority_url
строка
добавлен в 2.6
URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS.
api_profile
строка
добавлен в 2.5
 По умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source
строка
добавлен в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию будет auto если переменная не определена.
auto будет следовать по умолчанию приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.
При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.
Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При установке в msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID можно использовать для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.
msi была добавлена в Ansible 2.6.
cert_validation_mode
строка
добавлен в 2.5
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификата для Azure-точек доступа. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
cloud_environment
строка
добавлен в 2.4
 По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки доступа к метаданным (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
name
-
Ограничить результаты конкретным servicebus.
namespace
-
Имя пространства servicebus.
Пространство имен — это контейнер для всех компонентов обмена сообщениями.
В одном пространстве имен могут находиться несколько очередей и тем, и пространства имен часто используются в качестве контейнеров приложений.
Требуется при type=namespace.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
-
Ограничить результаты определенной группой ресурсов.
secret
строка
Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала.
show_sas_policies
логический тип
    Варианты:
  • no
  • yes
Показывать ли политики SAS.
Не поддерживается при type=subscription.
Обратите внимание, если вы включите этот параметр, модуль фактов выполнит два дополнительных HTTP-запроса для каждого ресурса, что увеличит сетевую нагрузку.
subscription_id
строка
Идентификатор вашей подписки Azure.
tags
-
Ограничить результаты, указав список тегов. Формат тегов: 'ключ' или 'ключ:значение'.
tenant
строка
Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала.
topic
-
Имя темы.
Требуется при type=subscription.
type
-
    Варианты:
  • namespace
  • queue
  • topic
  • subscription
Тип ресурса.

Примечания

Примечание

  • Для аутентификации в Azure можно передавать параметры, задавать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или выполнить вход перед запуском задач или playbook с az login.
  • Аутентификация также возможна с помощью сервисного принципала или пользователя Active Directory.
  • Для аутентификации с помощью сервисного принципала необходимо передать subscription_id, client_id, secret и tenant или установить переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации с помощью пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Вход с помощью Azure CLI
Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Get all namespaces under a resource group
  azure_rm_servicebus_info:
    resource_group: myResourceGroup
    type: namespace

- name: Get all topics under a namespace
  azure_rm_servicebus_info:
    resource_group: myResourceGroup
    namespace: bar
    type: topic

- name: Get a single queue with SAS policies
  azure_rm_servicebus_info:
    resource_group: myResourceGroup
    namespace: bar
    type: queue
    name: sbqueue
    show_sas_policies: true

- name: Get all subscriptions under a resource group
  azure_rm_servicebus_info:
    resource_group: myResourceGroup
    type: subscription
    namespace: bar
    topic: sbtopic

Возвращаемые значения

Общие возвращаемые значения описаны в этом разделе, а следующие поля уникальны для данного модуля:

Ключ Возвращаемое значение Описание
servicebuses
complex
всегда
Список словарей servicebus.
accessed_at
строка
всегда
Последнее время отправки сообщения или получения запроса для этой темы.

Пример:
2019-01-25 02:46:55.543953+00:00
auto_delete_on_idle_in_seconds
целое число
всегда
Интервал простоя по ISO 8061, после которого очередь или тема автоматически удаляются.
Минимальная продолжительность составляет 5 минут.

Пример:
True
count_details
complex
всегда
Подробная информация о количестве сообщений.
active_message_count
целое число
всегда
Количество активных сообщений в queue, topic, или subscription.
dead_letter_message_count
целое число
всегда
Количество сообщений, которые были помечены как недействительные.
scheduled_message_count
целое число
всегда
Количество запланированных сообщений.
transfer_dead_letter_message_count
целое число
всегда
Количество сообщений, переданных в список недействительных сообщений.
transfer_message_count
целое число
всегда
Количество сообщений, переданных в другую queue, topic, или subscription.
created_at
строка
всегда
Точное время создания сообщения.

Пример:
2019-01-25 02:46:55.543953+00:00
dead_lettering_on_filter_evaluation_exceptions
целое число
всегда
Значение, указывающее, поддерживает ли подписка удаление сообщений при исключениях из оценки фильтра.
dead_lettering_on_message_expiration
целое число
всегда
Значение, указывающее, поддерживает ли эта queue или topic удаление сообщений при истечении срока действия сообщения.
default_message_time_to_live_seconds
целое число
всегда
Значение по умолчанию для интервала времени жизни сообщения по ISO 8061.
Это время, по истечении которого сообщение истекает, начиная с момента отправки сообщения в Service Bus.
Это значение по умолчанию используется, когда TimeToLive не задано для самого сообщения.
duplicate_detection_time_in_seconds
целое число
всегда
Структура ISO 8601 timeSpan, определяющая продолжительность истории обнаружения дубликатов.

Пример:
600
enable_batched_operations
логическое
всегда
Значение, указывающее, включены ли пакетные операции на серверной стороне.

Пример:
True
enable_express
логическое
всегда
Значение, указывающее, включены ли сущности Express.
Тема Express временно хранит сообщение в памяти перед записью в постоянное хранилище.

Пример:
True
enable_partitioning
логическое
всегда
Значение, указывающее, включена ли функция распределения queue или topic по нескольким брокерам сообщений.

Пример:
True
forward_dead_lettered_messages_to
строка
всегда
Имя queue или topic для переадресации сообщения Dead Letter.

Пример:
corge
forward_to
строка
всегда
Имя queue или topic для переадресации сообщений.

Пример:
quux
id
строка
всегда
Идентификатор ресурса.

Пример:
/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/foo/providers/Microsoft.ServiceBus/ namespaces/bar/topics/baz/subscriptions/qux
location
строка
всегда
Географическое расположение ресурса.

Пример:
eastus
lock_duration_in_seconds
целое число
всегда
Продолжительность блокировки peek-lock по ISO 8601.
Время, в течение которого сообщение заблокировано для других получателей.
Максимальное значение для LockDuration составляет 5 минут.

Пример:
60
max_delivery_count
целое число
всегда
Максимальное количество доставок.
Сообщение автоматически помещается в список недействительных после этого количества доставок.

Пример:
10
max_size_in_mb
целое число
всегда
Максимальный размер queue или topic в мегабайтах, который соответствует размеру выделенной памяти для topic.

Пример:
5120
message_count
целое число
всегда
Количество сообщений.

Пример:
10
metric_id
строка
всегда
Идентификатор метрик Azure Insights для пространства имен.

Пример:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:bar
name
строка
всегда
Имя ресурса.

Пример:
qux
имя_пространства_имён
строка
всегда
Имя пространства имен queue или topic, subscription.

Пример:
bar
состояние_подготовки
строка
всегда
Состояние подготовки пространства имен.

Пример:
Успешно
требуется_обнаружение_дубликатов
логическое
всегда
Значение, указывающее, требует ли это queue или topic обнаружения дубликатов.

Пример:
True
требуется_сессия
логическое
всегда
Значение, указывающее, поддерживает ли queue или topic понятие сессий.

Пример:
True
политики_sas
словарь
всегда
Словарь политик SAS.
Не будет возвращён до тех пор, пока не будет установлено значение show_sas_policy.

Пример:
{'testpolicy1': {'id': '/subscriptions/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/ foo/providers/Microsoft.ServiceBus/namespaces/bar/queues/qux/authorizationRules/testpolicy1', 'keys': {'key_name': 'testpolicy1', 'primary_connection_string': 'Endpoint=sb://bar.servicebus.windows.net/; SharedAccessKeyName=testpolicy1;SharedAccessKey=XXXXXXXXXXXXXXXXX;EntityPath=qux', 'primary_key': 'XXXXXXXXXXXXXXXXX', 'secondary_connection_string': 'Endpoint=sb://bar.servicebus.windows.net/; SharedAccessKeyName=testpolicy1;SharedAccessKey=XXXXXXXXXXXXXXX;EntityPath=qux', 'secondary_key': 'XXXXXXXXXXXXXXX'}, 'name': 'testpolicy1', 'rights': 'listen_send', 'type': 'Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules'}}
сервис_интерфейс_endpoint
строка
всегда
Интерфейс, который можно использовать для выполнения операций службы Service Bus.

Пример:
https://bar.servicebus.windows.net:443/
размер_в_байтах
целое
всегда
Размер queue или topic в байтах.
sku
строка
всегда
Свойства SKU пространства имен.

Пример:
Standard
статус
строка
всегда
Статус сообщения службы обмена сообщениями.

Пример:
active
количество_подписок
целое
всегда
Количество подписок в рамках темы.

Пример:
1
поддержка_упорядочивания
логическое
всегда
Значение, указывающее, поддерживает ли topic упорядочение.

Пример:
True
метки
словарь
всегда
Метки ресурса.

Пример:
{'env': 'sandbox'}
тема
строка
всегда
Имя темы подписки.

Пример:
baz
тип
строка
всегда
Тип ресурса.
Пространство имен — это контейнер для всех компонентов обмена сообщениями.
Очередь позволяет хранить сообщения до тех пор, пока приложение-получатель не будет готово их принять и обработать.
Тема и подписки позволяют установить отношения 1:n между издателями и подписчиками.

Пример:
Microsoft.ServiceBus/Namespaces/Topics
обновлено_в
строка
всегда
Точное время обновления сообщения.

Пример:
2019-01-25 02:46:55.543953+00:00


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Yuwei Zhou (@yuwzho)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_servicebus_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API