azure_rm_servicebussaspolicy – Управление политикой SAS Azure Service Bus

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

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

Обзор

Создание, обновление или удаление политики SAS Azure Service Bus.

Требования

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

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.
append_tags логическое значение	Варианты: no да ←	Управляет тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
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 - / обязательно		Имя политики SAS.
namespace - / обязательно		Управление политикой SAS для пространства имен без установки `queue` или `topic`. Управление политикой SAS для очереди или темы в этом пространстве имен.
password строка		Пароль пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не службой-принципалом.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
queue -		Тип очереди сообщений. Нельзя установить `topc` при установке этого поля.
regenerate_primary_key логическое значение	Варианты: нет ← да	Перегенерировать первичный ключ политики SAS.
regenerate_secondary_key логическое значение	Варианты: нет ← да	Перегенерировать вторичный ключ политики SAS.
resource_group - / обязательно		Имя группы ресурсов.
rights - / обязательно	Варианты: manage listen send listen_send	Права требования политики SAS.
secret строка		Секретный ключ клиента Azure. Используется при аутентификации службой-принципалом.
state -	Варианты: absent present ←	Утверждает состояние маршрута. Используйте `present` для создания или обновления и `absent` для удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации службой-принципалом.
topic -		Имя темы сообщений. Нельзя установить `queue` при установке этого поля.

Примечания

Примечание

Для аутентификации с 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: Create a namespace
  azure_rm_servicebussaspolicy:
      name: deadbeef
      queue: qux
      namespace: bar
      resource_group: myResourceGroup
      rights: send

Значения возврата

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

Ключ		Возвращённое значение	Описание
id строка		Успешно	Текущее состояние политики SAS. Пример: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/authorizationRules/testpolicy
keys сложный		Успешно	Словарь ключей политики SAS.
	key_name строка	Успешно	Имя политики SAS. Пример: testpolicy
	primary_connection_string строка	Успешно	Первичная строка подключения. Пример: Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=r+HD3es/9aOOq0XjQtkx5KXROH1MIHDs0WxCgR23gMc=;EntityPath=topicb57dc95979
	primary_key строка	Успешно	Первичный ключ. Пример: r+HD3es/9aOOq0XjQtkx5KXROH1MIHDs0WxCgR23gMc=
	secondary_connection_string строка	Успешно	Вторичная строка подключения. Пример: Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=/EcGztJBv72VD0Dy14bdsxi30rl+pSZMtKcs4KV3JWU=;EntityPath=topicb57dc95979
	secondary_key строка	Успешно	Вторичный ключ. Пример: /EcGztJBv72VD0Dy14bdsxi30rl+pSZMtKcs4KV3JWU=
name строка		Успешно	Имя политики SAS. Пример: testpolicy
rights строка		Успешно	Права политики SAS. Пример: manage
type строка		Успешно	Тип политики SAS. Пример: Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules

Статус

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

Авторы

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_servicebussaspolicy_module.html