community.azure.azure_rm_roledefinition_info – Получение фактов о роли Azure

Примечание

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

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

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

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

Обзор

Получение фактов о роли Azure.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 0.0.1 of azure.azcollection		URL-адрес службы авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой авторизации ADFS.
api_profile строка добавлено в 0.0.1 of azure.azcollection	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят работать с Azure Stack.
auth_source строка добавлено в 0.0.1 of 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` могут быть использованы для определения идентификатора подписки, если их несколько, иначе используется стандартная подписка Azure CLI. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут быть использованы для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, иначе выбирается первая подписка. Параметр `msi` добавлен в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 of azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или с Azure Stack может потребоваться отключить эту функцию, передав `ignore`. Также может быть задан в файле профилей учетных данных или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 of azure.azcollection	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки доступа для обнаружения метаданных (требуется для Azure Stack). Также может быть задан в файле профилей учетных данных или переменной среды `AZURE_CLOUD_ENVIRONMENT`.
id строка		Идентификатор определения роли.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
role_name строка		Имя роли.
scope строка / обязательно		Область применения определения роли.
secret строка		Секрет клиента Azure. Используется при аутентификации с принципалом службы.
subscription_id строка		Идентификатор вашей подписки Azure.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы.
type строка	Варианты: system custom	Тип роли.

Примечания

Примечание

Для аутентификации с 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: List Role Definitions in scope
  community.azure.azure_rm_roledefinition_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup

- name: Get Role Definition by name
  community.azure.azure_rm_roledefinition_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup
    name: myRoleDefinition

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

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

Ключ			Возвращаемое значение	Описание
roledefinitions сложный			всегда	Список фактов о определениях ролей.
	assignable_scopes список / элементы=строка		всегда	Список допустимых областей применения для данного определения. Пример: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup']
	id строка		всегда	Идентификатор определения роли. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
	name строка		всегда	Имя роли, назначенной системой. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
	permissions строка		всегда	Список разрешений определения роли.
		actions список / элементы=строка	всегда	Список разрешенных действий. Пример: ['Microsoft.Compute/virtualMachines/read']
		data_actions список / элементы=строка	всегда	Список разрешенных действий с данными. Пример: ['Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read']
		not_actions список / элементы=строка	всегда	Список запрещенных действий. Пример: ['Microsoft.Compute/virtualMachines/write']
		not_data_actions список / элементы=строка	всегда	Список запрещенных действий с данными. Пример: ['Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write']
	role_name строка		всегда	Имя роли. Пример: myCustomRoleDefinition

Авторы

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.10/collections/community/azure/azure_rm_roledefinition_info_module.html