Virtual Machine Instances - Stop

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

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.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

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.

Request Body

Name Type Description
skipShutdown

SkipShutdown

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

Resource operation accepted.

Headers

  • Location: string
  • Retry-After: integer
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_Stop_MaximumSet
VirtualMachineInstances_Stop_MinimumSet

VirtualMachineInstances_Stop_MaximumSet

Sample request

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

{
  "skipShutdown": "true"
}

Sample response

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

VirtualMachineInstances_Stop_MinimumSet

Sample request

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

{}

Sample response

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

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
SkipShutdown

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.
StopVirtualMachineOptions

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

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.

SkipShutdown

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.

Name Type Description
false

string

Disable skip shutdown.
true

string

Enable skip shutdown.

StopVirtualMachineOptions

Defines the stop action properties.

Name Type Default value Description
skipShutdown

SkipShutdown

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.