community.azure.azure_rm_servicebus_facts – Получение фактов о службе обмена сообщениями

Примечание

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

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

Для использования в книге задач укажите: community.azure.azure_rm_servicebus_facts.

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

Обзор

Получение фактов о конкретной службе обмена сообщениями или всех службах обмена сообщениями в группе ресурсов или подписке.

Требования

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

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` могут использоваться для определения идентификатора подписки, если их несколько, в противном случае используется по умолчанию подписка az 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 строка		Ограничить результаты конкретной службой обмена сообщениями.
namespace строка		Имя пространства службы обмена сообщениями. Пространство имен — это контейнер для всех компонентов обмена сообщениями. Несколько очередей и тем могут находиться в одном пространстве имен, и пространства имен часто служат контейнерами приложений. Требуется, когда 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, или войти в систему перед запуском задач или книги задач с помощью 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 сложный			всегда	Список словарей servicebus.
	accessed_at строка		всегда	Последнее время, когда сообщение было отправлено или запрос был получен для этой темы. Пример: 2019-01-25 02:46:55.543953+00:00
	auto_delete_on_idle_in_seconds целое число		всегда	Интервал простоя по времени ISO 8061, после которого очередь или тема автоматически удаляются. Минимальная продолжительность составляет 5 минут. Пример: True
	count_details сложный		всегда	Подробности о количестве сообщений.
		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, определяющая продолжительность истории обнаружения дубликатов. Пример: 600
	enable_batched_operations логическое		всегда	Значение, указывающее, включены ли пакетные операции на стороне сервера. Пример: True
	enable_express логическое		всегда	Значение, указывающее, включены ли сущности Express. Тема express временно хранит сообщение в памяти перед записью его в постоянное хранилище. Пример: True
	enable_partitioning логическое		всегда	Значение, указывающее, включена ли возможность разбиения `queue` или `topic` по нескольким брокерам сообщений. Пример: True
	forward_dead_lettered_messages_to строка		всегда	Имя `queue` или `topic` для переадресации сообщений из списка несохраненных. Пример: 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 целое число		всегда	Продолжительность блокировки по времени 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
	namespace строка		всегда	Имя пространства имен `queue` или `topic`, `subscription`. Пример: bar
	provisioning_state строка		всегда	Состояние подготовки пространства имен. Пример: Успешно
	requires_duplicate_detection логическое		всегда	Значение, указывающее, требуется ли обнаружение дубликатов для этого `queue` или `topic`. Пример: True
	requires_session логическое		всегда	Значение, указывающее, поддерживает ли `queue` или `topic` концепцию сеансов. Пример: True
	sas_policies словарь		всегда	Словарь политик 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 строка		всегда	Точка входа, которую можно использовать для выполнения операций Service Bus. Пример: https://bar.servicebus.windows.net:443/
	size_in_bytes целое число		всегда	Размер `queue` или `topic` в байтах.
	sku строка		всегда	Свойства SKU пространства имен. Пример: Стандартный
	status строка		всегда	Состояние сущности обмена сообщениями. Пример: активный
	subscription_count целое число		всегда	Количество подписок в рамках темы. Пример: 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_servicebus_facts_module.html