Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Для использования в playbook, укажите: community.azure.azure_rm_servicebus_info.

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

Краткое описание

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

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
adfs_authority_url
строка
добавлено в 0.0.1 azure.azcollection
URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При значении auto (по умолчанию) приоритет имеет: параметры модуля -> env -> credential_file -> cli.
При значении env, учетные данные будут считываться из переменных среды.
При значении credential_file, профиль будет считываться из ~/.azure/credentials.
При значении cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для указания идентификатора подписки, если их несколько; в противном случае используется стандартная подписка Azure CLI.
При значении msi, хост-машина должна быть Azure-ресурсом с включённой расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.
Ключ msi был добавлен в Ansible 2.6.
cert_validation_mode
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задано в файле профиля учетных данных или в переменной среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используйте при аутентификации с сервисным принципалом.
cloud_environment
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"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
  community.azure.azure_rm_servicebus_info:
    resource_group: myResourceGroup
    type: namespace

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

- name: Get a single queue with SAS policies
  community.azure.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
  community.azure.azure_rm_servicebus_info:
    resource_group: myResourceGroup
    type: subscription
    namespace: bar
    topic: sbtopic

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

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

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

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

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

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

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

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

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

Пример:
True
forward_dead_lettered_messages_to
string
всегда
Имя queue или topic, куда пересылаются сообщения «мертвые письма».

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

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

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

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

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

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

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

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

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

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

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

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

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

Пример:
True
sas_policies
dictionary
всегда
Словарь правил 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'}}
service_bus_endpoint
string
всегда
Точка входа, которую можно использовать для выполнения операций Service Bus.

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

Пример:
Стандартный
status
string
всегда
Статус сущности обмена сообщениями.

Пример:
активный
subscription_count
integer
всегда
Количество подписок в рамках темы.

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

Пример:
True
tags
dictionary
always
Теги ресурса.

Пример:
{'env': 'sandbox'}
topic
string
always
Имя темы подписки.

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

Пример:
Microsoft.ServiceBus/Namespaces/Topics
updated_at
string
always
Точное время обновления сообщения.

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


Авторы

  • Yuwei Zhou (@yuwzho)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_servicebus_info_module.html

Spec-Zone.ru

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