azure.azcollection.azure_rm_roledefinition – Управление определением роли Azure

Примечание

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

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

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

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

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

Описание

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

Требования

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

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.
assignable_scopes строка			Список назначаемых областей действия этого определения.
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`.
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 string		Профиль безопасности, найденный в файле ~/.azure/credentials.
scope string		Область определения роли.
secret string		Секретный ключ Azure-клиента. Используется при аутентификации с помощью сервисного принципала.
state string	Варианты: absent present ←	Утверждение состояния определения роли. Используйте `present` для создания или обновления определения роли; используйте `absent` для его удаления.
subscription_id string		Ваш идентификатор подписки Azure.
tenant string		Идентификатор 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 string	всегда	Идентификатор текущего определения роли. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId

Авторы

Yunge Zhu(@yungezz)

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