Virtual Machine Instances - Delete

  • Reference
Service:
Azure Arc enabled SCVMM
API Version:
2024-06-01

Deletes an virtual machine.
The operation to delete a virtual machine instance.

DELETE https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01
With optional parameters: 
DELETE https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01&force={force}&deleteFromHost={deleteFromHost}

URI Parameters

Name In Required Type Description
resourceUri
 path True

string

The fully qualified Azure Resource manager identifier of the resource.
api-version
 query True

string

The API version to use for this operation.
deleteFromHost
 query

DeleteFromHost

Whether to disable the VM from azure and also delete it from Vmm.
force
 query

ForceDelete

Forces the resource to be deleted.

Responses

Name Type Description
202 Accepted

Resource deletion accepted.

Headers

  • Location: string
  • Retry-After: integer
204 No Content

Resource does not exist.
Other Status Codes

ErrorResponse

An unexpected error response.

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

VirtualMachineInstances_Delete_MaximumSet
VirtualMachineInstances_Delete_MinimumSet

VirtualMachineInstances_Delete_MaximumSet

Sample request

DELETE https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01&force=true&deleteFromHost=true

Sample response

Status code:
202 
location: https://contoso.com/operationstatus
Status code:
204

VirtualMachineInstances_Delete_MinimumSet

Sample request

DELETE https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01

Sample response

Status code:
202 
location: https://contoso.com/operationstatus
Status code:
204

Definitions

Name Description
DeleteFromHost

Whether to disable the VM from azure and also delete it from Vmm.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ForceDelete

Forces the resource to be deleted.

DeleteFromHost

Whether to disable the VM from azure and also delete it from Vmm.

Name Type Description
false

string

Disable delete from host.
true

string

Enable delete from host.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ForceDelete

Forces the resource to be deleted.

Name Type Description
false

string

Disable force delete.
true

string

Enable force delete.