azure_rm_roledefinition – Управление ролью Azure

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

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

Обзор

Создание, обновление и удаление экземпляра роли Azure.

Требования

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

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.
assignable_scopes -			Список назначенных областей действия этого определения.
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`.
description -			Описание определения роли.
name - / обязательно			Уникальное имя определения роли.
password строка			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
permissions -			Набор разрешений определения роли. Дополнительную информацию см. в https://docs.microsoft.com/ru-ru/azure/app-service/app-service-web-overview.
	actions список		Список разрешенных действий.
	data_actions список		Список разрешенных действий с данными.
	not_actions список		Список запрещенных действий.
	not_data_actions список		Список запрещенных действий с данными.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
scope -			Область действия определения роли.
secret строка			Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы.
state -		Варианты: absent present ←	Утверждение состояния определения роли. Используйте `present` для создания или обновления определения роли; используйте `absent` для его удаления.
subscription_id строка			Идентификатор вашей подписки Azure.
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 role definition
  azure_rm_roledefinition:
    name: myTestRole
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourceGroup
    permissions:
        - actions:
            - "Microsoft.Compute/virtualMachines/read"
          data_actions:
            - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write"
    assignable_scopes:
        - "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

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

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

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор текущего определения роли. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId

Статус

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

Авторы

Yunge Zhu(@yungezz)

Подсказка

Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

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