az image builder
Управление и создание шаблонов построителя образов.
Команды
Имя | Описание | Тип | Состояние |
---|---|---|---|
az image builder cancel |
Отмена длительной сборки образа на основе шаблона образа. |
Основные сведения | Общедоступная версия |
az image builder create |
Создайте шаблон построителя образов. |
Основные сведения | Общедоступная версия |
az image builder customizer |
Управление настройщиками шаблонов конструктора образов. |
Основные сведения | Общедоступная версия |
az image builder customizer add |
Добавьте настройщик построителя изображений в шаблон построителя образов. |
Основные сведения | Общедоступная версия |
az image builder customizer clear |
Удалите всех настройщиков построителя образов из шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder customizer remove |
Удалите настройщик построителя образов из шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder delete |
Удаление шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder error-handler |
Управление обработчиком ошибок шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder error-handler add |
Добавьте обработчик ошибок в существующий шаблон построителя образов. |
Основные сведения | Общедоступная версия |
az image builder error-handler remove |
Удалите обработчик ошибок из существующего шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder error-handler show |
Отображение обработчика ошибок существующего шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder identity |
Управление удостоверениями шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder identity assign |
Добавьте управляемые удостоверения в существующий шаблон построителя образов. В настоящее время поддерживается только одно удостоверение пользователя. |
Основные сведения | Общедоступная версия |
az image builder identity remove |
Удалите управляемые удостоверения из существующего шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder identity show |
Отображение управляемых удостоверений шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder list |
Вывод списка шаблонов построителя изображений. |
Основные сведения | Общедоступная версия |
az image builder optimizer |
Управление оптимизатором шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder optimizer add |
Добавьте оптимизатор в существующий шаблон построителя образов. |
Основные сведения | Общедоступная версия |
az image builder optimizer remove |
Удалите оптимизатор из существующего шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder optimizer show |
Показать оптимизатор существующего шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder optimizer update |
Обновите оптимизатор из существующего шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder output |
Управление распространителями выходных данных шаблона конструктора образов. |
Основные сведения | Общедоступная версия |
az image builder output add |
Добавьте распространитель выходных данных построителя изображений в шаблон построителя образов. |
Основные сведения | Общедоступная версия |
az image builder output clear |
Удалите всех распространителей выходных данных построителя образов из шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder output remove |
Удалите распространитель выходных данных построителя изображений из шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder output versioning |
Управление выходным версиям шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder output versioning remove |
Удалите все параметры управления версиями для указанных выходных данных. |
Основные сведения | Общедоступная версия |
az image builder output versioning set |
Задайте выходную версию конструктора образов шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder output versioning show |
Отображение параметров управления версиями для указанных выходных данных. |
Основные сведения | Общедоступная версия |
az image builder run |
Создание шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder show |
Отображение шаблона построителя изображений. |
Основные сведения | Общедоступная версия |
az image builder show-runs |
Отображение выходных данных запуска шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder trigger |
Управление триггером шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder trigger create |
Создайте триггер для указанного шаблона образа виртуальной машины. |
Основные сведения | Общедоступная версия |
az image builder trigger delete |
Удалите триггер для указанного шаблона образа виртуальной машины. |
Основные сведения | Общедоступная версия |
az image builder trigger list |
Перечислить все триггеры для указанного ресурса шаблона образа. |
Основные сведения | Общедоступная версия |
az image builder trigger show |
Получите указанный триггер для указанного ресурса шаблона образа. |
Основные сведения | Общедоступная версия |
az image builder trigger wait |
Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие. |
Основные сведения | Общедоступная версия |
az image builder update |
Обновите шаблон построителя образов. |
Основные сведения | Общедоступная версия |
az image builder validator |
Управление проверкой шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder validator add |
Добавьте проверку в существующий шаблон построителя образов. |
Основные сведения | Общедоступная версия |
az image builder validator remove |
Удалите проверку из существующего шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder validator show |
Отображение существующего шаблона построителя образов. |
Основные сведения | Общедоступная версия |
az image builder wait |
Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие шаблона. |
Основные сведения | Общедоступная версия |
az image builder cancel
Отмена длительной сборки образа на основе шаблона образа.
az image builder cancel [--ids]
[--name]
[--resource-group]
[--subscription]
Примеры
Отмена сборки образа.
az image builder cancel -n mytemplate -g my-group
Необязательные параметры
Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Имя шаблона изображения.
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az image builder create
Создайте шаблон построителя образов.
az image builder create --name
--resource-group
[--build-timeout]
[--build-vm-identities]
[--checksum]
[--defer]
[--identity]
[--image-source]
[--image-template]
[--location]
[--managed-image-destinations]
[--no-wait]
[--os-disk-size]
[--proxy-vm-size]
[--scripts]
[--shared-image-destinations]
[--staging-resource-group]
[--subnet]
[--tags]
[--validator]
[--vm-size]
[--vnet]
Примеры
Создайте шаблон построителя образов из образа Ubuntu2204. Распространяйте его как управляемый образ и версию образа общей коллекции образов. Укажите идентификатор промежуточной группы ресурсов в качестве шаблона образа, который будет использоваться для сборки образа.
scripts="https://my-script-url.net/customize_script.sh"
imagesource="Canonical:0001-com-ubuntu-server-jammy:22_04-lts-gen2:latest"
az image builder create --image-source $imagesource -n myTemplate -g myGroup \
--scripts $scripts --managed-image-destinations image_1=westus \
--shared-image-destinations my_shared_gallery/linux_image_def=westus,brazilsouth \
--identity myIdentity --staging-resource-group myStagingResourceGroup
Создайте шаблон построителя образов с помощью файла шаблона образа.
az image builder create -g my-group -n myTemplate --image-template filename
[Дополнительно] Создайте шаблон изображения с несколькими настройщиками и распространителями с помощью кэша объектов CLI через --defer. Поддерживает такие функции, как настройщик и выходные имена, коды выхода PowerShell, встроенные скрипты, перезагрузка windows, настройщики файлов, теги артефактов и распространители выходных данных vhd.
script="https://my-script-url.com/customize_script.ps1"
imagesource="MicrosoftWindowsServer:WindowsServer:2019-Datacenter:2019.0.20190214"
# create and update template object in local cli cache. Defers put request to ARM
# Cache object ttl set via az configure.
az image builder create --image-source $imagesource -n myTemplate \
-g myGroup --scripts $script --identity myIdentity --defer
# add customizers
az image builder customizer add -n myTemplate -g myGroup \
--customizer-name myPwshScript --exit-codes 0 1 --inline-script \
"mkdir c:\buildActions" "echo Azure-Image-Builder-Was-Here \
> c:\buildActions\Output.txt" --type powershell --defer
az image builder customizer add -n myTemplate -g myGroup \
--customizer-name myFileCustomizer --type file \
--file-source "https://my-file-source.net/file.txt" \
--dest-path "c:\buildArtifacts\file.txt" --defer
# add distributors
az image builder output add -n myTemplate -g myGroup --is-vhd \
--output-name myWinImageVhd --artifact-tags "is_vhd=True" --defer
az image builder output add -n myTemplate -g myGroup \
--output-name myWinImageManaged --managed-image winImage \
--managed-image-location eastus \
--artifact-tags "is_vhd=False" --defer
# Stop deferring put request to ARM. Create the template from the object cache.
# Cache object will be deleted.
az image builder update -n myTemplate -g myGroup
Обязательные параметры
Имя шаблона изображения.
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Необязательные параметры
Максимальная длительность ожидания при создании шаблона изображения в минутах. Значение по умолчанию — 60.
Необязательная конфигурация виртуальной сети для развертывания виртуальной машины сборки. Не указывайте, если не требуется использовать определенную виртуальную сеть.
Sha256 проверка sum образа Red Hat ISO.
Временно сохраните объект в локальном кэше вместо отправки в Azure. Используйте az cache
команды для просмотра и очистки.
Список назначенных пользователем удостоверений (имя или идентификатор, разделенные пробелами) шаблона изображения.
Базовый образ для настройки. Должен быть допустимым url-адресом образа платформы, псевдонимом образа платформы, URI образа Red Hat, идентификатором управляемого образа или идентификатором общей версии образа.
Локальный путь или URL-адрес файла шаблона изображения. При использовании --image-template все остальные параметры игнорируются, кроме -g и -n. Справочные материалы: https://docs.microsoft.com/azure/virtual-machines/linux/image-builder-json.
Location. Значения из az account list-locations
. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>
.
Сведения о распространителях выходных данных управляемого образа. Разделенный пробелами список пар "ключ-значение". Например, "image_1=westus2 image_2=westus". Каждый ключ — это имя или идентификатор ресурса создаваемого управляемого образа. Каждое значение — это расположение изображения.
Не ожидать завершения длительной операции.
Размер диска ОС в ГБ. Опустить или указать значение 0, чтобы использовать размер диска ОС Azure по умолчанию.
Размер виртуальной машины, используемой для создания, настройки и записи образов (Standard_D1_v2 для образов 1-го поколения и Standard_D2ds_v4 для образов 2-го поколения).
Разделенный пробелами список сценариев оболочки или PowerShell для настройки образа. Каждый скрипт должен быть общедоступным URL-адресом. Введите тип скрипта из расширения файла ('.sh' или '.ps1') или из исходного типа. Дополнительные параметры настройки и гибкость см. в статье "az image template customizer add".
Общие сведения о распространитее изображений (sig). Разделенный пробелами список пар "ключ-значение". Например, "my_gallery_1/image_def_1=eastus,westus my_gallery_2/image_def_2=uksouth,canadaeast,francesouth". Каждый ключ — это идентификатор определения изображения sig или имя коллекции sig и определение изображения sig, разделенное "/". Каждое значение — это список реплика расположений с разделителями-запятыми.
Идентификатор промежуточной группы ресурсов в той же подписке, что и шаблон образа, который будет использоваться для сборки образа.
Имя или идентификатор подсети для развертывания виртуальной машины сборки.
Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.
Тип проверки, которую вы хотите использовать на изображении. Например, "Оболочка" может быть проверкой оболочки.
Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустить или указать пустую строку, чтобы использовать значение по умолчанию (Standard_D1_v2).
Имя виртуальной сети для развертывания виртуальной машины сборки. Его следует указать только в том случае, если подсеть является именем.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az image builder delete
Удаление шаблона построителя образов.
az image builder delete [--ids]
[--name]
[--resource-group]
[--subscription]
Примеры
Удаление шаблона построителя образов. (автоматическое создание)
az image builder delete --name MyImageTemplate --resource-group MyResourceGroup
Необязательные параметры
Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Имя шаблона изображения.
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az image builder list
Вывод списка шаблонов построителя изображений.
az image builder list [--resource-group]
Необязательные параметры
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az image builder run
Создание шаблона построителя образов.
az image builder run [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
Примеры
Запустите запуск сборки шаблона и дождитесь завершения.
az image builder run -n mytemplate -g my-group --no-wait
az image builder wait -n mytemplate -g aibmdi \
--custom "lastRunStatus.runState!='Running'"
az image builder show -n mytemplate -g my-group
Необязательные параметры
Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Имя шаблона изображения.
Не ожидать завершения длительной операции.
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az image builder show
Отображение шаблона построителя изображений.
az image builder show [--ids]
[--name]
[--resource-group]
[--subscription]
Примеры
Отображение шаблона построителя изображений (автоматическое создание)
az image builder show --name mytemplate --resource-group my-group
Необязательные параметры
Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Имя шаблона изображения.
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az image builder show-runs
Отображение выходных данных запуска шаблона построителя образов.
az image builder show-runs [--ids]
[--name]
[--output-name]
[--resource-group]
[--subscription]
Примеры
Запустите запуск сборки шаблона и просмотрите выходные данные выполнения.
az image builder run -n mytemplate -g my-group --no-wait
az image builder wait -n mytemplate -g aibmdi \
--custom "lastRunStatus.runState!='Running'"
az image builder show-runs -n mytemplate -g my-group
Необязательные параметры
Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Имя шаблона изображения.
Имя выходных данных построителя образов.
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az image builder update
Обновите шаблон построителя образов.
Обновление шаблонов построителя образов в настоящее время не поддерживается. Эта команда может использоваться в сочетании с --defer для обновления объекта шаблона изображения в кэше CLI. Без --defer он извлекает указанный шаблон образа из кэша и отправляет запрос в Azure для создания шаблона образа.
az image builder update [--add]
[--defer]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
Примеры
Создайте ресурс шаблона из объекта шаблона в кэше cli. Дополнительные сведения см. в разделе "az image builder create/ output add / customizer add --help" и "az cache -h"
# create and write template object to local cli cache
az image builder create --image-source {image_source} -n mytemplate -g my-group \
--scripts {script} --managed-image-destinations image_1=westus --identity myidentity --defer
# add customizers and outputs to local cache template object via az image template output / customizer add
# one can also update cache object properties through generic update options, such as: --set
az image builder output add -n mytemplate -g my-group --output-name my-win-image-managed \
--artifact-tags "is_vhd=False" --managed-image winImage --managed-image-location eastus --defer
# send template create request to azure to create template resource
az image builder update -n mytemplate -g my-group
Необязательные параметры
Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>
.
Временно сохраните объект в локальном кэше вместо отправки в Azure. Используйте az cache
команды для просмотра и очистки.
При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.
Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Имя шаблона изображения.
Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>
.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az image builder wait
Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие шаблона.
az image builder wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Примеры
Запустите запуск сборки шаблона и дождитесь завершения.
az image builder run -n mytemplate -g my-group --no-wait
az image builder wait -n mytemplate -g aibmdi \
--custom "lastRunStatus.runState!='Running'"
az image builder show -n mytemplate -g my-group
Необязательные параметры
Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".
Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].
Дождитесь удаления.
Подождите, пока ресурс не существует.
Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Интервал опроса в секундах.
Имя шаблона изображения.
Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>
.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Максимальное ожидание в секундах.
Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Отображение этого справочного сообщения и выход.
Показывать только ошибки, блокируя предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.