Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_servicebussaspolicy.

Новое в версии 0.1.2: из azure.azcollection

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

Описание

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

Требования

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

  • 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.
append_tags
логическое
    Варианты:
  • нет
  • да ←
Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам.
При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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
строка / обязательно
Имя политики 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=xxxxxxxxxxxxxxxxxxxxxxxxxxxx
primary_key
строка
Успешно
Первичный ключ.

Пример:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
secondary_connection_string
строка
Успешно
Вторичная строка подключения.

Пример:
Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=xxxxxxxxxxxxxxxxxxxxxxxxx
secondary_key
строка
Успешно
Вторичный ключ.

Пример:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
name
строка
Успешно
Имя политики SAS.

Пример:
testpolicy
rights
строка
Успешно
Права политики SAS.

Пример:
manage
type
строка
Успешно
Тип политики SAS.

Пример:
Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules


Авторы

  • 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/azure/azcollection/azure_rm_servicebussaspolicy_module.html

Spec-Zone.ru

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