Spec-Zone.ru › Ansible 2.8

azure_rm_servicebus_facts – Получение фактов о службе servicebus

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

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

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

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

Требования

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

  • 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, или выполнить вход перед запуском задач или пьесы с 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_facts:
    resource_group: myResourceGroup
    type: namespace

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

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

- name: Get all subscriptions under a resource group
  azure_rm_servicebus_facts:
    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
целое число
Количество активных сообщений в очереди, теме или подписке.
dead_letter_message_count
целое число
Количество сообщений, которые являются письмами с мертвой почтой.
scheduled_message_count
целое число
Количество запланированных сообщений.
transfer_dead_letter_message_count
целое число
Количество сообщений, переданных в письма с мертвой почтой.
transfer_message_count
целое число
Количество сообщений, переданных в другую очередь, тему или подписку.
created_at
строка
Точное время создания сообщения.

Пример:
2019-01-25 02:46:55.543953+00:00
dead_lettering_on_filter_evaluation_exceptions
целое число
Значение, которое указывает, поддерживает ли подписка письма с мертвой почтой при исключениях оценки фильтра.
dead_lettering_on_message_expiration
целое число
Значение, которое указывает, поддерживает ли эта очередь или тема письма с мертвой почтой, когда сообщение истекает.
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
логическое значение
Значение, которое указывает, включено ли разделение очереди или темы по нескольким брокерам сообщений.

Пример:
True
forward_dead_lettered_messages_to
строка
Имя очереди или темы для перенаправления сообщения с мертвой почтой.

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

Пример:
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
целое число
Максимальный размер очереди или темы в мегабайтах, который представляет собой размер выделенной памяти для темы.

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

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

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

Пример:
qux
namespace
строка
Имя пространства имен очереди или темы, подписки.

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

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

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

Пример:
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
целое число
Размер очереди или темы в байтах.
sku
строка
Свойства SKU пространства имен.

Пример:
Standard
status
строка
Состояние сообщения сущности.

Пример:
active
subscription_count
целое число
Количество подписок в теме.

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

Пример:
True
tags
строка
Теги ресурса.

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

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

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

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


Состояние

  • Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
  • Этот модуль поддерживается сообществом 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.8/modules/azure_rm_servicebus_facts_module.html

Spec-Zone.ru

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