Spec-Zone.ru › Ansible 2.10

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

Примечание

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

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

Для использования в плейбуке укажите: 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 azure.azcollection
URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS авторизации.
api_profile
строка
добавлен в версии 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
assignee
строка
Идентификатор объекта пользователя, группы или главного сервиса.
Взаимоисключающие с name и id.
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.
id
строка
Полный идентификатор назначения роли для поиска.
Если задано, role_definition_id и scope будут проигнорированы.
Взаимоисключающие с assignee и name.
name
строка
Имя назначения роли.
Требует, чтобы также было задано scope.
Взаимоисключающие с assignee и id.
password
строка
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным сервисом.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
role_definition_id
строка
Идентификатор ресурса определения роли.
scope
строка
Область для запроса назначений ролей.
Например, используйте /subscriptions/{идентификатор-подписки}/ для подписки.
/subscriptions/{идентификатор-подписки}/resourceGroups/{имя-группы-ресурсов} для группы ресурсов.
/subscriptions/{идентификатор-подписки}/resourceGroups/{имя-группы-ресурсов}/providers/{имя-провайдера-ресурсов}/{тип-ресурса}/{имя-ресурса} для ресурса.
По умолчанию возвращает все унаследованные назначения от родительских областей, см. strict_scope_match.
secret
строка
Секрет клиента Azure. Используется при аутентификации с помощью главного сервиса.
strict_scope_match
логическое значение
    Варианты:
  • нет ←
  • да
Если strict_scope_match равно True, назначения ролей будут возвращены только для точно заданной области.
Унаследованные назначения ролей будут исключены из результатов.
Параметр будет проигнорирован, если не задан scope.
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
  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
complex
всегда
Список назначений ролей.
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_roleassignment_info_module.html

Spec-Zone.ru

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