Поделиться через

az image

Note

Эта группа команд содержит команды, определенные как в Azure CLI, так и в одном расширении. Установите каждое расширение, чтобы воспользоваться расширенными возможностями. Подробнее о расширениях.

Управление пользовательскими образами виртуальных машин.

Команды

Имя Описание Тип Состояние
az image builder

Управление и создание шаблонов построителя образов.

 Core GA
az image builder cancel

Отмена длительной сборки образа на основе шаблона образа.

 Core GA
az image builder create

Создайте шаблон построителя образов.

 Core GA
az image builder customizer

Управление настройщиками шаблонов построителя образов.

 Core GA
az image builder customizer add

Добавьте настройщик построителя изображений в шаблон построителя образов.

 Core GA
az image builder customizer clear

Удалите всех настройщиков построителя образов из шаблона построителя образов.

 Core GA
az image builder customizer remove

Удалите настройщик построителя образов из шаблона построителя образов.

 Core GA
az image builder delete

Удаление шаблона построителя образов.

 Core GA
az image builder error-handler

Управление обработчиком ошибок шаблона построителя образов.

 Core GA
az image builder error-handler add

Добавьте обработчик ошибок в существующий шаблон построителя образов.

 Core GA
az image builder error-handler remove

Удалите обработчик ошибок из существующего шаблона построителя образов.

 Core GA
az image builder error-handler show

Отображение обработчика ошибок существующего шаблона построителя образов.

 Core GA
az image builder identity

Управление удостоверениями шаблона построителя образов.

 Core GA
az image builder identity assign

Добавьте управляемые удостоверения в существующий шаблон построителя образов. В настоящее время поддерживается только одно удостоверение пользователя.

 Core GA
az image builder identity remove

Удалите управляемые удостоверения из существующего шаблона построителя образов.

 Core GA
az image builder identity show

Отображение управляемых удостоверений шаблона построителя образов.

 Core GA
az image builder list

Вывод списка шаблонов построителя изображений.

 Core GA
az image builder optimizer

Управление оптимизатором шаблона построителя образов.

 Core GA
az image builder optimizer add

Добавьте оптимизатор в существующий шаблон построителя образов.

 Core GA
az image builder optimizer remove

Удалите оптимизатор из существующего шаблона построителя образов.

 Core GA
az image builder optimizer show

Показать оптимизатор существующего шаблона построителя образов.

 Core GA
az image builder optimizer update

Обновите оптимизатор из существующего шаблона построителя образов.

 Core GA
az image builder output

Управление распространителями выходных данных шаблона построителя образов.

 Core GA
az image builder output add

Добавьте распространитель выходных данных построителя изображений в шаблон построителя образов.

 Core GA
az image builder output clear

Удалите всех распространителей выходных данных построителя образов из шаблона построителя образов.

 Core GA
az image builder output remove

Удалите распространитель выходных данных построителя изображений из шаблона построителя образов.

 Core GA
az image builder output versioning

Управление выходным версиям шаблона построителя образов.

 Core GA
az image builder output versioning remove

Удалите все параметры управления версиями для указанных выходных данных.

 Core GA
az image builder output versioning set

Задайте выходную версию конструктора образов шаблона построителя образов.

 Core GA
az image builder output versioning show

Отображение параметров управления версиями для указанных выходных данных.

 Core GA
az image builder run

Создание шаблона построителя образов.

 Core GA
az image builder show

Отображение шаблона построителя изображений.

 Core GA
az image builder show-runs

Отображение выходных данных запуска шаблона построителя образов.

 Core GA
az image builder trigger

Управление триггером шаблона построителя образов.

 Core GA
az image builder trigger create

Создайте триггер для указанного шаблона образа виртуальной машины.

 Core GA
az image builder trigger delete

Удалите триггер для указанного шаблона образа виртуальной машины.

 Core GA
az image builder trigger list

Перечислить все триггеры для указанного ресурса шаблона образа.

 Core GA
az image builder trigger show

Получите указанный триггер для указанного ресурса шаблона образа.

 Core GA
az image builder trigger wait

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие.

 Core GA
az image builder update

Обновите шаблон построителя образов.

 Core GA
az image builder validator

Управление проверкой шаблона построителя образов.

 Core GA
az image builder validator add

Добавьте проверку в существующий шаблон построителя образов.

 Core GA
az image builder validator remove

Удалите проверку из существующего шаблона построителя образов.

 Core GA
az image builder validator show

Отображение существующего шаблона построителя образов.

 Core GA
az image builder wait

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие шаблона.

 Core GA
az image copy

Скопируйте управляемый образ (или виртуальную машину) в другие регионы. Для этого требуется, чтобы исходный диск был доступен.

 Extension GA
az image create

Создайте пользовательский образ виртуальной машины на управляемых дисках или моментальных снимках.

 Core GA
az image delete

Удаление изображения.

 Core GA
az image list

Список изображений в группе ресурсов.

 Core GA
az image show

Получение изображения.

 Core GA
az image update

Обновление пользовательских образов виртуальных машин.

 Core GA
az image wait

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие.

 Core GA

az image copy

Скопируйте управляемый образ (или виртуальную машину) в другие регионы. Для этого требуется, чтобы исходный диск был доступен.

az image copy --source-object-name
              --source-resource-group
              --target-location
              --target-resource-group
              [--cleanup]
              [--export-as-snapshot]
              [--parallel-degree]
              [--source-type {image, vm}]
              [--tags]
              [--target-name]
              [--target-subscription]
              [--temporary-resource-group-name]
              [--timeout]

Примеры

Скопируйте изображение в несколько регионов и очистите его в конце.

az image copy --source-resource-group mySources-rg --source-object-name myImage \
    --target-location uksouth northeurope --target-resource-group "images-repo-rg" --cleanup

Используйте уже обобщенную виртуальную машину для создания образов в других регионах.

az image copy --source-resource-group mySources-rg --source-object-name myVm \
    --source-type vm --target-location uksouth northeurope --target-resource-group "images-repo-rg"

Обязательные параметры

--source-object-name

Имя ресурса образа или виртуальной машины.

--source-resource-group

Имя группы ресурсов исходного ресурса.

--target-location

Список разделенных пробелами расположений для создания образа (например, westeurope и т. д.).

--target-resource-group

Имя группы ресурсов для создания изображений в.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cleanup

Включите этот параметр для удаления временных ресурсов после завершения.

Свойство Значение
Default value: False
--export-as-snapshot

Включите этот параметр для экспорта копий в виде моментальных снимков вместо изображений.

Свойство Значение
Default value: False
--parallel-degree

Число параллельных операций копирования.

Свойство Значение
Default value: -1
--source-type

Образ или виртуальная машина.

Свойство Значение
Default value: image
Допустимые значения: image, vm
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--target-name

Имя окончательного образа, которое будет создано.

--target-subscription

Имя или идентификатор подписки, в которой должен быть создан окончательный образ.

--temporary-resource-group-name

Имя группы ресурсов, в которой будет создана временная учетная запись хранения.

Свойство Значение
Default value: image-copy-rg
--timeout

Время в секундах для завершения операции копирования. Увеличьте это время, если вы собираетесь скопировать большие образы (диски), например 512 ГБ или более.

Свойство Значение
Default value: 3600
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az image create

Создайте пользовательский образ виртуальной машины на управляемых дисках или моментальных снимках.

az image create --name
                --resource-group
                --source
                [--data-disk-caching {None, ReadOnly, ReadWrite}]
                [--data-disk-sources]
                [--edge-zone]
                [--hyper-v-generation {V1, V2}]
                [--location]
                [--os-disk-caching {None, ReadOnly, ReadWrite}]
                [--os-type {Linux, Windows}]
                [--storage-sku {PremiumV2_LRS, Premium_LRS, Premium_ZRS, StandardSSD_LRS, StandardSSD_ZRS, Standard_LRS, UltraSSD_LRS}]
                [--tags]
                [--zone-resilient {false, true}]

Примеры

Создайте образ с существующего диска.

az image create -g MyResourceGroup -n image1 --os-type Linux \
    --source /subscriptions/db5eb68e-73e2-4fa8-b18a-0123456789999/resourceGroups/rg1/providers/Microsoft.Compute/snapshots/s1

Создайте образ, захватив существующую обобщенную виртуальную машину в той же группе ресурсов.

az image create -g MyResourceGroup -n image1 --source MyVm1

Обязательные параметры

--name -n

Новое имя изображения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--source

Источник диска ОС из того же региона, включая идентификатор виртуальной машины или имя, URI большого двоичного объекта ОПЕРАЦИОННОй системы, идентификатор управляемого диска ОПЕРАЦИОННОй системы или имя, а также идентификатор моментального снимка ос или имя.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--data-disk-caching

Тип кэширования хранилища для диска данных образа.

Свойство Значение
Допустимые значения: None, ReadOnly, ReadWrite
--data-disk-sources

Разделенный пробелами список источников диска данных, включая URI неуправляемого большого двоичного объекта, идентификатор управляемого диска или имя, или идентификатор моментального снимка или имя.

--edge-zone

Имя пограничной зоны.

--hyper-v-generation

Создание гипервизора виртуальной машины, созданной на основе образа.

Свойство Значение
Default value: V1
Допустимые значения: V1, V2
--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--os-disk-caching

Тип кэширования хранилища для диска ОС образа.

Свойство Значение
Допустимые значения: None, ReadOnly, ReadWrite
--os-type
Свойство Значение
Допустимые значения: Linux, Windows
--storage-sku

Номер SKU учетной записи хранения, с помощью которой создается образ виртуальной машины. Не используется, если указана исходная виртуальная машина.

Свойство Значение
Допустимые значения: PremiumV2_LRS, Premium_LRS, Premium_ZRS, StandardSSD_LRS, StandardSSD_ZRS, Standard_LRS, UltraSSD_LRS
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--zone-resilient

Указывает, является ли изображение устойчивым к зонам. По умолчанию — false. Устойчивые к зонам образы можно создавать только в регионах, которые предоставляют хранилище, избыточное между зонами.

Свойство Значение
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az image delete

Удаление изображения.

az image delete [--ids]
                [--image-name --name]
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                [--resource-group]
                [--subscription]

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--image-name --name -n

Имя изображения.

Свойство Значение
Parameter group: Resource Id Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az image list

Список изображений в группе ресурсов.

az image list [--max-items]
              [--next-token]
              [--resource-group]

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Общее количество элементов, возвращаемых в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, маркер предоставляется в выходных данных команды. Чтобы возобновить разбиение на страницы, укажите значение маркера в --next-token аргументе последующей команды.

Свойство Значение
Parameter group: Pagination Arguments
--next-token

Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.

Свойство Значение
Parameter group: Pagination Arguments
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az image show

Получение изображения.

az image show [--expand]
              [--ids]
              [--image-name --name]
              [--resource-group]
              [--subscription]

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--expand

Выражение расширения, применяемое к операции.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--image-name --name -n

Имя изображения.

Свойство Значение
Parameter group: Resource Id Arguments
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az image update

Обновление пользовательских образов виртуальных машин.

az image update [--add]
                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                [--ids]
                [--image-name --name]
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                [--remove]
                [--resource-group]
                [--set]
                [--subscription]
                [--tags]

Примеры

Добавление или обновление тегов.

az image update -n ImageName -g ResourceGroup --tags tag1=val1 tag2=val2

Удалите все теги.

az image update -n ImageName -g resourceGroup --tags

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Свойство Значение
Parameter group: Generic Update Arguments
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Свойство Значение
Parameter group: Generic Update Arguments
Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--image-name --name -n

Имя изображения.

Свойство Значение
Parameter group: Resource Id Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Свойство Значение
Parameter group: Generic Update Arguments
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Parameter group: Resource Id Arguments
--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Свойство Значение
Parameter group: Generic Update Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Parameter group: Resource Id Arguments
--tags

Теги ресурсов поддерживают сокращенный синтаксис, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: Parameters Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az image wait

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие.

az image wait [--created]
              [--custom]
              [--deleted]
              [--exists]
              [--expand]
              [--ids]
              [--image-name --name]
              [--interval]
              [--resource-group]
              [--subscription]
              [--timeout]
              [--updated]

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

Свойство Значение
Parameter group: Wait Condition Arguments
--deleted

Дождитесь удаления.

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--exists

Подождите, пока ресурс не существует.

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--expand

Выражение расширения, применяемое к операции.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--image-name --name -n

Имя изображения.

Свойство Значение
Parameter group: Resource Id Arguments
--interval

Интервал опроса в секундах.

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Parameter group: Resource Id Arguments
--timeout

Максимальное ожидание в секундах.

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False