azure.azcollection.azure_rm_adserviceprincipal – Управление службой-принципалом Azure Active Directory

Примечание

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_adserviceprincipal.

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

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

Описание

Управление службой-принципалом Azure Active Directory.

Требования

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

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.
app_id строка / обязательно		Идентификатор приложения.
app_role_assignment_required булево	Варианты: no yes	Требуется ли назначение роли службы-принципала.
append_tags булево	Варианты: no yes ←	Управление поведением поля тегов: каноническое или добавление к существующим тегам. При каноническом режиме любые теги, отсутствующие в параметре 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` может использоваться для идентификации ID подписки, если их несколько, в противном случае используется стандартная подписка Azure CLI. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации 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`.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала.
state строка	Варианты: absent present ←	Утверждение состояния службы-принципала Active Directory. Используйте `present` для создания или обновления пароля и `absent` для удаления.
subscription_id строка		Идентификатор вашей подписки Azure.
tags словарь		Словарь пар "ключ: значение" типа строка:строка, назначаемый в качестве метаданных объекту. Метаданные теги объекта будут обновлены предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant строка / обязательно		Идентификатор клиента.

Примечания

Примечание

Для аутентификации с 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. Также возможно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход с помощью Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: create ad sp
  azure_ad_serviceprincipal:
    app_id: "{{ app_id }}"
    state: present
    tenant: "{{ tenant_id }}"

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

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

Ключ	Возвращаемое значение	Описание
app_display_name строка	всегда	Имя отображения объекта или его префикс. Пример: fredAKSCluster
app_id строка	всегда	Идентификатор приложения. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
app_role_assignment_required булево	всегда	Требуется ли назначение роли службы-принципала.
object_id строка	всегда	Идентификатор объекта связанной службы-принципала. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Авторы

haiyuan_zhang (@haiyuazhang) Fred-sun (@Fred-sun)

© 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_adserviceprincipal_module.html