Модуль azure.azcollection.azure_rm_gallery — Управление экземпляром галереи общих образов Azure
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_gallery.
Новое в azure.azcollection 0.1.2
Обзор
- Создание, обновление и удаление экземпляра галереи общих образов Azure (SIG).
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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: |
description string | Описание этого ресурса общей галереи образов. Это свойство можно обновлять. |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел узла действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
location string | Расположение ресурса. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / required | Имя общей галереи образов. Допустимые имена состоят из менее чем 80 буквенно-цифровых символов, подчеркиваний и точек. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
профиль строка | Профиль безопасности, найденный в файле ~/.azure/credentials. |
группа_ресурсов строка / обязательно | Название группы ресурсов. |
секрет строка | Секрет Azure-клиента. Используется при аутентификации с помощью службы-принципала. |
состояние строка | Утвердить состояние галереи. Используйте Выборы:
|
идентификатор_подписки строка | Ваш идентификатор подписки Azure. |
теги словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использования пробелов в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах. |
арендатор строка | Идентификатор арендатора Azure. Используется при аутентификации с помощью службы-принципала. |
отпечаток строка добавлен в azure.azcollection 1.14.0 | Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы-принципала. Требуется, если определен x509_certificate_path. |
путь_к_сертификату_x509 путь добавлен в 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: Create or update a simple gallery.
azure_rm_gallery:
resource_group: myResourceGroup
name: myGallery1283
location: West US
description: This is the gallery description.
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
идентификатор строка | Идентификатор ресурса. Возвращается: всегда Пример: |
Авторы
- Zim Kalinowski (@zikalino)
Ссылки на коллекции
© 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_gallery_module.html