azure.azcollection.azure_rm_registrationassignment_info – Получение информации о назначении регистрации
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в playbook укажите: azure.azcollection.azure_rm_registrationassignment_info.
Новое в версии 1.3.0: коллекции azure.azcollection
Обзор
- Получить информацию о назначении регистрации.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- 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 булево |
| Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. Если каноническое, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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–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_registrationassignment_info_module.html