azure_rm_roledefinition_facts – Получение фактов о определениях ролей 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.
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`.
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
  azure_rm_roledefinition_facts:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup

- name: Get Role Definition by name
  azure_rm_roledefinition_facts:
    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

Состояние

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

Авторы

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.8/modules/azure_rm_roledefinition_facts_module.html