Модуль azure.azcollection.azure_rm_galleryimage – Управление экземпляром изображения Azure SIG
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_galleryimage.
Новая функция в 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:
|
architecture string | Это свойство позволяет указать аппаратную архитектуру виртуальных машин. Arm64 поддерживается только с Hyper V версии 2. 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:
|
disallowed dictionary | Недопустимые значения параметров. |
|
disk_types list / elements=string |
Список недопустимых типов дисков. |
end_of_life_date string | Дата окончания срока службы определения образа галереи. Это свойство можно использовать для целей вывода из эксплуатации. Это свойство можно обновлять. Формат должен соответствовать ISO-8601, например «2019-06-26». |
eula string | Соглашение EULA для определения галереи изображений. |
features list / elements=dictionary | Список функций изображения галереи. |
|
name string / обязательно |
Имя функции изображения галереи. |
|
value string / обязательно |
Значение функции изображения галереи. |
gallery_name string / обязательно | Имя общей галереи изображений, в которой должно быть создано определение изображения. |
hypervgeneration string | Это свойство позволяет указать версию Hyper V виртуальных машин. Варианты:
|
identifier dictionary | Идентификатор изображения. Необходимо при создании. |
|
offer string / обязательно |
Имя предложения определения изображения галереи. |
|
publisher string / обязательно |
Имя издателя определения изображения галереи. |
|
sku string / обязательно |
Имя SKU определения изображения галереи. |
location string | Расположение ресурса. |
log_mode string | Аргумент родительского элемента. |
log_path string | Аргумент родительского элемента. |
name string / обязательно | Имя определения изображения галереи для создания или обновления. Допустимые символы: буквы, цифры, точки, дефисы и периоды в середине. Максимальная длина — 80 символов. |
os_state string | Допустимые значения для состояния ОС: Необходимо при создании. Варианты:
|
os_type string | Это свойство позволяет указать тип ОС, который включен в диск при создании ВМ из управляемого изображения. Необходимо при создании. Варианты:
|
password string | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы. |
privacy_statement_uri string | URI заявления о конфиденциальности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
purchase_plan dictionary | План закупки. |
|
name string |
Идентификатор плана. |
|
product string |
Идентификатор продукта. |
|
publisher string |
Идентификатор издателя. |
recommended dictionary | Рекомендуемые значения параметров. |
|
memory dictionary |
Память. |
|
max integer |
Максимальное количество ресурса. |
|
min integer |
Минимальное количество ресурса. |
|
v_cpus dictionary |
Количество виртуальных процессоров. |
|
max integer |
Максимальное количество ресурса. |
|
min integer |
Минимальное количество ресурса. |
release_note_uri string | URI заметки о выпуске. |
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секрет Azure клиента. Используйте при аутентификации с помощью принципала службы. |
state string | Утверждение состояния GalleryImage. Используйте Варианты:
|
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: Create or update gallery image
azure_rm_galleryimage:
resource_group: myResourceGroup
gallery_name: myGallery1283
name: myImage
location: West US
os_type: linux
os_state: generalized
identifier:
publisher: myPublisherName
offer: myOfferName
sku: mySkuName
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
id 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_galleryimage_module.html