Spec-Zone.ru › Ansible 2.8

azure_rm_servicebus – Управление Azure Service Bus

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

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

Обзор

  • Создание, обновление или удаление пространств имен 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
логическое значение
    Варианты:
  • нет
  • да ←
Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам.
При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source
строка
добавлено в 2.5
    Варианты:
  • авто
  • кли
  • файл_с_удостоверениями
  • среда
  • 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
    Варианты:
  • игнорировать
  • валидировать
Управляет поведением проверки сертификатов для 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.
location
-
Расположение пространства имён.
name
- / обязательно
имя пространства имён servicebus
password
-
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
- / обязательно
имя группы ресурсов.
secret
строка
Секрет клиента Azure. Используется при аутентификации с принципалом службы.
sku
-
    Варианты:
  • standard ←
  • basic
  • premium
SKU пространства имён.
state
-
    Варианты:
  • absent
  • present ←
Утвердить состояние маршрута. Используйте 'present' для создания или обновления, и 'absent' для удаления.
subscription_id
строка
Ваш идентификатор подписки Azure.
tags
словарь
Словарь пар строка:строка, назначаемых в качестве метаданных объекту.
Метаданные теги объекта будут обновлены любыми предоставленными значениями.
Чтобы удалить теги, установите параметр append_tags в false.
tenant
строка
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации в 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_servicebus:
      name: deadbeef
      location: eastus

Возвращаемые значения

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

Ключ Возвращённое значение Описание
id
строка
успех
Текущее состояние очереди сообщений.



Статус

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

Spec-Zone.ru

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