Microsoft.VirtualMachineImages imageTemplates 2021-10-01
Определение ресурса Bicep
Тип ресурса imageTemplates можно развернуть в следующих объектах:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.VirtualMachineImages/imageTemplates, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2021-10-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
buildTimeoutInMinutes: int
customize: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute: [
{
artifactTags: {}
runOutputName: 'string'
type: 'string'
// For remaining properties, see ImageTemplateDistributor objects
}
]
source: {
type: 'string'
// For remaining properties, see ImageTemplateSource objects
}
vmProfile: {
osDiskSizeGB: int
userAssignedIdentities: [
'string'
]
vmSize: 'string'
vnetConfig: {
proxyVmSize: 'string'
subnetId: 'string'
}
}
}
}
Объекты ImageTemplateCustomizer
Задайте свойство type , чтобы указать тип объекта .
Для параметра Файл используйте:
type: 'File'
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
Для PowerShell используйте:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Для оболочки используйте:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Для WindowsRestart используйте:
type: 'WindowsRestart'
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
Для WindowsUpdate используйте:
type: 'WindowsUpdate'
filters: [
'string'
]
searchCriteria: 'string'
updateLimit: int
Объекты ImageTemplateDistributor
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
type: 'ManagedImage'
imageId: 'string'
location: 'string'
Для SharedImage используйте:
type: 'SharedImage'
excludeFromLatest: bool
galleryImageId: 'string'
replicationRegions: [
'string'
]
storageAccountType: 'string'
Для виртуального жесткого диска используйте:
type: 'VHD'
Объекты ImageTemplateSource
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
type: 'ManagedImage'
imageId: 'string'
Для PlatformImage используйте:
type: 'PlatformImage'
offer: 'string'
planInfo: {
planName: 'string'
planProduct: 'string'
planPublisher: 'string'
}
publisher: 'string'
sku: 'string'
version: 'string'
Для SharedImageVersion используйте:
type: 'SharedImageVersion'
imageVersionId: 'string'
Значения свойств
imageTemplates
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. | string (обязательно) |
| location | Географическое расположение, в котором находится ресурс | string (обязательно) |
| tags | Теги ресурсов. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| удостоверение | Удостоверение шаблона образа, если оно настроено. | ImageTemplateIdentity (обязательно) |
| properties | Свойства шаблона изображения | ImageTemplateProperties |
ImageTemplateIdentity
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для шаблона изображения. Тип None приведет к удалению всех удостоверений из шаблона образа. | "Нет" UserAssigned |
| userAssignedIdentities | Список удостоверений пользователей, связанных с шаблоном образа. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | объект |
ImageTemplateProperties
| Имя | Описание | Значение |
|---|---|---|
| buildTimeoutInMinutes | Максимальная продолжительность ожидания при создании шаблона образа. Опустите или укажите значение 0, чтобы использовать значение по умолчанию (4 часа). | INT |
| настройка | Указывает свойства, используемые для описания этапов настройки образа, например источник изображения и т. д. | ImageTemplateCustomizer[] |
| распространение | Распределение целевых объектов, к которому должны перейти выходные данные изображения. | ImageTemplateDistributor[] (обязательно) |
| source | Указывает свойства, используемые для описания исходного изображения. | ImageTemplateSource (обязательно) |
| vmProfile | Описание настройки виртуальной машины для создания образов | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| name | Понятное имя для предоставления контекста того, что делает этот шаг настройки | строка |
| type | Установка типа объекта | Файл PowerShell Оболочка WindowsRestart WindowsUpdate (обязательно) |
ImageTemplateFileCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | "Файл" (обязательно) |
| ресурс destination | Абсолютный путь к файлу (с уже созданными вложенными структурами каталогов), в который будет отправлен файл (из sourceUri) на виртуальной машине. | строка |
| sha256Checksum | Контрольная сумма SHA256 для файла, указанного в приведенном выше поле sourceUri | строка |
| sourceUri | Универсальный код ресурса (URI) файла, отправляемого для настройки виртуальной машины. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
ImageTemplatePowerShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | PowerShell (обязательно) |
| inline | Массив команд PowerShell для выполнения | string[] |
| runAsSystem | Если этот параметр указан, сценарий PowerShell будет выполняться с повышенными привилегиями с помощью пользователя локальной системы. Значение true может быть только в том случае, если для поля runElevated выше задано значение true. | bool |
| runElevated | Если этот параметр указан, сценарий PowerShell будет выполняться с повышенными привилегиями. | bool |
| scriptUri | Универсальный код ресурса (URI) скрипта PowerShell для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| sha256Checksum | Контрольная сумма SHA256 скрипта Power Shell, указанного в поле scriptUri выше | строка |
| validExitCodes | Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0] | int[] |
ImageTemplateShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | Оболочка (обязательно) |
| inline | Массив команд оболочки для выполнения | string[] |
| scriptUri | Универсальный код ресурса (URI) скрипта оболочки для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| sha256Checksum | Контрольная сумма SHA256 для скрипта оболочки, предоставленного в поле scriptUri | строка |
ImageTemplateRestartCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | "WindowsRestart" (обязательно) |
| restartCheckCommand | Команда для проверка успешного перезапуска [по умолчанию: ''] | строка |
| restartCommand | Команда для выполнения перезапуска [по умолчанию: shutdown /r /f /t 0 /c "packer restart"] | строка |
| restartTimeout | Время ожидания перезапуска, указанное в виде строки величины и единицы измерения, например "5 мин" (5 минут) или "2 ч" (2 часа) [по умолчанию: "5 мин"] | строка |
ImageTemplateWindowsUpdateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | WindowsUpdate (обязательно) |
| filters | Массив фильтров для выбора обновлений для применения. Опустите или укажите пустой массив, чтобы использовать значение по умолчанию (без фильтра). Примеры и подробное описание этого поля см. по ссылке выше. | string[] |
| searchCriteria | Условия для поиска обновлений. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (поиск по всем). Примеры и подробное описание этого поля см. по ссылке выше. | строка |
| updateLimit | Максимальное количество обновлений, применяемых одновременно. Опустить или указать 0, чтобы использовать значение по умолчанию (1000) | INT |
ImageTemplateDistributor
| Имя | Описание | Значение |
|---|---|---|
| artifactTags | Теги, которые будут применены к артефакту после его создания или обновления распространителем. | объект |
| runOutputName | Имя, используемое для связанного объекта RunOutput. | string (обязательно) |
| тип | Установка типа объекта | ManagedImage SharedImage VHD (обязательно) |
ImageTemplateManagedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса образа управляемого диска | string (обязательно) |
| location | Расположение образа в Azure должно совпадать, если образ уже существует | string (обязательно) |
ImageTemplateSharedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | SharedImage (обязательно) |
| excludeFromLatest | Флаг, указывающий, следует ли исключить созданную версию образа из последней версии. Не используйте значение по умолчанию (false). | bool |
| galleryImageId | Идентификатор ресурса образа Общая коллекция образов | string (обязательно) |
| replicationRegions | Список регионов, в которые будет реплицирован образ. | string[] (обязательно) |
| storageAccountType | Тип учетной записи хранения, используемой для хранения общего образа. Не используйте значение по умолчанию (Standard_LRS). | 'Standard_LRS' 'Standard_ZRS' |
ImageTemplateVhdDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "VHD" (обязательно) |
ImageTemplateSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Установка типа объекта | ManagedImage PlatformImage SharedImageVersion (обязательно) |
ImageTemplateManagedImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса ARM управляемого образа в подписке клиента | string (обязательно) |
ImageTemplatePlatformImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | PlatformImage (обязательно) |
| offer | Предложение образов из коллекции образов Azure. | строка |
| planInfo | Необязательная конфигурация плана покупки для образа платформы. | PlatformImagePurchasePlan |
| publisher | Издатель образов в коллекции образов Azure. | строка |
| sku | SKU образа из коллекции образов Azure. | строка |
| version | Версия образа из образов из коллекции Azure. Если здесь указан параметр latest, версия вычисляется при сборке образа, а не при отправке шаблона. | строка |
PlatformImagePurchasePlan
| Имя | Описание | Значение |
|---|---|---|
| planName | Имя плана покупки. | строка (обязательно) |
| planProduct | Продукт плана покупки. | строка (обязательно) |
| planPublisher | Издатель плана покупки. | строка (обязательно) |
ImageTemplateSharedImageVersionSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | SharedImageVersion (обязательно) |
| imageVersionId | Идентификатор ресурса ARM версии образа в общей коллекции образов | строка (обязательно) |
ImageTemplateVmProfile
| Имя | Описание | Значение |
|---|---|---|
| osDiskSizeGB | Размер диска ОС в ГБ. Опустите или укажите значение 0, чтобы использовать размер диска ОС Azure по умолчанию. | INT |
| userAssignedIdentities | Необязательный массив идентификаторов ресурсов управляемых удостоверений, назначаемых пользователем, для настройки на виртуальной машине сборки. Сюда может входить удостоверение шаблона образа. | string[] |
| vmSize | Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (Standard_D2ds_v4). | строка |
| vnetConfig | Необязательная конфигурация виртуальной сети, используемой для развертывания виртуальной машины сборки. Не указывайте, если не требуется использовать определенную виртуальную сеть. | VirtualNetworkConfig |
VirtualNetworkConfig
| Имя | Описание | Значение |
|---|---|---|
| proxyVmSize | Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (Standard_D1_v2 для образов 1-го поколения и Standard_D2ds_v4 для образов 2-го поколения). | строка |
| subnetId | Идентификатор ресурса существующей подсети. | строка |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Конструктор образов Azure с базовыми показателями Azure Windows |
Создает среду Конструктора образов Azure и создает образ Windows Server с применением последних Обновления Windows и базовых показателей Windows Azure. |
| Настройка службы Dev Box |
Этот шаблон создаст все ресурсы администратора Dev Box, как указано в кратком руководстве по началу работы с Dev Box. Вы можете просмотреть все созданные ресурсы или напрямую перейти к DevPortal.microsoft.com, чтобы создать первое поле разработки. |
Определение ресурса шаблона ARM
Тип ресурса imageTemplates можно развернуть в:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.VirtualMachineImages/imageTemplates, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.VirtualMachineImages/imageTemplates",
"apiVersion": "2021-10-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"buildTimeoutInMinutes": "int",
"customize": [
{
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
],
"distribute": [
{
"artifactTags": {},
"runOutputName": "string",
"type": "string"
// For remaining properties, see ImageTemplateDistributor objects
}
],
"source": {
"type": "string"
// For remaining properties, see ImageTemplateSource objects
},
"vmProfile": {
"osDiskSizeGB": "int",
"userAssignedIdentities": [ "string" ],
"vmSize": "string",
"vnetConfig": {
"proxyVmSize": "string",
"subnetId": "string"
}
}
}
}
Объекты ImageTemplateCustomizer
Задайте свойство type , чтобы указать тип объекта .
Для параметра Файл используйте:
"type": "File",
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string"
Для PowerShell используйте:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Для оболочки используйте:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Для WindowsRestart используйте:
"type": "WindowsRestart",
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string"
Для WindowsUpdate используйте:
"type": "WindowsUpdate",
"filters": [ "string" ],
"searchCriteria": "string",
"updateLimit": "int"
Объекты ImageTemplateDistributor
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
"type": "ManagedImage",
"imageId": "string",
"location": "string"
Для SharedImage используйте:
"type": "SharedImage",
"excludeFromLatest": "bool",
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"storageAccountType": "string"
Для виртуального жесткого диска используйте:
"type": "VHD"
Объекты ImageTemplateSource
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
"type": "ManagedImage",
"imageId": "string"
Для PlatformImage используйте:
"type": "PlatformImage",
"offer": "string",
"planInfo": {
"planName": "string",
"planProduct": "string",
"planPublisher": "string"
},
"publisher": "string",
"sku": "string",
"version": "string"
Для SharedImageVersion используйте:
"type": "SharedImageVersion",
"imageVersionId": "string"
Значения свойств
imageTemplates
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.VirtualMachineImages/imageTemplates |
| версия_API | Версия API ресурсов | '2021-10-01' |
| name | имя ресурса. | string (обязательно) |
| location | Географическое расположение, в котором находится ресурс | string (обязательно) |
| tags | Теги ресурсов. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| удостоверение | Удостоверение шаблона образа, если оно настроено. | ImageTemplateIdentity (обязательно) |
| properties | Свойства шаблона изображения | ImageTemplateProperties |
ImageTemplateIdentity
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для шаблона изображения. Тип None приведет к удалению всех удостоверений из шаблона образа. | "Нет" UserAssigned |
| userAssignedIdentities | Список удостоверений пользователей, связанных с шаблоном образа. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | object |
ImageTemplateProperties
| Имя | Описание | Значение |
|---|---|---|
| buildTimeoutInMinutes | Максимальная продолжительность ожидания при создании шаблона образа. Опустите или укажите значение 0, чтобы использовать значение по умолчанию (4 часа). | INT |
| настройка | Указывает свойства, используемые для описания этапов настройки образа, например источник изображения и т. д. | ImageTemplateCustomizer[] |
| распространение | Распределение целевых объектов, к которому должны перейти выходные данные изображения. | ImageTemplateDistributor[] (обязательно) |
| source | Указывает свойства, используемые для описания исходного изображения. | ImageTemplateSource (обязательно) |
| vmProfile | Описание настройки виртуальной машины для создания образов | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| name | Понятное имя для предоставления контекста того, что делает этот шаг настройки | строка |
| type | Установка типа объекта | Файл PowerShell Оболочка WindowsRestart WindowsUpdate (обязательно) |
ImageTemplateFileCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "Файл" (обязательно) |
| ресурс destination | Абсолютный путь к файлу (с уже созданными вложенными структурами каталогов), в который будет отправлен файл (из sourceUri) на виртуальной машине. | строка |
| sha256Checksum | Контрольная сумма SHA256 файла, указанного в поле sourceUri выше | строка |
| sourceUri | Универсальный код ресурса (URI) файла, отправляемого для настройки виртуальной машины. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
ImageTemplatePowerShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | PowerShell (обязательно) |
| inline | Массив команд PowerShell для выполнения | string[] |
| runAsSystem | Если этот параметр указан, сценарий PowerShell будет выполняться с повышенными привилегиями с помощью пользователя Local System. Значение true может быть только в том случае, если для поля runElevated выше задано значение true. | bool |
| runElevated | Если этот параметр указан, сценарий PowerShell будет выполняться с повышенными привилегиями. | bool |
| scriptUri | URI скрипта PowerShell для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| sha256Checksum | Контрольная сумма SHA256 скрипта power shell, указанного в поле scriptUri выше | строка |
| validExitCodes | Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0] | int[] |
ImageTemplateShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "Оболочка" (обязательно) |
| inline | Массив команд оболочки для выполнения | string[] |
| scriptUri | URI скрипта оболочки для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| sha256Checksum | Контрольная сумма SHA256 скрипта оболочки, предоставленного в поле scriptUri | строка |
ImageTemplateRestartCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "WindowsRestart" (обязательно) |
| restartCheckCommand | Команда для проверка при успешном перезапуске [по умолчанию: ''] | строка |
| restartCommand | Команда для выполнения перезапуска [по умолчанию: shutdown /r /f /t 0 /c "packer restart"] | строка |
| restartTimeout | Время ожидания перезапуска, указанное в виде строки величины и единицы измерения, например "5 мин" (5 минут) или "2 ч" (2 часа) [по умолчанию: "5 мин"] | строка |
ImageTemplateWindowsUpdateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | WindowsUpdate (обязательно) |
| filters | Массив фильтров для выбора обновлений для применения. Опустите или укажите пустой массив, чтобы использовать значение по умолчанию (без фильтра). Примеры и подробное описание этого поля см. по ссылке выше. | string[] |
| searchCriteria | Условия для поиска обновлений. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (поиск по всем). Примеры и подробное описание этого поля см. по ссылке выше. | строка |
| updateLimit | Максимальное количество обновлений, применяемых одновременно. Опустить или указать 0, чтобы использовать значение по умолчанию (1000) | INT |
ImageTemplateDistributor
| Имя | Описание | Значение |
|---|---|---|
| artifactTags | Теги, которые будут применены к артефакту после его создания или обновления распространителем. | object |
| runOutputName | Имя, используемое для связанного объекта RunOutput. | string (обязательно) |
| тип | Установка типа объекта | ManagedImage SharedImage VHD (обязательно) |
ImageTemplateManagedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса образа управляемого диска | string (обязательно) |
| location | Расположение образа в Azure должно совпадать, если образ уже существует | string (обязательно) |
ImageTemplateSharedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | SharedImage (обязательно) |
| excludeFromLatest | Флаг, указывающий, следует ли исключить созданную версию образа из последней версии. Не используйте значение по умолчанию (false). | bool |
| galleryImageId | Идентификатор ресурса образа Общая коллекция образов | string (обязательно) |
| replicationRegions | Список регионов, в которые будет реплицирован образ. | string[] (обязательно) |
| storageAccountType | Тип учетной записи хранения, используемой для хранения общего образа. Не используйте значение по умолчанию (Standard_LRS). | 'Standard_LRS' 'Standard_ZRS' |
ImageTemplateVhdDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "VHD" (обязательно) |
ImageTemplateSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Установка типа объекта | ManagedImage PlatformImage SharedImageVersion (обязательно) |
ImageTemplateManagedImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса ARM управляемого образа в подписке клиента | string (обязательно) |
ImageTemplatePlatformImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | PlatformImage (обязательно) |
| offer | Предложение образов из коллекции образов Azure. | строка |
| planInfo | Необязательная конфигурация плана покупки для образа платформы. | PlatformImagePurchasePlan |
| publisher | Издатель образов в коллекции образов Azure. | строка |
| sku | SKU образа из коллекции образов Azure. | строка |
| version | Версия образа из коллекции образов Azure. Если здесь указан параметр latest, версия вычисляется при сборке образа, а не при отправке шаблона. | строка |
PlatformImagePurchasePlan
| Имя | Описание | Значение |
|---|---|---|
| planName | Имя плана покупки. | string (обязательно) |
| planProduct | Продукт плана покупки. | string (обязательно) |
| planPublisher | Издатель плана покупки. | string (обязательно) |
ImageTemplateSharedImageVersionSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | SharedImageVersion (обязательно) |
| imageVersionId | Идентификатор ресурса ARM версии образа в общей коллекции образов | string (обязательно) |
ImageTemplateVmProfile
| Имя | Описание | Значение |
|---|---|---|
| osDiskSizeGB | Размер диска ОС в ГБ. Опустите или укажите значение 0, чтобы использовать размер диска ОС Azure по умолчанию. | INT |
| userAssignedIdentities | Необязательный массив идентификаторов ресурсов управляемых удостоверений, назначаемых пользователем, для настройки на виртуальной машине сборки. Сюда может входить удостоверение шаблона изображения. | string[] |
| vmSize | Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (Standard_D2ds_v4). | строка |
| vnetConfig | Необязательная конфигурация виртуальной сети, используемой для развертывания виртуальной машины сборки. Не указывайте, если не требуется использовать определенную виртуальную сеть. | VirtualNetworkConfig |
VirtualNetworkConfig
| Имя | Описание | Значение |
|---|---|---|
| proxyVmSize | Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (Standard_D1_v2 для образов 1-го поколения и Standard_D2ds_v4 для образов 2-го поколения). | строка |
| subnetId | Идентификатор ресурса существующей подсети. | строка |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Конструктор образов Azure с базовой конфигурацией Azure Windows |
Создает среду Конструктора образов Azure и создает образ Windows Server с применением последних Обновления Windows и базовых показателей Windows Azure. |
| Настройка службы Dev Box |
В этом шаблоне будут созданы все ресурсы администратора Dev Box, как указано в кратком руководстве по началу работы с Dev Box. Вы можете просмотреть все созданные ресурсы или напрямую перейти к DevPortal.microsoft.com, чтобы создать свой первый dev Box. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса imageTemplates можно развернуть в следующих объектах:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.VirtualMachineImages/imageTemplates, добавьте следующую terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2021-10-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
buildTimeoutInMinutes = int
customize = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute = [
{
artifactTags = {}
runOutputName = "string"
type = "string"
// For remaining properties, see ImageTemplateDistributor objects
}
]
source = {
type = "string"
// For remaining properties, see ImageTemplateSource objects
}
vmProfile = {
osDiskSizeGB = int
userAssignedIdentities = [
"string"
]
vmSize = "string"
vnetConfig = {
proxyVmSize = "string"
subnetId = "string"
}
}
}
})
}
Объекты ImageTemplateCustomizer
Задайте свойство type , чтобы указать тип объекта .
Для параметра Файл используйте:
type = "File"
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
Для PowerShell используйте:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Для оболочки используйте:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Для WindowsRestart используйте:
type = "WindowsRestart"
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
Для WindowsUpdate используйте:
type = "WindowsUpdate"
filters = [
"string"
]
searchCriteria = "string"
updateLimit = int
Объекты ImageTemplateDistributor
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
type = "ManagedImage"
imageId = "string"
location = "string"
Для SharedImage используйте:
type = "SharedImage"
excludeFromLatest = bool
galleryImageId = "string"
replicationRegions = [
"string"
]
storageAccountType = "string"
Для виртуального жесткого диска используйте:
type = "VHD"
Объекты ImageTemplateSource
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
type = "ManagedImage"
imageId = "string"
Для PlatformImage используйте:
type = "PlatformImage"
offer = "string"
planInfo = {
planName = "string"
planProduct = "string"
planPublisher = "string"
}
publisher = "string"
sku = "string"
version = "string"
Для SharedImageVersion используйте:
type = "SharedImageVersion"
imageVersionId = "string"
Значения свойств
imageTemplates
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.VirtualMachineImages/imageTemplates@2021-10-01" |
| name | имя ресурса. | string (обязательно) |
| location | Географическое расположение, в котором находится ресурс | string (обязательно) |
| parent_id | Для развертывания в группе ресурсов используйте идентификатор этой группы ресурсов. | string (обязательно) |
| tags | Теги ресурсов. | Словарь имен и значений тегов. |
| удостоверение | Удостоверение шаблона образа, если оно настроено. | ImageTemplateIdentity (обязательно) |
| properties | Свойства шаблона изображения | ImageTemplateProperties |
ImageTemplateIdentity
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для шаблона изображения. Тип None приведет к удалению всех удостоверений из шаблона образа. | UserAssigned |
| identity_ids | Список удостоверений пользователей, связанных с шаблоном образа. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Массив идентификаторов удостоверений пользователей. |
ImageTemplateProperties
| Имя | Описание | Значение |
|---|---|---|
| buildTimeoutInMinutes | Максимальная продолжительность ожидания при создании шаблона образа. Опустите или укажите значение 0, чтобы использовать значение по умолчанию (4 часа). | INT |
| настройка | Указывает свойства, используемые для описания этапов настройки образа, например источник изображения и т. д. | ImageTemplateCustomizer[] |
| распространение | Распределение целевых объектов, к которому должны перейти выходные данные изображения. | ImageTemplateDistributor[] (обязательно) |
| source | Указывает свойства, используемые для описания исходного изображения. | ImageTemplateSource (обязательно) |
| vmProfile | Описание настройки виртуальной машины для создания образов | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| name | Понятное имя для предоставления контекста того, что делает этот шаг настройки | строка |
| type | Установка типа объекта | Файл PowerShell Оболочка WindowsRestart WindowsUpdate (обязательно) |
ImageTemplateFileCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "Файл" (обязательно) |
| ресурс destination | Абсолютный путь к файлу (с уже созданными вложенными структурами каталогов), в который будет отправлен файл (из sourceUri) на виртуальной машине. | строка |
| sha256Checksum | Контрольная сумма SHA256 файла, указанного в поле sourceUri выше | строка |
| sourceUri | Универсальный код ресурса (URI) файла, отправляемого для настройки виртуальной машины. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
ImageTemplatePowerShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "PowerShell" (обязательно) |
| inline | Массив команд PowerShell для выполнения | string[] |
| runAsSystem | Если этот параметр указан, сценарий PowerShell будет выполняться с повышенными привилегиями с помощью пользователя Local System. Значение true может быть только в том случае, если для поля runElevated выше задано значение true. | bool |
| runElevated | Если этот параметр указан, сценарий PowerShell будет выполняться с повышенными привилегиями. | bool |
| scriptUri | URI скрипта PowerShell для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| sha256Checksum | Контрольная сумма SHA256 скрипта power shell, указанного в поле scriptUri выше | строка |
| validExitCodes | Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0] | int[] |
ImageTemplateShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "Оболочка" (обязательно) |
| inline | Массив команд оболочки для выполнения | string[] |
| scriptUri | URI скрипта оболочки для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| sha256Checksum | Контрольная сумма SHA256 скрипта оболочки, предоставленного в поле scriptUri | строка |
ImageTemplateRestartCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "WindowsRestart" (обязательно) |
| restartCheckCommand | Команда для проверка при успешном перезапуске [по умолчанию: ''] | строка |
| restartCommand | Команда для выполнения перезапуска [по умолчанию: shutdown /r /f /t 0 /c "packer restart"] | строка |
| restartTimeout | Время ожидания перезапуска, указанное в виде строки величины и единицы измерения, например "5 мин" (5 минут) или "2 ч" (2 часа) [по умолчанию: "5 мин"] | строка |
ImageTemplateWindowsUpdateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "WindowsUpdate" (обязательно) |
| filters | Массив фильтров для выбора обновлений для применения. Опустите или укажите пустой массив, чтобы использовать значение по умолчанию (без фильтра). Примеры и подробное описание этого поля см. по ссылке выше. | string[] |
| searchCriteria | Условия для поиска обновлений. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (поиск по всем). Примеры и подробное описание этого поля см. по ссылке выше. | строка |
| updateLimit | Максимальное количество обновлений, применяемых одновременно. Опустить или указать 0, чтобы использовать значение по умолчанию (1000) | INT |
ImageTemplateDistributor
| Имя | Описание | Значение |
|---|---|---|
| artifactTags | Теги, которые будут применены к артефакту после его создания или обновления распространителем. | объект |
| runOutputName | Имя, используемое для связанного объекта RunOutput. | string (обязательно) |
| тип | Установка типа объекта | ManagedImage SharedImage VHD (обязательно) |
ImageTemplateManagedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "ManagedImage" (обязательно) |
| imageId | Идентификатор ресурса образа управляемого диска | string (обязательно) |
| location | Расположение образа в Azure должно совпадать, если образ уже существует | string (обязательно) |
ImageTemplateSharedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "SharedImage" (обязательно) |
| excludeFromLatest | Флаг, указывающий, следует ли исключить созданную версию образа из последней версии. Не используйте значение по умолчанию (false). | bool |
| galleryImageId | Идентификатор ресурса образа Общая коллекция образов | string (обязательно) |
| replicationRegions | Список регионов, в которые будет реплицирован образ. | string[] (обязательно) |
| storageAccountType | Тип учетной записи хранения, используемой для хранения общего образа. Не используйте значение по умолчанию (Standard_LRS). | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "VHD" (обязательно) |
ImageTemplateSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Установка типа объекта | ManagedImage PlatformImage SharedImageVersion (обязательно) |
ImageTemplateManagedImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса ARM управляемого образа в подписке клиента | строка (обязательно) |
ImageTemplatePlatformImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | PlatformImage (обязательно) |
| offer | Предложение образов из коллекции образов Azure. | строка |
| planInfo | Необязательная конфигурация плана покупки для образа платформы. | PlatformImagePurchasePlan |
| publisher | Издатель образов в образе из коллекции Azure. | строка |
| sku | SKU образа из коллекции образов Azure. | строка |
| version | Версия образа из образов из коллекции Azure. Если здесь указан параметр latest, версия вычисляется при сборке образа, а не при отправке шаблона. | строка |
PlatformImagePurchasePlan
| Имя | Описание | Значение |
|---|---|---|
| planName | Имя плана покупки. | строка (обязательно) |
| planProduct | Продукт плана покупки. | строка (обязательно) |
| planPublisher | Издатель плана покупки. | строка (обязательно) |
ImageTemplateSharedImageVersionSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | "SharedImageVersion" (обязательно) |
| imageVersionId | Идентификатор ресурса ARM версии образа в общей коллекции образов | строка (обязательно) |
ImageTemplateVmProfile
| Имя | Описание | Значение |
|---|---|---|
| osDiskSizeGB | Размер диска ОС в ГБ. Опустите или укажите значение 0, чтобы использовать размер диска ОС Azure по умолчанию. | INT |
| userAssignedIdentities | Необязательный массив идентификаторов ресурсов управляемых удостоверений, назначаемых пользователем, для настройки на виртуальной машине сборки. Сюда может входить удостоверение шаблона образа. | string[] |
| vmSize | Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (Standard_D2ds_v4). | строка |
| vnetConfig | Необязательная конфигурация виртуальной сети, используемой для развертывания виртуальной машины сборки. Не указывайте, если не требуется использовать определенную виртуальную сеть. | VirtualNetworkConfig |
VirtualNetworkConfig
| Имя | Описание | Значение |
|---|---|---|
| proxyVmSize | Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (Standard_D1_v2 для образов 1-го поколения и Standard_D2ds_v4 для образов 2-го поколения). | строка |
| subnetId | Идентификатор ресурса существующей подсети. | строка |
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по