Spec-Zone.ru › Ansible 2.10

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

Примечание

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

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

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

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

Описание

  • Получает данные о назначении ролей 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.
assignee
строка
Идентификатор объекта пользователя, группы или принципала службы.
Взаимоисключающее с параметром name.
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.
name
строка
Имя назначения роли.
Взаимоисключающее с параметром assignee.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
role_definition_id
строка
Идентификатор ресурса определения роли.
scope
строка
Область действия назначения роли.
Например, для подписки используйте /subscriptions/{subscription-id}/.
/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name} для группы ресурсов.
/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name}/providers/{resource-provider}/{resource-type}/{resource-name} для ресурса.
secret
строка
Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы.
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: Get role assignments for specific service principal
  community.azure.azure_rm_roleassignment_info:
    assignee: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments for specific scope
  community.azure.azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

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

Ключ Возвращаемое значение Описание
roleassignments
сложная структура
всегда
Список назначений ролей.
id
строка
всегда
Идентификатор назначения роли.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
name
строка
всегда
Имя назначения роли.

Пример:
myRoleAssignment
principal_id
строка
всегда
Идентификатор принципала, которому назначена роль.

Пример:
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
role_definition_id
строка
всегда
Идентификатор определения роли, которое было назначено principal_id.

Пример:
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
scope
строка
всегда
Область действия назначения роли.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
type
строка
всегда
Тип назначения роли.

Пример:
custom


Авторы

  • 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_roleassignment_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API