Virtual Machines - Reimage

Service:

Compute

API Version:

2019-03-01

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

HTTP

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage?api-version=2019-03-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vmName	path	True	string	The name of the virtual machine.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
parameters	VirtualMachineReimageParameters	Parameters supplied to the Reimage Virtual Machine operation.

Responses

Name	Type	Description
200 OK		OK
202 Accepted		Accepted

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Reimage a Virtual Machine.

Sample request

HTTP

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVMName/reimage?api-version=2019-03-01

{
  "tempDisk": true
}

Sample response

Status code:

200

Status code:

202

Definitions

VirtualMachineReimageParameters

Object

Parameters supplied to the Reimage Virtual Machine operation.

Name	Type	Description
tempDisk	boolean	Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.