Microsoft.VirtualMachineImages (preview:2018-02-01)

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

VirtualMachineImageTemplate_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:
{
Required: False ,
}
[
{
properties:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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:
{
Required: False ,
}
[
{
properties:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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 Create Image Template ,
Required: True ,
}
{
properties:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}
,
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:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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 ,
}
{
tags:
{
Description: The user-specified tags associated with the image template. ,
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:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_Get (new)
Description :  Get Information about 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:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_Delete (new)
Description :  Delete 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 (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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 (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
artifactId:
{
Description: The resource id of the artifact. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_GetRunOutput (new)
Description :  Get the specified run output for the specified 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:
{
Required: False ,
}
{
artifactId:
{
Description: The resource id of the artifact. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
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 ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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:
{
Required: False ,
}
[
{
properties:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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:
{
Required: False ,
}
[
{
properties:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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 Create Image Template ,
Required: True ,
}
{
properties:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}
,
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:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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 ,
}
{
tags:
{
Description: The user-specified tags associated with the image template. ,
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:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_Get (removed)
Description :  Get Information about 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:
{
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 shellCustomizer ,
Required: True ,
}
string ,
name:
{
Description: Friendly Name to provide context on what this customization 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 ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: 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. ,
BadISOSource: No description available. ,
BadCustomizerType: No description available. ,
NoCustomizerShellScript: 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:
{
ready: No description available. ,
running: No description available. ,
succeeded: No description available. ,
partiallySucceeded: No description available. ,
failed: 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. ,
distributing: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Verbose information about the last run state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_Delete (removed)
Description :  Delete 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 (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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 (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_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:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
artifactId:
{
Description: The resource id of the artifact. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
VirtualMachineImageTemplate_GetRunOutput (removed)
Description :  Get the specified run output for the specified 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:
{
Required: False ,
}
{
artifactId:
{
Description: The resource id of the artifact. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
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 ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}