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


Virtual Machine Image Templates - Get

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

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

Параметры URI

Имя В Обязательно Тип Описание
imageTemplateName
path True

string

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

Шаблон регулярного выражения: ^[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.

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

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

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

{
  "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). Соответствует упаковщику подготовки файлов

ImageTemplateIdentity

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

ImageTemplateLastRunStatus

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

ImageTemplateManagedImageDistributor

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

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

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

ImageTemplatePowerShellCustomizer

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

ImageTemplatePowerShellValidator

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

ImageTemplateRestartCustomizer

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

ImageTemplateSharedImageDistributor

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

ImageTemplateSharedImageVersionSource

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

ImageTemplateShellCustomizer

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

ImageTemplateShellValidator

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

ImageTemplateVhdDistributor

Распространение через виртуальный жесткий диск в учетной записи хранения.

ImageTemplateVmProfile

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

ImageTemplateWindowsUpdateCustomizer

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

Optimize

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

PlatformImagePurchasePlan

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

ProvisioningError

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

ProvisioningErrorCode

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

ProvisioningState

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

ResourceIdentityType

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

RunState

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

RunSubState

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

SharedImageStorageAccountType

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

systemData

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

TargetRegion

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

UserAssignedIdentity

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

Validate

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

VirtualNetworkConfig

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

VmBoot

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

VMBootOptimizationState

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

CloudError

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

Имя Тип Описание
error

CloudErrorBody

Сведения об ошибке.

CloudErrorBody

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

Имя Тип Описание
code

string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.

details

CloudErrorBody[]

Список дополнительных сведений об ошибке.

message

string

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

target

string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

createdByType

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

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

DistributeVersionerLatest

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

Имя Тип Default value Описание
major

integer

-1

Основная версия для созданного номера версии. Определите , что является "последней" на основе версий с этим значением в качестве основной версии. Значение -1 эквивалентно оставлению его ненастроенным.

scheme string:

Latest

Используемая схема нумеровки версий.

DistributeVersionerSource

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

Имя Тип Описание
scheme string:

Source

Используемая схема нумеровки версий.

ImageTemplate

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

Имя Тип Default value Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ImageTemplateIdentity

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

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties.buildTimeoutInMinutes

integer

0

Максимальная продолжительность ожидания при создании шаблона образа (включает все настройки, оптимизацию, проверки и дистрибутивы). Опустите или укажите значение 0, чтобы использовать значение по умолчанию (4 часа).

properties.customize ImageTemplateCustomizer[]:

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

properties.distribute ImageTemplateDistributor[]:

Распределение целевых объектов, к которому должны перейти выходные данные изображения.

properties.exactStagingResourceGroup

string

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

properties.lastRunStatus

ImageTemplateLastRunStatus

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

properties.optimize

Optimize

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

properties.provisioningError

ProvisioningError

Ошибка подготовки, если она есть

properties.provisioningState

ProvisioningState

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

properties.source ImageTemplateSource:

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

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

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

Имя Тип Описание
destination

string

Абсолютный путь к файлу (с уже созданными вложенными структурами каталогов), в который будет отправлен файл (из sourceUri) на виртуальной машине.

name

string

Понятное имя для предоставления контекста того, что делает этот шаг настройки

sha256Checksum

string

Контрольная сумма SHA256 файла, указанного в поле sourceUri выше

sourceUri

string

Универсальный код ресурса (URI) файла, отправляемого для настройки виртуальной машины. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д.

type string:

File

Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки

ImageTemplateFileValidator

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

Имя Тип Описание
destination

string

Абсолютный путь к файлу (с уже созданными вложенными структурами каталогов), в который будет отправлен файл (из sourceUri) на виртуальной машине.

name

string

Понятное имя для предоставления контекста для выполнения этого шага проверки

sha256Checksum

string

Контрольная сумма SHA256 для файла, указанного в приведенном выше поле sourceUri

sourceUri

string

Универсальный код ресурса (URI) файла, передаваемого на виртуальную машину для проверки. Это может быть ссылка на GitHub, универсальный код ресурса (URI) службы хранилища Azure (авторизованный или SAS) и т. д.

type string:

File

Тип проверки, который вы хотите использовать в образе. Например, "Оболочка" может быть проверкой оболочки

ImageTemplateIdentity

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

Имя Тип Описание
type

ResourceIdentityType

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

userAssignedIdentities

<string,  UserAssignedIdentity>

Удостоверения User-Assigned
Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут иметь идентификаторы ресурсов ARM в формате :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ImageTemplateLastRunStatus

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

Имя Тип Описание
endTime

string

Время окончания последнего выполнения (UTC)

message

string

Подробные сведения о состоянии последнего выполнения

runState

RunState

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

runSubState

RunSubState

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

startTime

string

Время начала последнего выполнения (UTC)

ImageTemplateManagedImageDistributor

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

Имя Тип Описание
artifactTags

object

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

imageId

string

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

location

string

Расположение образа в Azure должно совпадать, если образ уже существует

runOutputName

string

Имя, используемое для связанного объекта RunOutput.

type string:

ManagedImage

Тип распределения.

ImageTemplateManagedImageSource

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

Имя Тип Описание
imageId

string

Идентификатор ресурса ARM управляемого образа в подписке клиента

type string:

ManagedImage

Указывает тип исходного образа, с которого вы хотите начать.

ImageTemplatePlatformImageSource

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

Имя Тип Описание
exactVersion

string

Версия образа из коллекции образов Azure. Это поле только для чтения отличается от "version" только в том случае, если в поле "версия" указано значение "latest".

offer

string

Предложение образов из коллекции образов Azure.

planInfo

PlatformImagePurchasePlan

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

publisher

string

Издатель образов в коллекции образов Azure.

sku

string

SKU образа из коллекции образов Azure.

type string:

PlatformImage

Указывает тип исходного образа, с которого вы хотите начать.

version

string

Версия образа из коллекции образов Azure. Если здесь указан параметр latest, версия вычисляется при сборке образа, а не при отправке шаблона.

ImageTemplatePowerShellCustomizer

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

Имя Тип Default value Описание
inline

string[]

Массив команд PowerShell для выполнения

name

string

Понятное имя для предоставления контекста того, что делает этот шаг настройки

runAsSystem

boolean

False

Если этот параметр указан, сценарий PowerShell будет выполняться с повышенными привилегиями с помощью пользователя Local System. Значение 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[]

Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0]

ImageTemplatePowerShellValidator

Выполняет указанный скрипт PowerShell на этапе проверки (Windows). Соответствует packer powershell provisioner. Можно указать только один из "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

Тип проверки, который вы хотите использовать в образе. Например, "Оболочка" может быть проверкой оболочки

validExitCodes

integer[]

Допустимые коды выхода для скрипта PowerShell. [По умолчанию: 0]

ImageTemplateRestartCustomizer

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

Имя Тип Описание
name

string

Понятное имя для предоставления контекста того, что делает этот шаг настройки

restartCheckCommand

string

Команда для проверка при успешном перезапуске [по умолчанию: '']

restartCommand

string

Команда для выполнения перезапуска [по умолчанию: shutdown /r /f /t 0 /c "packer restart"]

restartTimeout

string

Время ожидания перезапуска, указанное в виде строки величины и единицы измерения, например "5 мин" (5 минут) или "2 ч" (2 часа) [по умолчанию: "5 мин"]

type string:

WindowsRestart

Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки

ImageTemplateSharedImageDistributor

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

Имя Тип Default value Описание
artifactTags

object

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

excludeFromLatest

boolean

False

Флаг, указывающий, следует ли исключить созданную версию образа из последней версии. Не используйте значение по умолчанию (false).

galleryImageId

string

Идентификатор ресурса образа коллекции вычислений Azure

replicationRegions

string[]

[Не рекомендуется] Список регионов, в которые будет реплицирован образ. Этот список можно указать, только если не указан параметр targetRegions. Это поле является нерекомендуемой. Вместо него используйте targetRegions.

runOutputName

string

Имя, используемое для связанного объекта RunOutput.

storageAccountType

SharedImageStorageAccountType

[Не рекомендуется] Тип учетной записи хранения, используемой для хранения общего образа. Не используйте значение по умолчанию (Standard_LRS). Это поле можно указать, только если указан параметр replicationRegions. Это поле является нерекомендуемой. Вместо него используйте targetRegions.

targetRegions

TargetRegion[]

Целевые регионы, в которые будет реплицирована распределенная версия образа. Этот объект заменяет replicationRegions и может быть указан только в том случае, если replicationRegions не указан.

type string:

SharedImage

Тип распределения.

versioning DistributeVersioner:

Описывает, как создать новый номер версии x.y.z для распространения.

ImageTemplateSharedImageVersionSource

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

Имя Тип Описание
exactVersion

string

Точный идентификатор ресурса ARM версии образа. Это поле только для чтения отличается от идентификатора версии образа в imageVersionId только в том случае, если в поле imageVersionId указано имя версии latest.

imageVersionId

string

Идентификатор ресурса ARM версии образа. Если имя версии образа — latest, версия вычисляется при сборке образа.

type string:

SharedImageVersion

Указывает тип исходного образа, с которого вы хотите начать.

ImageTemplateShellCustomizer

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

Имя Тип Описание
inline

string[]

Массив команд оболочки для выполнения

name

string

Понятное имя для предоставления контекста того, что делает этот шаг настройки

scriptUri

string

URI скрипта оболочки для настройки. Это может быть ссылка на GitHub, URI SAS для службы хранилища Azure и т. д.

sha256Checksum

string

Контрольная сумма SHA256 скрипта оболочки, предоставленного в поле scriptUri

type string:

Shell

Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки

ImageTemplateShellValidator

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

Имя Тип Описание
inline

string[]

Массив команд оболочки для выполнения

name

string

Понятное имя для предоставления контекста для выполнения этого шага проверки

scriptUri

string

Универсальный код ресурса (URI) скрипта оболочки, выполняемого для проверки. Это может быть ссылка на GitHub, URI службы хранилища Azure и т. д.

sha256Checksum

string

Контрольная сумма SHA256 для скрипта оболочки, предоставленного в поле scriptUri

type string:

Shell

Тип проверки, который вы хотите использовать в образе. Например, "Оболочка" может быть проверкой оболочки

ImageTemplateVhdDistributor

Распространение через виртуальный жесткий диск в учетной записи хранения.

Имя Тип Описание
artifactTags

object

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

runOutputName

string

Имя, используемое для связанного объекта RunOutput.

type string:

VHD

Тип распределения.

uri

string

Необязательный URI службы хранилища Azure для распределенного большого двоичного объекта VHD. Не используйте значение по умолчанию (пустая строка), в котором виртуальный жесткий диск будет опубликован в учетной записи хранения в промежуточной группе ресурсов.

ImageTemplateVmProfile

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

Имя Тип Default value Описание
osDiskSizeGB

integer

0

Размер диска ОС в ГБ. Опустите или укажите значение 0, чтобы использовать размер диска ОС Azure по умолчанию.

userAssignedIdentities

string[]

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

vmSize

string

Размер виртуальной машины, используемой для создания, настройки и записи образов. Опустите или укажите пустую строку, чтобы использовать значение по умолчанию (Standard_D1_v2 для образов 1-го поколения и Standard_D2ds_v4 для образов 2-го поколения).

vnetConfig

VirtualNetworkConfig

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

ImageTemplateWindowsUpdateCustomizer

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

Имя Тип Default value Описание
filters

string[]

Массив фильтров для выбора обновлений для применения. Опустите или укажите пустой массив, чтобы использовать значение по умолчанию (без фильтра). Примеры и подробное описание этого поля см. по ссылке выше.

name

string

Понятное имя для предоставления контекста того, что делает этот шаг настройки

searchCriteria

string

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

type string:

WindowsUpdate

Тип средства настройки, которое вы хотите использовать в образе. Например, "Оболочка" может быть настройщиком оболочки

updateLimit

integer

0

Максимальное количество обновлений, применяемых одновременно. Опустить или указать 0, чтобы использовать значение по умолчанию (1000)

Optimize

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

Имя Тип Описание
vmBoot

VmBoot

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

PlatformImagePurchasePlan

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

Имя Тип Описание
planName

string

Имя плана покупки.

planProduct

string

Продукт плана покупки.

planPublisher

string

Издатель плана покупки.

ProvisioningError

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

Имя Тип Описание
message

string

Подробное сообщение об ошибке о сбое подготовки

provisioningErrorCode

ProvisioningErrorCode

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

ProvisioningErrorCode

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

Имя Тип Описание
BadCustomizerType

string

BadDistributeType

string

BadManagedImageSource

string

BadPIRSource

string

BadSharedImageDistribute

string

BadSharedImageVersionSource

string

BadSourceType

string

BadStagingResourceGroup

string

BadValidatorType

string

NoCustomizerScript

string

NoValidatorScript

string

Other

string

ServerError

string

UnsupportedCustomizerType

string

UnsupportedValidatorType

string

ProvisioningState

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

Имя Тип Описание
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

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

Имя Тип Описание
None

string

UserAssigned

string

RunState

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

Имя Тип Описание
Canceled

string

Canceling

string

Failed

string

PartiallySucceeded

string

Running

string

Succeeded

string

RunSubState

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

Имя Тип Описание
Building

string

Customizing

string

Distributing

string

Optimizing

string

Queued

string

Validating

string

SharedImageStorageAccountType

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

Имя Тип Описание
Premium_LRS

string

Standard_LRS

string

Standard_ZRS

string

systemData

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

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

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

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

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

lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.

TargetRegion

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

Имя Тип Default value Описание
name

string

Имя области.

replicaCount

integer

1

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

storageAccountType

SharedImageStorageAccountType

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

UserAssignedIdentity

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

Имя Тип Описание
clientId

string

Идентификатор клиента назначенного удостоверения.

principalId

string

Идентификатор субъекта назначенного удостоверения.

Validate

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

Имя Тип Default value Описание
continueDistributeOnFailure

boolean

False

Если проверка завершается ошибкой и для этого поля задано значение false, выходные изображения не будут распространяться. Это поведение по умолчанию. Если проверка завершается ошибкой и для этого поля задано значение true, выходные образы по-прежнему будут распространяться. Используйте этот параметр с осторожностью, так как это может привести к распространению плохих образов для использования. В любом случае (true или false) сквозное выполнение образа будет считаться неудачным в случае сбоя проверки. [Примечание. Это поле не оказывает влияния, если проверка выполнена успешно.]

inVMValidations ImageTemplateInVMValidator[]:

Список проверок, которые необходимо выполнить.

sourceValidationOnly

boolean

False

Если для этого поля задано значение true, образ, указанный в разделе source, будет проверяться напрямую. Для создания и проверки настроенного образа отдельная сборка выполняться не будет.

VirtualNetworkConfig

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

Имя Тип Описание
proxyVmSize

string

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

subnetId

string

Идентификатор ресурса существующей подсети.

VmBoot

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

Имя Тип Описание
state

VMBootOptimizationState

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

VMBootOptimizationState

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

Имя Тип Описание
Disabled

string

Enabled

string