Microsoft.VirtualMachineImages (stable:2023-07-01)

2025/09/26 • 15 new, 15 deleted methods

VirtualMachineImageTemplates_List (new)
Description :  Gets information about the VM image templates associated with the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VirtualMachineImages/imageTemplates
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of image templates ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_ListByResourceGroup (new)
Description :  Gets information about the VM image templates associated with the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of image templates ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_CreateOrUpdate (new)
Description :  Create or update a virtual machine image template
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
{
parameters:
{
Description: Parameters supplied to the CreateImageTemplate operation ,
Required: True ,
}
{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Update (new)
Description :  Update the tags for this Virtual Machine Image Template
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
{
parameters:
{
Description: Additional parameters for Image Template update. ,
Required: True ,
}
{
identity:
{
Description: The identity of the image template, if configured. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: The user-specified tags associated with the image template. ,
Required: False ,
}
object ,
properties:
{
Description: Parameters for updating an image template. ,
Required: False ,
}
{
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: False ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Get (new)
Description :  Get information about a virtual machine image template
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Delete (new)
Description :  Delete a virtual machine image template
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Run (new)
Description :  Create artifacts from a existing image template
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/run
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Cancel (new)
Description :  Cancel the long running image build based on the image template
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/cancel
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_ListRunOutputs (new)
Description :  List all run outputs for the specified Image Template resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of run outputs ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the run output ,
Required: False ,
}
{
artifactId:
{
Description: The resource id of the artifact. ,
Required: False ,
}
string ,
artifactUri:
{
Description: The location URI of the artifact. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_GetRunOutput (new)
Description :  Get the specified run output for the specified image template resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs/{runOutputName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name of the run output ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the run output ,
Required: False ,
}
{
artifactId:
{
Description: The resource id of the artifact. ,
Required: False ,
}
string ,
artifactUri:
{
Description: The location URI of the artifact. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Triggers_ListByImageTemplate (new)
Description :  List all triggers for the specified Image Template resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of triggers ,
Required: True ,
}
[
{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Triggers_Get (new)
Description :  Get the specified trigger for the specified image template resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Triggers_CreateOrUpdate (new)
Description :  Create or update a trigger for the specified virtual machine image template
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}
{
parameters:
{
Description: Parameters supplied to the CreateTrigger operation ,
Required: True ,
}
{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Triggers_Delete (new)
Description :  Delete a trigger for the specified virtual machine image template
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists available operations for the Microsoft.VirtualMachineImages provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.VirtualMachineImages/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Description: This is of the format {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
operation:
{
Description: For example: read, write, delete, or listKeys/action ,
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
object ,
isDataAction:
{
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_List (removed)
Description :  Gets information about the VM image templates associated with the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VirtualMachineImages/imageTemplates
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of image templates ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_ListByResourceGroup (removed)
Description :  Gets information about the VM image templates associated with the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of image templates ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_CreateOrUpdate (removed)
Description :  Create or update a virtual machine image template
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
{
parameters:
{
Description: Parameters supplied to the CreateImageTemplate operation ,
Required: True ,
}
{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Update (removed)
Description :  Update the tags for this Virtual Machine Image Template
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
{
parameters:
{
Description: Additional parameters for Image Template update. ,
Required: True ,
}
{
identity:
{
Description: The identity of the image template, if configured. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: The user-specified tags associated with the image template. ,
Required: False ,
}
object ,
properties:
{
Description: Parameters for updating an image template. ,
Required: False ,
}
{
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: False ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Get (removed)
Description :  Get information about a virtual machine image template
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the image template ,
Required: False ,
}
{
source:
{
Description: Specifies the properties used to describe the source image. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of source image you want to start with. ,
Required: True ,
}
string ,
}
,
customize:
{
Description: Specifies the properties used to describe the customization steps of the image, like Image source etc ,
Required: False ,
}
[
{
type:
{
Description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization step does ,
Required: False ,
}
string ,
}
,
]
,
optimize:
{
Description: Specifies optimization to be performed on image. ,
Required: False ,
}
{
vmBoot:
{
Description: Optimization is applied on the image for a faster VM boot. ,
Required: False ,
}
{
state:
{
Description: Enabling this field will improve VM boot time by optimizing the final customized image output. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
validate:
{
Description: Configuration options and list of validations to be performed on the resulting image. ,
Required: False ,
}
{
continueDistributeOnFailure:
{
Description: If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] ,
Required: False ,
}
boolean ,
sourceValidationOnly:
{
Description: If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. ,
Required: False ,
}
boolean ,
inVMValidations:
{
Description: List of validations to be performed. ,
Required: False ,
}
[
{
type:
{
Description: The type of validation you want to use on the Image. For example, "Shell" can be shell validation ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this validation step does ,
Required: False ,
}
string ,
}
,
]
,
}
,
distribute:
{
Description: The distribution targets where the image output needs to go to. ,
Required: True ,
}
[
{
type:
{
Description: Type of distribution. ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name to be used for the associated RunOutput. ,
Required: True ,
}
string ,
artifactTags:
{
Description: Tags that will be applied to the artifact once it has been created/updated by the distributor. ,
Required: False ,
}
object ,
}
,
]
,
errorHandling:
{
Description: Error handling options upon a build failure ,
Required: False ,
}
{
onCustomizerError:
{
Description: If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
onValidationError:
{
Description: If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. ,
Enum:
{
cleanup: No description available. ,
abort: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningError:
{
Description: Provisioning error, if any ,
Required: False ,
}
{
provisioningErrorCode:
{
Description: Error code of the provisioning failure ,
Enum:
{
BadSourceType: No description available. ,
BadPIRSource: No description available. ,
BadManagedImageSource: No description available. ,
BadSharedImageVersionSource: No description available. ,
BadCustomizerType: No description available. ,
UnsupportedCustomizerType: No description available. ,
NoCustomizerScript: No description available. ,
BadValidatorType: No description available. ,
UnsupportedValidatorType: No description available. ,
NoValidatorScript: No description available. ,
BadDistributeType: No description available. ,
BadSharedImageDistribute: No description available. ,
BadStagingResourceGroup: No description available. ,
ServerError: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose error message about the provisioning failure ,
Required: False ,
}
string ,
}
,
lastRunStatus:
{
Description: State of 'run' that is currently executing or was last executed. ,
Required: False ,
}
{
startTime:
{
Description: Start time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the last run (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
runState:
{
Description: State of the last run ,
Enum:
{
Running: No description available. ,
Canceling: No description available. ,
Succeeded: No description available. ,
PartiallySucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runSubState:
{
Description: Sub-state of the last run ,
Enum:
{
Queued: No description available. ,
Building: No description available. ,
Customizing: No description available. ,
Optimizing: No description available. ,
Validating: No description available. ,
Distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
buildTimeoutInMinutes:
{
Description: Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours). ,
Format: int32 ,
Required: False ,
}
integer ,
vmProfile:
{
Description: Describes how virtual machine is set up to build images ,
Required: False ,
}
{
vmSize:
{
Description: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
userAssignedIdentities:
{
Description: Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. ,
Required: False ,
}
[
string ,
]
,
vnetConfig:
{
Description: Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. ,
Required: False ,
}
{
subnetId:
{
Description: Resource id of a pre-existing subnet. ,
Required: False ,
}
string ,
proxyVmSize:
{
Description: Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2). ,
Required: False ,
}
string ,
}
,
}
,
stagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain. ,
Required: False ,
}
string ,
exactStagingResourceGroup:
{
Description: The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the image template, if configured. ,
Required: True ,
}
{
type:
{
Description: The type of identity used for the image template. The type 'None' will remove any identities from the image template. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Delete (removed)
Description :  Delete a virtual machine image template
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Run (removed)
Description :  Create artifacts from a existing image template
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/run
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_Cancel (removed)
Description :  Cancel the long running image build based on the image template
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/cancel
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_ListRunOutputs (removed)
Description :  List all run outputs for the specified Image Template resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of run outputs ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the run output ,
Required: False ,
}
{
artifactId:
{
Description: The resource id of the artifact. ,
Required: False ,
}
string ,
artifactUri:
{
Description: The location URI of the artifact. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineImageTemplates_GetRunOutput (removed)
Description :  Get the specified run output for the specified image template resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs/{runOutputName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
runOutputName:
{
Description: The name of the run output ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the run output ,
Required: False ,
}
{
artifactId:
{
Description: The resource id of the artifact. ,
Required: False ,
}
string ,
artifactUri:
{
Description: The location URI of the artifact. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Triggers_ListByImageTemplate (removed)
Description :  List all triggers for the specified Image Template resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of triggers ,
Required: True ,
}
[
{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Triggers_Get (removed)
Description :  Get the specified trigger for the specified image template resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Triggers_CreateOrUpdate (removed)
Description :  Create or update a trigger for the specified virtual machine image template
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}
{
parameters:
{
Description: Parameters supplied to the CreateTrigger operation ,
Required: True ,
}
{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a trigger ,
Required: False ,
}
{
kind:
{
Description: The kind of trigger. ,
Required: True ,
}
string ,
status:
{
Description: Trigger status ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Triggers_Delete (removed)
Description :  Delete a trigger for the specified virtual machine image template
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageTemplateName:
{
Description: The name of the image Template ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists available operations for the Microsoft.VirtualMachineImages provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.VirtualMachineImages/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Description: This is of the format {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
operation:
{
Description: For example: read, write, delete, or listKeys/action ,
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
object ,
isDataAction:
{
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}