Spec-Zone.ru › Ansible 2.8

azure_rm_roleassignment_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.
assignee
-
Идентификатор объекта пользователя, группы или принципала службы.
Взаимоисключающее с name.
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.
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
  azure_rm_roleassignment_facts:
    assignee: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments for specific scope
  azure_rm_roleassignment_facts:
    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


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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_roleassignment_facts_module.html

Spec-Zone.ru

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