Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

Для использования в playbook, укажите: azure.azcollection.azure_rm_roleassignment_info.

Добавлено в версии 0.1.2: of azure.azcollection

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

Обзор

  • Получает факты о назначении 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.
assignee
строка
Идентификатор объекта пользователя, группы или службы-принципала.
Взаимоисключающее с name и id.
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 могут использоваться для идентификации идентификатора подписки, если их несколько, иначе используется по умолчанию az подписка 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
строка
FQID назначения роли для поиска.
Если задан, role_definition_id и scope будут проигнорированы.
Взаимоисключающее с assignee и name.
name
строка
Имя назначения роли.
Требует, чтобы также был задан scope.
Взаимоисключающее с assignee и id.
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} для ресурса.
По умолчанию возвращает все унаследованные назначения из родительских областей, см. strict_scope_match.
secret
строка
Секрет клиента Azure. Используется при аутентификации службой-принципалом.
strict_scope_match
булево
    Варианты:
  • нет ←
  • да
Если strict_scope_match равно True, назначения ролей будут возвращаться только для точно определенной области.
Унаследованные назначения ролей будут исключены из результатов.
Параметр будет проигнорирован, если не задан scope.
subscription_id
строка
Ваш идентификатор подписки Azure.
tenant
строка
Идентификатор клиента Azure. Используется при аутентификации службой-принципалом.

Примечания

Примечание

  • Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с 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
  azure_rm_roleassignment_info:
    assignee: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments for specific scope that matches specific role definition
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    role_definition_id: /subscriptions/xxx-sub-guid-xxx/providers/Microsoft.Authorization/roleDefinitions/xxx-role-guid-xxxx

- name: Get role assignments for specific scope with no inherited assignments
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    strict_scope_match: True

- name: Get role assignments by name
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    name: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments by id
  azure_rm_roleassignment_info:
    id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/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
principal_type
строка
всегда
Тип субъекта, которому назначена роль.

Пример:
ServicePrincipal
role_definition_id
строка
всегда
Идентификатор определения роли, назначенного principal_id.

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

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

Пример:
custom


Авторы

  • Yunge Zhu(@yungezz)
  • Paul Aiton(@paultaiton)

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

Spec-Zone.ru

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