Microsoft.VirtualMachineImages imageTemplates 2019-02-01-preview
Определение ресурса Bicep
Тип ресурса imageTemplates можно развернуть в:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.VirtualMachineImages/imageTemplates, добавьте в шаблон следующий код Bicep.
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
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
}
}
}
Объекты ImageTemplateCustomizer
Задайте свойство type , чтобы указать тип объекта .
Для PowerShell используйте:
type: 'PowerShell'
inline: [
'string'
]
script: 'string'
validExitCodes: [
int
]
Для оболочки используйте:
type: 'Shell'
inline: [
'string'
]
script: 'string'
Для WindowsRestart используйте:
type: 'WindowsRestart'
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
Объекты ImageTemplateDistributor
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
type: 'ManagedImage'
imageId: 'string'
location: 'string'
Для SharedImage используйте:
type: 'SharedImage'
galleryImageId: 'string'
replicationRegions: [
'string'
]
Для виртуального жесткого диска используйте:
type: 'VHD'
Объекты ImageTemplateSource
Задайте свойство type , чтобы указать тип объекта .
Для ISO используйте:
type: 'ISO'
sha256Checksum: 'string'
sourceURI: 'string'
Для ManagedImage используйте:
type: 'ManagedImage'
imageId: 'string'
Для PlatformImage используйте:
type: 'PlatformImage'
offer: 'string'
publisher: 'string'
sku: 'string'
version: 'string'
Значения свойств
imageTemplates
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. | строка (обязательно) |
| location | Расположение ресурса | строка (обязательно) |
| tags | Теги ресурсов | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| properties | ImageTemplateProperties |
ImageTemplateProperties
| Имя | Описание | Значение |
|---|---|---|
| настройка | Указывает свойства, используемые для описания этапов настройки изображения, например источник изображения и т. д. | ImageTemplateCustomizer[] |
| распространение | Целевые объекты распределения, в которые должны перейти выходные данные изображения. | ImageTemplateDistributor[] (обязательно) |
| source | Указывает свойства, используемые для описания исходного образа. | ImageTemplateSource (обязательно) |
ImageTemplateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| name | Понятное имя для предоставления контекста о том, что делает этот шаг настройки | строка |
| type | Установка типа объекта | PowerShell Оболочка WindowsRestart (обязательно) |
ImageTemplatePowerShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | PowerShell (обязательно) |
| inline | Массив команд PowerShell для выполнения | string[] |
| скрипт | Скрипт PowerShell для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| validExitCodes | Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0] | int[] |
ImageTemplateShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | "Оболочка" (обязательно) |
| inline | Массив команд оболочки для выполнения | string[] |
| скрипт | Скрипт оболочки, выполняемый для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
ImageTemplateRestartCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки | "WindowsRestart" (обязательно) |
| restartCheckCommand | Команда для проверка при успешном перезапуске [по умолчанию: ''] | строка |
| restartCommand | Команда для выполнения перезапуска [по умолчанию: shutdown /r /f /t 0 /c "packer restart"] | строка |
| restartTimeout | Время ожидания перезапуска, указанное в виде строки величины и единицы измерения, например "5 мин" (5 минут) или "2 ч" (2 часа) [по умолчанию: "5 мин"] | строка |
ImageTemplateDistributor
| Имя | Описание | Значение |
|---|---|---|
| artifactTags | Теги, которые будут применены к артефакту после его создания или обновления распространителем. | object |
| runOutputName | Имя, используемое для связанного объекта RunOutput. | string (обязательно) |
| тип | Установка типа объекта | ManagedImage SharedImage VHD (обязательно) |
ImageTemplateManagedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса образа управляемого диска | string (обязательно) |
| location | Расположение образа в Azure должно совпадать, если образ уже существует | string (обязательно) |
ImageTemplateSharedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | SharedImage (обязательно) |
| galleryImageId | Идентификатор ресурса образа Общая коллекция образов | string (обязательно) |
| replicationRegions | string[] (обязательно) |
ImageTemplateVhdDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "VHD" (обязательно) |
ImageTemplateSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Установка типа объекта | ISO ManagedImage PlatformImage (обязательно) |
ImageTemplateIsoSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | "ISO" (обязательно) |
| sha256Checksum | Контрольная сумма SHA256 iso-образа. | string (обязательно) |
| sourceURI | URI для получения ISO-образа. Этот универсальный код ресурса должен быть доступен поставщику ресурсов во время создания шаблона образа. | string (обязательно) |
ImageTemplateManagedImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса ARM управляемого образа в подписке клиента | string (обязательно) |
ImageTemplatePlatformImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | PlatformImage (обязательно) |
| offer | Предложение образов из коллекции образов Azure. | строка |
| publisher | Издатель образов в коллекции образов Azure. | строка |
| sku | SKU образа из коллекции образов Azure. | строка |
| version | Версия образа из коллекции образов Azure. | строка |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Конструктор образов Azure с базовой конфигурацией Azure Windows |
Создает среду Конструктора образов Azure и создает образ Windows Server с применением последних Обновления Windows и базовых показателей Windows Azure. |
| Настройка службы Dev Box |
В этом шаблоне будут созданы все ресурсы администратора Dev Box, как указано в кратком руководстве по началу работы с Dev Box. Вы можете просмотреть все созданные ресурсы или напрямую перейти к DevPortal.microsoft.com, чтобы создать свой первый dev Box. |
Определение ресурса шаблона ARM
Тип ресурса imageTemplates можно развернуть в следующих объектах:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.VirtualMachineImages/imageTemplates, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.VirtualMachineImages/imageTemplates",
"apiVersion": "2019-02-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"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
}
}
}
Объекты ImageTemplateCustomizer
Задайте свойство type , чтобы указать тип объекта .
Для PowerShell используйте:
"type": "PowerShell",
"inline": [ "string" ],
"script": "string",
"validExitCodes": [ "int" ]
Для оболочки используйте:
"type": "Shell",
"inline": [ "string" ],
"script": "string"
Для WindowsRestart используйте:
"type": "WindowsRestart",
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string"
Объекты ImageTemplateDistributor
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
"type": "ManagedImage",
"imageId": "string",
"location": "string"
Для SharedImage используйте:
"type": "SharedImage",
"galleryImageId": "string",
"replicationRegions": [ "string" ]
Для виртуального жесткого диска используйте:
"type": "VHD"
Объекты ImageTemplateSource
Задайте свойство type , чтобы указать тип объекта .
Для ISO используйте:
"type": "ISO",
"sha256Checksum": "string",
"sourceURI": "string"
Для ManagedImage используйте:
"type": "ManagedImage",
"imageId": "string"
Для PlatformImage используйте:
"type": "PlatformImage",
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string"
Значения свойств
imageTemplates
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.VirtualMachineImages/imageTemplates |
| версия_API | Версия API ресурсов | '2019-02-01-preview' |
| name | имя ресурса. | string (обязательно) |
| location | Расположение ресурса | string (обязательно) |
| tags | Теги ресурсов | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| properties | ImageTemplateProperties |
ImageTemplateProperties
| Имя | Описание | Значение |
|---|---|---|
| настройка | Указывает свойства, используемые для описания этапов настройки образа, например источник изображения и т. д. | ImageTemplateCustomizer[] |
| распространение | Распределение целевых объектов, к которому должны перейти выходные данные изображения. | ImageTemplateDistributor[] (обязательно) |
| source | Указывает свойства, используемые для описания исходного изображения. | ImageTemplateSource (обязательно) |
ImageTemplateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| name | Понятное имя для предоставления контекста того, что делает этот шаг настройки | строка |
| type | Установка типа объекта | PowerShell Оболочка WindowsRestart (обязательно) |
ImageTemplatePowerShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | PowerShell (обязательно) |
| inline | Массив команд PowerShell для выполнения | string[] |
| скрипт | Скрипт PowerShell для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| validExitCodes | Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0] | int[] |
ImageTemplateShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | Оболочка (обязательно) |
| inline | Массив команд оболочки для выполнения | string[] |
| скрипт | Скрипт оболочки для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
ImageTemplateRestartCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | "WindowsRestart" (обязательно) |
| restartCheckCommand | Команда для проверка успешного перезапуска [по умолчанию: ''] | строка |
| restartCommand | Команда для выполнения перезапуска [по умолчанию: shutdown /r /f /t 0 /c "packer restart"] | строка |
| restartTimeout | Время ожидания перезапуска, указанное в виде строки величины и единицы измерения, например "5 мин" (5 минут) или "2 ч" (2 часа) [по умолчанию: "5 мин"] | строка |
ImageTemplateDistributor
| Имя | Описание | Значение |
|---|---|---|
| artifactTags | Теги, которые будут применены к артефакту после его создания или обновления распространителем. | object |
| runOutputName | Имя, используемое для связанного RunOutput. | строка (обязательно) |
| тип | Установка типа объекта | ManagedImage SharedImage VHD (обязательно) |
ImageTemplateManagedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса образа управляемого диска | строка (обязательно) |
| location | Расположение azure для образа должно совпадать, если образ уже существует | строка (обязательно) |
ImageTemplateSharedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | SharedImage (обязательно) |
| galleryImageId | Идентификатор ресурса Общая коллекция образов образа | строка (обязательно) |
| replicationRegions | string[] (обязательно) |
ImageTemplateVhdDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "VHD" (обязательно) |
ImageTemplateSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Установка типа объекта | ISO ManagedImage PlatformImage (обязательно) |
ImageTemplateIsoSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | "ISO" (обязательно) |
| sha256Checksum | Контрольная сумма SHA256 iso-образа. | string (обязательно) |
| sourceURI | URI для получения ISO-образа. Этот универсальный код ресурса должен быть доступен поставщику ресурсов во время создания шаблона образа. | string (обязательно) |
ImageTemplateManagedImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | ManagedImage (обязательно) |
| imageId | Идентификатор ресурса ARM управляемого образа в подписке клиента | string (обязательно) |
ImageTemplatePlatformImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | PlatformImage (обязательно) |
| offer | Предложение образов из коллекции образов Azure. | строка |
| publisher | Издатель образов в коллекции образов Azure. | строка |
| sku | SKU образа из коллекции образов Azure. | строка |
| version | Версия образа из коллекции образов Azure. | строка |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Конструктор образов 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@2019-02-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
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
}
}
})
}
Объекты ImageTemplateCustomizer
Задайте свойство type , чтобы указать тип объекта .
Для PowerShell используйте:
type = "PowerShell"
inline = [
"string"
]
script = "string"
validExitCodes = [
int
]
Для оболочки используйте:
type = "Shell"
inline = [
"string"
]
script = "string"
Для WindowsRestart используйте:
type = "WindowsRestart"
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
Объекты ImageTemplateDistributor
Задайте свойство type , чтобы указать тип объекта .
Для ManagedImage используйте:
type = "ManagedImage"
imageId = "string"
location = "string"
Для SharedImage используйте:
type = "SharedImage"
galleryImageId = "string"
replicationRegions = [
"string"
]
Для виртуального жесткого диска используйте:
type = "VHD"
Объекты ImageTemplateSource
Задайте свойство type , чтобы указать тип объекта .
Для ISO используйте:
type = "ISO"
sha256Checksum = "string"
sourceURI = "string"
Для ManagedImage используйте:
type = "ManagedImage"
imageId = "string"
Для PlatformImage используйте:
type = "PlatformImage"
offer = "string"
publisher = "string"
sku = "string"
version = "string"
Значения свойств
imageTemplates
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview" |
| name | имя ресурса. | string (обязательно) |
| location | Расположение ресурса | string (обязательно) |
| parent_id | Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. | строка (обязательно) |
| tags | Теги ресурсов | Словарь имен и значений тегов. |
| properties | ImageTemplateProperties |
ImageTemplateProperties
| Имя | Описание | Значение |
|---|---|---|
| настройка | Указывает свойства, используемые для описания этапов настройки изображения, например источник изображения и т. д. | ImageTemplateCustomizer[] |
| распространение | Целевые объекты распределения, в которые должны перейти выходные данные изображения. | ImageTemplateDistributor[] (обязательно) |
| source | Указывает свойства, используемые для описания исходного образа. | ImageTemplateSource (обязательно) |
ImageTemplateCustomizer
| Имя | Описание | Значение |
|---|---|---|
| name | Понятное имя для предоставления контекста о том, что делает этот шаг настройки | строка |
| type | Установка типа объекта | PowerShell Оболочка WindowsRestart (обязательно) |
ImageTemplatePowerShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | "PowerShell" (обязательно) |
| inline | Массив команд PowerShell для выполнения | string[] |
| скрипт | Скрипт PowerShell для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
| validExitCodes | Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0] | int[] |
ImageTemplateShellCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | "Оболочка" (обязательно) |
| inline | Массив команд оболочки для выполнения | string[] |
| скрипт | Скрипт оболочки для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д. | строка |
ImageTemplateRestartCustomizer
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки. | "WindowsRestart" (обязательно) |
| restartCheckCommand | Команда для проверка успешного перезапуска [по умолчанию: ''] | строка |
| restartCommand | Команда для выполнения перезапуска [по умолчанию: shutdown /r /f /t 0 /c "packer restart"] | строка |
| restartTimeout | Время ожидания перезапуска, указанное в виде строки величины и единицы измерения, например "5 мин" (5 минут) или "2 ч" (2 часа) [по умолчанию: "5 мин"] | строка |
ImageTemplateDistributor
| Имя | Описание | Значение |
|---|---|---|
| artifactTags | Теги, которые будут применены к артефакту после его создания или обновления распространителем. | объект |
| runOutputName | Имя, используемое для связанного RunOutput. | строка (обязательно) |
| тип | Установка типа объекта | ManagedImage SharedImage VHD (обязательно) |
ImageTemplateManagedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "ManagedImage" (обязательно) |
| imageId | Идентификатор ресурса образа управляемого диска | string (обязательно) |
| location | Расположение образа в Azure должно совпадать, если образ уже существует | string (обязательно) |
ImageTemplateSharedImageDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "SharedImage" (обязательно) |
| galleryImageId | Идентификатор ресурса образа Общая коллекция образов | string (обязательно) |
| replicationRegions | string[] (обязательно) |
ImageTemplateVhdDistributor
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип распределения. | "VHD" (обязательно) |
ImageTemplateSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Установка типа объекта | ISO ManagedImage PlatformImage (обязательно) |
ImageTemplateIsoSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | "ISO" (обязательно) |
| sha256Checksum | Контрольная сумма SHA256 iso-образа. | string (обязательно) |
| sourceURI | URI для получения ISO-образа. Этот универсальный код ресурса должен быть доступен поставщику ресурсов во время создания шаблона образа. | string (обязательно) |
ImageTemplateManagedImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | "ManagedImage" (обязательно) |
| imageId | Идентификатор ресурса ARM управляемого образа в подписке клиента | string (обязательно) |
ImageTemplatePlatformImageSource
| Имя | Описание | Значение |
|---|---|---|
| тип | Указывает тип исходного образа, с которого вы хотите начать. | "PlatformImage" (обязательно) |
| offer | Предложение образов из коллекции образов Azure. | строка |
| publisher | Издатель образов в коллекции образов Azure. | строка |
| sku | SKU образа из коллекции образов Azure. | строка |
| version | Версия образа из коллекции образов Azure. | строка |
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по