Share via

Virtual Machine Instances - Create Checkpoint

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

Implements the operation to creates a checkpoint in a virtual machine instance.
Creates a checkpoint in virtual machine instance.

POST https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/createCheckpoint?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
description

string

Description of the checkpoint.
name

string

Name of the checkpoint.

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_CreateCheckpoint_MaximumSet
VirtualMachineInstances_CreateCheckpoint_MinimumSet

VirtualMachineInstances_CreateCheckpoint_MaximumSet

Sample request

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

{
  "name": "ilvltf",
  "description": "zoozhfbepldrgpjqsbhpqebtodrhvy"
}

Sample response

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

VirtualMachineInstances_CreateCheckpoint_MinimumSet

Sample request

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/createCheckpoint?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
VirtualMachineCreateCheckpoint

Defines the create checkpoint 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.

VirtualMachineCreateCheckpoint

Defines the create checkpoint action properties.

Name Type Description
description

string

Description of the checkpoint.
name

string

Name of the checkpoint.