Spec-Zone.ru › Ansible 2.10

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

Примечание

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

Для его установки используйте: 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
логическое
    Варианты:
  • no
  • yes ←
Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.
При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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
логическое
    Варианты:
  • no ←
  • yes
Перегенерировать первичный ключ политики SAS.
regenerate_secondary_key
логическое
    Варианты:
  • no ←
  • yes
Перегенерировать вторичный ключ политики 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


Авторы

  • Ювей Чжоу (@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/azure/azcollection/azure_rm_servicebussaspolicy_module.html

Spec-Zone.ru

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