Virtual Machines - Deallocate

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

vmName
path True
  • string

The name of the virtual machine.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

202 Accepted

Accepted

Definitions

ApiError

Api error.

ApiErrorBase

Api error base.

InnerError

Inner error details.

OperationStatusResponse

Operation status response

ApiError

Api error.

Name Type Description
code
  • string

The error code.

details

The Api error details

innererror

The Api inner error

message
  • string

The error message.

target
  • string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code
  • string

The error code.

message
  • string

The error message.

target
  • string

The target of the particular error.

InnerError

Inner error details.

Name Type Description
errordetail
  • string

The internal error message or exception dump.

exceptiontype
  • string

The exception type.

OperationStatusResponse

Operation status response

Name Type Description
endTime
  • string

End time of the operation

error

Api error

name
  • string

Operation ID

startTime
  • string

Start time of the operation

status
  • string

Operation status