Virtual Machine Image Templates - Get

Служба:: Image Builder

Версия API:: 2022-07-01

Получение сведений о шаблоне образа виртуальной машины

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}?api-version=2022-07-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
imageTemplateName	path	True	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Имя шаблона изображения
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав универсального кода ресурса (URI) для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Ответы

Имя	Тип	Описание
200 OK	ImageTemplate	ХОРОШО
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Retrieve an Image Template.

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate?api-version=2022-07-01

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
  "name": "myImageTemplate",
  "location": "westus",
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "source": {
      "type": "ManagedImage",
      "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image"
    },
    "customize": [
      {
        "type": "Shell",
        "name": "Shell Customizer Example",
        "scriptUri": "https://example.com/path/to/script.sh"
      }
    ],
    "distribute": [
      {
        "type": "ManagedImage",
        "location": "1_location",
        "runOutputName": "image_it_pir_1",
        "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
        "artifactTags": {
          "tagName": "value"
        }
      }
    ],
    "vmProfile": {
      "vmSize": "Standard_D2s_v3",
      "osDiskSizeGB": 64
    }
  }
}

Определения

Имя	Описание
CloudError	Ответ об ошибке из службы построителя образов виртуальных машин Azure.
CloudErrorBody	Ответ об ошибке из службы построителя образов виртуальных машин Azure.
createdByType	Тип удостоверения, создавшего ресурс.
DistributeVersionerLatest	Создает номер версии, который будет иметь последнюю версию на основе существующих номеров версий.
DistributeVersionerSource	Создает номер версии на основе номера версии исходного образа
ImageTemplate	Шаблон изображения — это ресурс ARM, управляемый поставщиком Microsoft.VirtualMachineImages
ImageTemplateFileCustomizer	Отправляет файлы на виртуальные машины (Linux, Windows). Соответствует подготовке файлов Packer
ImageTemplateFileValidator	Отправляет файлы, необходимые для проверки на виртуальные машины (Linux, Windows). Соответствует подготовке файлов Packer
ImageTemplateIdentity	Удостоверение для шаблона изображения.
ImageTemplateLastRunStatus	Описание последнего состояния запуска шаблона образа
ImageTemplateManagedImageDistributor	Распространение в виде образа управляемого диска.
ImageTemplateManagedImageSource	Описывает источник образа, который является управляемым образом в подписке клиента. Этот образ должен находиться в той же подписке и регионе, что и шаблон построителя образов.
ImageTemplatePlatformImageSource	Описывает источник изображения из образов коллекции Azure.
ImageTemplatePowerShellCustomizer	Запускает указанный PowerShell на виртуальной машине (Windows). Соответствует подготовке PowerShell Packer. Можно указать именно один из scriptUri или inline.
ImageTemplatePowerShellValidator	Выполняет указанный скрипт PowerShell на этапе проверки (Windows). Соответствует подготовке PowerShell Packer. Можно указать именно один из scriptUri или inline.
ImageTemplateRestartCustomizer	Перезагружает виртуальную машину и ожидает возвращения в интернет (Windows). Соответствует подготовке packer windows-restart
ImageTemplateSharedImageDistributor	Распространение через коллекцию вычислений Azure.
ImageTemplateSharedImageVersionSource	Описывает источник образа, который является версией образа в коллекции вычислений Azure или в общей коллекции Direct.
ImageTemplateShellCustomizer	Запускает скрипт оболочки на этапе настройки (Linux). Соответствует подготовке оболочки Packer. Можно указать именно один из scriptUri или inline.
ImageTemplateShellValidator	Выполняет указанный скрипт оболочки во время этапа проверки (Linux). Соответствует подготовке оболочки Packer. Можно указать именно один из scriptUri или inline.
ImageTemplateVhdDistributor	Распространение через VHD в учетной записи хранения.
ImageTemplateVmProfile	Описание виртуальных машин, используемых для создания и проверки образов
ImageTemplateWindowsUpdateCustomizer	Устанавливает обновления Windows. Соответствует поставщику подготовки центра обновления Windows Packer (https://github.com/rgl/packer-provisioner-windows-update)
Optimize	Указывает оптимизацию, выполняемую на изображении.
PlatformImagePurchasePlan	Конфигурация плана покупки для образа платформы.
ProvisioningError	Описание ошибки при создании или обновлении шаблона образа
ProvisioningErrorCode	Код ошибки сбоя подготовки
ProvisioningState	Состояние подготовки ресурса
ResourceIdentityType	Тип удостоверения, используемого для шаблона изображения. Тип "Нет" приведет к удалению удостоверений из шаблона образа.
RunState	Состояние последнего запуска
RunSubState	Подзаготовка последнего запуска
SharedImageStorageAccountType	Указывает тип учетной записи хранения, используемый для хранения версии образа коллекции вычислений Azure.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TargetRegion	Описание сведений о целевом регионе.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения
Validate	Параметры конфигурации и список проверок, выполняемых на результирующем изображении.
VirtualNetworkConfig	Конфигурация виртуальной сети.
VmBoot	Оптимизация применяется к образу для ускорения загрузки виртуальной машины.
VMBootOptimizationState	Включение этого поля улучшит время загрузки виртуальной машины, оптимизируя окончательные настраиваемые выходные данные образа.

CloudError

Object

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

Имя	Тип	Описание
error	CloudErrorBody	Сведения об ошибке.

CloudErrorBody

Object

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

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Object

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

Имя	Тип	Default value	Описание
major	integer (int32) minimum: -1	-1	Основная версия для созданного номера версии. Определите, что такое "последняя" на основе версий с этим значением в качестве основной версии. -1 эквивалентен выходу из него без набора.
scheme	string: Latest		Используемая схема нумерирования версий.

DistributeVersionerSource

Object

Создает номер версии на основе номера версии исходного образа

Имя	Тип	Описание
scheme	string: Source	Используемая схема нумерирования версий.

ImageTemplate

Object

Шаблон изображения — это ресурс ARM, управляемый поставщиком Microsoft.VirtualMachineImages

Имя	Тип	Default value	Описание
id	string		Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		Удостоверение шаблона изображения, если оно настроено.
location	string		Географическое расположение, в котором находится ресурс
name	string		Имя ресурса
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	Максимальная длительность ожидания при создании шаблона образа (включает все настройки, оптимизацию, проверку и дистрибутивы). Опустить или указать значение 0, чтобы использовать значение по умолчанию (4 часа).
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		Указывает свойства, используемые для описания шагов настройки изображения, таких как источник изображения и т. д.
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		Целевые объекты распределения, в которых выходные данные изображения должны перейти.
properties.exactStagingResourceGroup	string		Идентификатор промежуточной группы ресурсов в той же подписке, что и шаблон образа, который будет использоваться для сборки образа. Это поле только для чтения отличается от stagingResourceGroup, только если значение, указанное в поле stagingResourceGroup, пусто.
properties.lastRunStatus	ImageTemplateLastRunStatus		Состояние "run", которое выполняется в данный момент или было выполнено в последний раз.
properties.optimize	Optimize		Указывает оптимизацию, выполняемую на изображении.
properties.provisioningError	ProvisioningError		Ошибка подготовки, если она есть
properties.provisioningState	ProvisioningState		Состояние подготовки ресурса
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		Указывает свойства, используемые для описания исходного образа.
properties.stagingResourceGroup	string		Идентификатор промежуточной группы ресурсов в той же подписке, что и шаблон образа, который будет использоваться для сборки образа. Если это поле пусто, будет создана группа ресурсов со случайным именем. Если группа ресурсов, указанная в этом поле, не существует, она будет создана с тем же именем. Если указанная группа ресурсов существует, она должна быть пустой и в том же регионе, что и шаблон изображения. Созданная группа ресурсов будет удалена во время удаления шаблона, если это поле пусто или указанная группа ресурсов не существует, но если указанная группа ресурсов существует, ресурсы, созданные в группе ресурсов, будут удалены во время удаления шаблона, и сама группа ресурсов останется.
properties.validate	Validate		Параметры конфигурации и список проверок, выполняемых на результирующем изображении.
properties.vmProfile	ImageTemplateVmProfile		Описание настройки виртуальной машины для создания образов
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object		Теги ресурсов.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ImageTemplateFileCustomizer

Object

Отправляет файлы на виртуальные машины (Linux, Windows). Соответствует подготовке файлов Packer

Имя	Тип	Описание
destination	string	Абсолютный путь к файлу (с уже созданными вложенными структурами каталогов), в котором файл (из sourceUri) будет отправлен в виртуальную машину.
name	string	Понятное имя для предоставления контекста по этому шагу настройки
sha256Checksum	string	Контрольная сумма SHA256 файла, предоставленного в поле sourceUri выше
sourceUri	string	URI файла, который необходимо отправить для настройки виртуальной машины. Это может быть ссылка на github, URI SAS для службы хранилища Azure и т. д.
type	string: File	Тип средства настройки, которое вы хотите использовать на изображении. Например, "Оболочка" может быть настройщиком оболочки

ImageTemplateFileValidator

Object

Отправляет файлы, необходимые для проверки на виртуальные машины (Linux, Windows). Соответствует подготовке файлов Packer

Имя	Тип	Описание
destination	string	Абсолютный путь к файлу (с уже созданными вложенными структурами каталогов), в котором файл (из sourceUri) будет отправлен в виртуальную машину.
name	string	Понятное имя для предоставления контекста по этому шагу проверки
sha256Checksum	string	Контрольная сумма SHA256 файла, предоставленного в поле sourceUri выше
sourceUri	string	URI файла, который необходимо отправить на виртуальную машину для проверки. Это может быть ссылка на github, URI службы хранилища Azure (авторизованная или SAS) и т. д.
type	string: File	Тип проверки, которую вы хотите использовать на изображении. Например, "Shell" может быть проверкой оболочки

ImageTemplateIdentity

Object

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

Имя	Тип	Описание
type	ResourceIdentityType	Тип удостоверения, используемого для шаблона изображения. Тип "Нет" приведет к удалению удостоверений из шаблона образа.
userAssignedIdentities	<string, UserAssignedIdentity>	удостоверения User-Assigned Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ImageTemplateLastRunStatus

Object

Описание последнего состояния запуска шаблона образа

Имя	Тип	Описание
endTime	string (date-time)	Время окончания последнего выполнения (UTC)
message	string	Подробные сведения о последнем состоянии выполнения
runState	RunState	Состояние последнего запуска
runSubState	RunSubState	Подзаготовка последнего запуска
startTime	string (date-time)	Время начала последнего выполнения (UTC)

ImageTemplateManagedImageDistributor

Object

Распространение в виде образа управляемого диска.

Имя	Тип	Описание
artifactTags	object	Теги, которые будут применены к артефакту после его создания или обновления распространителем.
imageId	string	Идентификатор ресурса образа управляемого диска
location	string	Расположение Azure для образа должно соответствовать, если образ уже существует
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Имя, используемое для связанного runOutput.
type	string: ManagedImage	Тип распределения.

ImageTemplateManagedImageSource

Object

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

Имя	Тип	Описание
imageId	string	Идентификатор ресурса ARM управляемого образа в подписке клиента
type	string: ManagedImage	Указывает тип исходного образа, с которого вы хотите начать.

ImageTemplatePlatformImageSource

Object

Описывает источник изображения из образов коллекции Azure.

Имя	Тип	Описание
exactVersion	string	Версия образа из образов коллекции Azure. Это поле чтения отличается от "version", только если значение, указанное в поле "версия", имеет значение "latest".
offer	string	Предложение изображения из образов коллекции Azure.
planInfo	PlatformImagePurchasePlan	Необязательной конфигурации плана покупки для образа платформы.
publisher	string	Издатель образов в образы коллекции Azure.
sku	string	SKU изображения из образов коллекции Azure.
type	string: PlatformImage	Указывает тип исходного образа, с которого вы хотите начать.
version	string	Версия образа из образов коллекции Azure. Если здесь указана последняя версия, версия вычисляется при выполнении сборки образа, а не при отправке шаблона.

ImageTemplatePowerShellCustomizer

Object

Запускает указанный PowerShell на виртуальной машине (Windows). Соответствует подготовке PowerShell Packer. Можно указать именно один из scriptUri или inline.

Имя	Тип	Default value	Описание
inline	string[]		Массив команд PowerShell для выполнения
name	string		Понятное имя для предоставления контекста по этому шагу настройки
runAsSystem	boolean	False	Если задано, скрипт PowerShell будет выполняться с повышенными привилегиями с помощью локального пользователя системы. Значение true может быть только в том случае, если указанное выше поле runElevated имеет значение true.
runElevated	boolean	False	Если задано, скрипт PowerShell будет выполняться с повышенными привилегиями
scriptUri	string		URI скрипта PowerShell для настройки. Это может быть ссылка на github, URI SAS для службы хранилища Azure и т. д.
sha256Checksum	string		Контрольная сумма SHA256 скрипта Power Shell, предоставленного в поле scriptUri выше
type	string: PowerShell		Тип средства настройки, которое вы хотите использовать на изображении. Например, "Оболочка" может быть настройщиком оболочки
validExitCodes	integer[] (int32)		Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0]

ImageTemplatePowerShellValidator

Object

Выполняет указанный скрипт PowerShell на этапе проверки (Windows). Соответствует подготовке PowerShell Packer. Можно указать именно один из scriptUri или inline.

Имя	Тип	Default value	Описание
inline	string[]		Массив команд PowerShell для выполнения
name	string		Понятное имя для предоставления контекста по этому шагу проверки
runAsSystem	boolean	False	Если задано, скрипт PowerShell будет выполняться с повышенными привилегиями с помощью локального пользователя системы. Значение true может быть только в том случае, если указанное выше поле runElevated имеет значение true.
runElevated	boolean	False	Если задано, скрипт PowerShell будет выполняться с повышенными привилегиями
scriptUri	string		URI скрипта PowerShell для проверки. Это может быть ссылка на github, URI службы хранилища Azure и т. д.
sha256Checksum	string		Контрольная сумма SHA256 скрипта Power Shell, предоставленного в поле scriptUri выше
type	string: PowerShell		Тип проверки, которую вы хотите использовать на изображении. Например, "Shell" может быть проверкой оболочки
validExitCodes	integer[] (int32)		Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0]

ImageTemplateRestartCustomizer

Object

Перезагружает виртуальную машину и ожидает возвращения в интернет (Windows). Соответствует подготовке packer windows-restart

Имя	Тип	Описание
name	string	Понятное имя для предоставления контекста по этому шагу настройки
restartCheckCommand	string	Команда для проверки успешности перезапуска [по умолчанию: ''
restartCommand	string	Команда для выполнения перезапуска [по умолчанию: "завершение работы /r /f /t 0 /c"packer restart"]
restartTimeout	string	Время ожидания перезапуска, указанное в виде строки величины и единицы, например "5 м" (5 минут) или "2h" (2 часа) [по умолчанию: "5 млн" ]
type	string: WindowsRestart	Тип средства настройки, которое вы хотите использовать на изображении. Например, "Оболочка" может быть настройщиком оболочки

ImageTemplateSharedImageDistributor

Object

Распространение через коллекцию вычислений Azure.

Имя	Тип	Default value	Описание
artifactTags	object		Теги, которые будут применены к артефакту после его создания или обновления распространителем.
excludeFromLatest	boolean	False	Флаг, указывающий, следует ли исключить созданную версию образа из последней версии. Не следует использовать значение по умолчанию (false).
galleryImageId	string		Идентификатор ресурса образа коллекции вычислений Azure
replicationRegions	string[]		[Не рекомендуется] Список регионов, в которые будет реплицирован образ. Этот список можно указать только в том случае, если targetRegions не указан. Это поле устарело. Вместо этого используйте targetRegions.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		Имя, используемое для связанного runOutput.
storageAccountType	SharedImageStorageAccountType		[Не рекомендуется] Тип учетной записи хранения, используемый для хранения общего образа. Не следует использовать значение по умолчанию (Standard_LRS). Это поле можно указать только в том случае, если указан параметр replicationRegions. Это поле устарело. Вместо этого используйте targetRegions.
targetRegions	TargetRegion[]		Целевые регионы, в которых будет реплицироваться распределенная версия образа. Этот объект заменяет replicationRegions и может быть указан только в том случае, если репликацияRegions не указана.
type	string: SharedImage		Тип распределения.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Описывает создание нового номера версии x.y.z для распространения.

ImageTemplateSharedImageVersionSource

Object

Описывает источник образа, который является версией образа в коллекции вычислений Azure или в общей коллекции Direct.

Имя	Тип	Описание
exactVersion	string	Точный идентификатор ресурса ARM версии образа. Это поле чтения отличается от идентификатора версии образа в imageVersionId только в том случае, если имя версии, указанное в поле ImageVersionId, имеет значение "latest".
imageVersionId	string	Идентификатор ресурса ARM версии образа. Если имя версии образа является "последней", версия вычисляется при сборке образа.
type	string: SharedImageVersion	Указывает тип исходного образа, с которого вы хотите начать.

ImageTemplateShellCustomizer

Object

Запускает скрипт оболочки на этапе настройки (Linux). Соответствует подготовке оболочки Packer. Можно указать именно один из scriptUri или inline.

Имя	Тип	Описание
inline	string[]	Массив команд оболочки для выполнения
name	string	Понятное имя для предоставления контекста по этому шагу настройки
scriptUri	string	URI скрипта оболочки для настройки. Это может быть ссылка на github, URI SAS для службы хранилища Azure и т. д.
sha256Checksum	string	Контрольная сумма SHA256 скрипта оболочки, указанная в поле scriptUri
type	string: Shell	Тип средства настройки, которое вы хотите использовать на изображении. Например, "Оболочка" может быть настройщиком оболочки

ImageTemplateShellValidator

Object

Выполняет указанный скрипт оболочки во время этапа проверки (Linux). Соответствует подготовке оболочки Packer. Можно указать именно один из scriptUri или inline.

Имя	Тип	Описание
inline	string[]	Массив команд оболочки для выполнения
name	string	Понятное имя для предоставления контекста по этому шагу проверки
scriptUri	string	Универсальный код ресурса (URI) скрипта оболочки для проверки. Это может быть ссылка на github, URI службы хранилища Azure и т. д.
sha256Checksum	string	Контрольная сумма SHA256 скрипта оболочки, указанная в поле scriptUri
type	string: Shell	Тип проверки, которую вы хотите использовать на изображении. Например, "Shell" может быть проверкой оболочки

ImageTemplateVhdDistributor

Object

Распространение через VHD в учетной записи хранения.

Имя	Тип	Описание
artifactTags	object	Теги, которые будут применены к артефакту после его создания или обновления распространителем.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Имя, используемое для связанного runOutput.
type	string: VHD	Тип распределения.
uri	string	Необязательный URI службы хранилища Azure для распределенного большого двоичного объекта VHD. Не следует использовать значение по умолчанию (пустая строка), в котором VHD будет опубликован в учетной записи хранения в промежуточной группе ресурсов.

ImageTemplateVmProfile

Object

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

Имя	Тип	Default value	Описание
osDiskSizeGB	integer (int32) minimum: 0	0	Размер диска ОС в ГБ. Опустить или указать значение 0, чтобы использовать размер диска ОС Azure по умолчанию.
userAssignedIdentities	string[]		Необязательный массив идентификаторов ресурсов назначенных пользователем управляемых удостоверений для настройки на виртуальной машине сборки и на виртуальной машине проверки. Это может включать удостоверение шаблона изображения.
vmSize	string		Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустить или указать пустую строку, чтобы использовать значение по умолчанию (Standard_D1_v2 для образов 1-го поколения и Standard_D2ds_v4 для образов 2-го поколения).
vnetConfig	VirtualNetworkConfig		Необязательная конфигурация виртуальной сети для развертывания виртуальной машины сборки и проверки виртуальной машины. Опустить, если не требуется использовать определенную виртуальную сеть.

ImageTemplateWindowsUpdateCustomizer

Object

Устанавливает обновления Windows. Соответствует поставщику подготовки центра обновления Windows Packer (https://github.com/rgl/packer-provisioner-windows-update)

Имя	Тип	Default value	Описание
filters	string[]		Массив фильтров для выбора обновлений для применения. Опустите или укажите пустой массив для использования по умолчанию (без фильтра). См. приведенную выше ссылку на примеры и подробное описание этого поля.
name	string		Понятное имя для предоставления контекста по этому шагу настройки
searchCriteria	string		Критерии поиска обновлений. Опустить или указать пустую строку, чтобы использовать значение по умолчанию (выполните поиск всех). См. приведенную выше ссылку на примеры и подробное описание этого поля.
type	string: WindowsUpdate		Тип средства настройки, которое вы хотите использовать на изображении. Например, "Оболочка" может быть настройщиком оболочки
updateLimit	integer (int32) minimum: 0	0	Максимальное количество обновлений, применяемых за раз. Опустить или указать 0, чтобы использовать значение по умолчанию (1000)

Optimize

Object

Указывает оптимизацию, выполняемую на изображении.

Имя	Тип	Описание
vmBoot	VmBoot	Оптимизация применяется к образу для ускорения загрузки виртуальной машины.

PlatformImagePurchasePlan

Object

Конфигурация плана покупки для образа платформы.

Имя	Тип	Описание
planName	string	Имя плана покупки.
planProduct	string	Продукт плана покупки.
planPublisher	string	Издатель плана покупки.

ProvisioningError

Object

Описание ошибки при создании или обновлении шаблона образа

Имя	Тип	Описание
message	string	Подробное сообщение об ошибке подготовки
provisioningErrorCode	ProvisioningErrorCode	Код ошибки сбоя подготовки

ProvisioningErrorCode

Перечисление

Код ошибки сбоя подготовки

Значение	Описание
BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Other

ProvisioningState

Перечисление

Состояние подготовки ресурса

Значение	Описание
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Перечисление

Тип удостоверения, используемого для шаблона изображения. Тип "Нет" приведет к удалению удостоверений из шаблона образа.

Значение	Описание
UserAssigned
None

RunState

Перечисление

Состояние последнего запуска

Значение	Описание
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Перечисление

Подзаготовка последнего запуска

Значение	Описание
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Перечисление

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

Значение	Описание
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

TargetRegion

Object

Описание сведений о целевом регионе.

Имя	Тип	Default value	Описание
name	string		Имя региона.
replicaCount	integer (int32) minimum: 1	1	Количество реплик версии образа, создаваемых в этом регионе. Не следует использовать значение по умолчанию (1).
storageAccountType	SharedImageStorageAccountType		Указывает тип учетной записи хранения, используемый для хранения образа в этом регионе. Не следует использовать значение по умолчанию (Standard_LRS).

UserAssignedIdentity

Object

Свойства назначаемого пользователем удостоверения

Имя	Тип	Описание
clientId	string	Идентификатор клиента назначенного удостоверения.
principalId	string	Основной идентификатор назначенного удостоверения.

Validate

Object

Параметры конфигурации и список проверок, выполняемых на результирующем изображении.

Имя	Тип	Default value	Описание
continueDistributeOnFailure	boolean	False	Если проверка завершается ошибкой, и это поле имеет значение false, выходные образы не будут распространяться. Это поведение по умолчанию. Если проверка завершается ошибкой, и это поле имеет значение true, выходные образы по-прежнему будут распределены. Используйте этот параметр с осторожностью, так как это может привести к распространению плохих образов для использования. В любом случае (true или false), выполнение конечного образа будет сообщаться о сбое при сбое проверки. [Примечание. Это поле не влияет на успешное выполнение проверки.]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Список выполняемых проверок.
sourceValidationOnly	boolean	False	Если для этого поля задано значение true, то изображение, указанное в разделе "источник", будет проверено напрямую. Отдельная сборка не будет выполняться для создания и проверки настраиваемого образа.

VirtualNetworkConfig

Object

Конфигурация виртуальной сети.

Имя	Тип	Описание
proxyVmSize	string	Размер виртуальной машины прокси-сервера, используемой для передачи трафика на виртуальную машину сборки и проверку виртуальной машины. Опустить или указать пустую строку, чтобы использовать значение по умолчанию (Standard_A1_v2).
subnetId	string	Идентификатор ресурса существующей подсети.

VmBoot

Object

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

Имя	Тип	Описание
state	VMBootOptimizationState	Включение этого поля улучшит время загрузки виртуальной машины, оптимизируя окончательные настраиваемые выходные данные образа.

VMBootOptimizationState

Перечисление

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

Значение	Описание
Enabled
Disabled

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

Virtual Machine Image Templates - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Retrieve an Image Template.

Образец запроса

Пример ответа

Определения

CloudError

CloudErrorBody

createdByType

DistributeVersionerLatest

DistributeVersionerSource

ImageTemplate

ImageTemplateFileCustomizer

ImageTemplateFileValidator

ImageTemplateIdentity

ImageTemplateLastRunStatus

ImageTemplateManagedImageDistributor

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplatePowerShellCustomizer

ImageTemplatePowerShellValidator

ImageTemplateRestartCustomizer

ImageTemplateSharedImageDistributor

ImageTemplateSharedImageVersionSource

ImageTemplateShellCustomizer

ImageTemplateShellValidator

ImageTemplateVhdDistributor

ImageTemplateVmProfile

ImageTemplateWindowsUpdateCustomizer

Optimize

PlatformImagePurchasePlan

ProvisioningError

ProvisioningErrorCode

ProvisioningState

ResourceIdentityType

RunState

RunSubState

SharedImageStorageAccountType

systemData

TargetRegion

UserAssignedIdentity

Validate

VirtualNetworkConfig

VmBoot

VMBootOptimizationState