azure.azcollection.azure_rm_registrationassignment_info – Получение информации о RegistrationAssignment
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_registrationassignment_info.
Добавлено в версии 1.3.0: коллекции azure.azcollection
Обзор
- Получение информации о RegistrationAssignment.
Требования
Ниже перечислены требования, необходимые на хосте, выполняющем этот модуль.
- 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. |
| append_tags логическое значение |
| Управление способом использования тегов: канонический или добавление к существующим тегам. При каноническом методе теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. |
| auth_source строка добавлено в 0.0.1 коллекции azure.azcollection |
| Определяет источник учетных данных для аутентификации. Также может быть задан через переменную среды 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 |
| Управление проверкой сертификатов для 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. |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile строка | Профиль безопасности в файле ~/.azure/credentials. | |
| registration_assignment_id строка | Идентификатор назначенного уровня регистрации. | |
| scope строка / обязательно | Область действия назначенного уровня регистрации. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags словарь | Словарь пар строка:строка для задания метаданных объекту. Теги метаданных объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | |
| 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 Registration Assignment
azure_rm_registrationassignment_info:
registration_assignment_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
scope: subscription/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup
- name: Get All Registration Assignments in scope(subscription)
azure_rm_registrationassignment_info:
scope: subscription/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Значения возврата
Общие значения возврата описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| registration_assignments сложный | всегда | Список результатов словарей, где ключ — имя RegistrationAssignment. Значения — фактические данные для данного RegistrationAssignment. | ||
| id строка | всегда | Полный путь к назначенному уровню регистрации. Пример: /subscriptions/xxx-xxxf/providers/Microsoft.ManagedServices/registrationAssignments/xxx-xxx | ||
| name строка | всегда | Имя назначенного уровня регистрации. Пример: 9b2895ec-fb1e-4a1e-a978-abd9933d6b20 | ||
| properties сложный | всегда | Свойства назначенного уровня регистрации. | ||
| registration_definition_id строка | всегда | Полный путь к определению регистрации. Пример: /subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxx-xxx | ||
| type строка | всегда | Тип ресурса. Пример: Microsoft.ManagedServices/registrationAssignment | ||
Авторы
- Fred-Sun (@Fred-Sun)
© 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_registrationassignment_info_module.html