модуль azure.azcollection.azure_rm_registrationdefinition — управление экземпляром Azure RegistrationDefinition
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_registrationdefinition.
Добавлено в azure.azcollection 1.3.0
Краткое описание
- Создание, обновление и удаление экземпляра Azure 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 добавлено в azure.azcollection 0.0.1 | URL-адрес центра сертификации Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр сертификации ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение По умолчанию: |
append_tags boolean | Позволяет указать, является ли поле tags каноническим или только дополняет существующие теги. Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав значение Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению в Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа предоставляет токен OIDC напрямую. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
plan dictionary | Сведения о плане для управляемых служб. |
|
name string / обязательный |
Имя плана. |
|
product string / обязательный |
Код продукта. |
|
publisher string / обязательный |
Идентификатор издателя. |
|
version string / обязательный |
Версия плана. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
properties dictionary | Свойства определения регистрации. |
|
authorizations list / элементы=dictionary / обязательный |
Кортеж авторизации, содержащий идентификатор субъекта-пользователя, группы безопасности или субъекта-службы и идентификатор встроенной роли. |
|
principal_id string / обязательный |
Идентификатор субъекта группы безопасности, субъекта-службы или пользователя, которому будут назначены разрешения для целевой подписки. |
|
role_definition_id string / обязательный |
Идентификатор определения роли. Эта роль определяет все разрешения, которые должны быть предоставлены группе безопасности, субъекту-службе или пользователю в целевой подписке. Эта роль не может быть ролью владельца. |
|
description string |
Описание определения регистрации. |
|
managed_by_tenant_id string / обязательный |
Идентификатор клиента managedBy. |
|
registration_definition_name string |
Имя определения регистрации. |
registration_definition_id string | Идентификатор определения регистрации. Если он не указан, для него будет создан UUID. |
scope string | Идентификатор подписки определяет подписку, в которой будет создано определение регистрации. Если значение не указано, будет использоваться подписка, определенная через AzureRMAuth. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
state string | Задает требуемое состояние RegistrationDefinition. Используйте Варианты:
|
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.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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: Create Registration Definition without scope
azure_rm_registrationdefinition:
registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
properties:
description: test
authorizations:
- principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
registration_definition_name: def4
- name: Create Registration Definition with scope
azure_rm_registrationdefinition:
scope: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
properties:
description: test
authorizations:
- principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
registration_definition_name: def5
- name: Delete Registration Definition
azure_rm_registrationdefinition:
registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
state complex | Сведения о состоянии назначения регистрации. Возвращается: всегда |
|
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_registrationdefinition_module.html