Virtual Machine Instances - Stop
Implements the operation to stop a virtual machine.
The operation to power off (stop) a virtual machine instance.
POST https://management.azure.com/{resourceUri}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default/stop?api-version=2023-12-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string |
The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. |
|
api-version
|
query | True |
string |
Client Api Version. |
Request Body
| Name | Type | Description |
|---|---|---|
| skipShutdown |
boolean |
Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Defaults to false. |
Responses
| Name | Type | Description |
|---|---|---|
| 202 Accepted |
Accepted Headers Location: string |
|
| Other Status Codes |
Error response describing why the operation failed. |
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
StopVirtualMachine
Sample request
Sample response
Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.ConnectedVMwarevSphere/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-12-01
Definitions
| Name | Description |
|---|---|
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
Stop |
Defines the stop action properties. |
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 |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
StopVirtualMachineOptions
Defines the stop action properties.
| Name | Type | Default value | Description |
|---|---|---|---|
| skipShutdown |
boolean |
False |
Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Defaults to false. |