Модуль azure.azcollection.azure_rm_registrationdefinition_info — Получение информации о RegistrationDefinition
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_registrationdefinition_info.
Новинка в azure.azcollection 1.3.0
Обзор
- Получение информации о RegistrationDefinition.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, где выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть установлено через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Choices:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлено через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляра, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
registration_definition_id string | Идентификатор определения регистрации. |
scope string | Идентификатор подписки определяет подписку, в которой будет извлечено определение регистрации. Если не указано, будет использоваться подписка, полученная из AzureRMAuth. |
secret string | Секретный ключ Azure. Используется при аутентификации с помощью службы принципала. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов. |
tenant string | Идентификатор Azure-аренды. Используется при аутентификации с помощью службы принципала. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток цифрового сертификата закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы принципала. Требуется, если задан параметр x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания службы принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью службы принципала. |
Примечания
Примечание
- Для аутентификации в 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 Registration Definition
azure_rm_registrationdefinition_info:
registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- name: Get All Registration Definitions from AzureRMAuth's subscription
azure_rm_registrationdefinition_info:
- name: Get All Registration Definitions in the subscription levle
azure_rm_registrationdefinition_info:
scope: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
registration_definitions complex | Список результатов в формате dict, где ключ — имя RegistrationDefinition, а значения — факты для этого RegistrationDefinition. Возвращается: всегда |
|
id string |
Полностью квалифицированный путь определения регистрации. Возвращается: всегда |
|
name string |
Имя определения регистрации. Возвращается: всегда |
|
plan complex |
Подробная информация о плане для управляемых служб. Возвращается: всегда |
|
name string |
Название плана. Возвращается: всегда |
|
product string |
Код продукта. Возвращается: всегда |
|
publisher string |
Идентификатор издателя. Возвращается: всегда |
|
version string |
Версия плана. Возвращается: всегда |
|
properties complex |
Свойства определения регистрации. Возвращается: всегда |
|
authorizations complex |
Кортеж авторизации, содержащий идентификатор участника пользователя/группы безопасности или субъекта безопасности и идентификатор встроенной роли. Возвращается: всегда |
|
principal_id string |
Идентификатор участника группы безопасности/субъекта безопасности/пользователя, которому будут назначены разрешения на проектируемую подписку. Возвращается: всегда |
|
role_definition_id string |
Идентификатор определения роли. Роль будет определять все разрешения, которые группа безопасности/субъект безопасности/пользователь должны иметь в подписке. Роль не может быть ролью владельца. Возвращается: всегда |
|
description string |
Описание определения регистрации. Возвращается: всегда |
|
managed_by_tenant_id string |
Идентификатор управляющего арендатора. Возвращается: всегда |
|
registration_definition_name string |
Имя определения регистрации. Возвращается: всегда |
|
type string |
Тип ресурса. Возвращается: всегда |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_registrationdefinition_info_module.html