VMCheckPoint [SPFSDK][VMMREF]
Applies To: Windows Azure Pack
The VMCheckPoint entity represents a point-in-time snapshot of a virtual machine.
Inheritance Hierarchy
VMM
VMCheckPoint
Entity Properties
For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.
Name |
Create (PUT) |
Read (GET) |
Update (POST) |
Delete (DELETE) |
Type |
Nullable |
Description |
---|---|---|---|---|---|---|---|
ID |
- |
Optional |
Required |
Required |
Edm.Guid |
False |
Key Property The identifier of the entity. |
StampId |
Required |
Optional |
Required |
Required |
Edm.Guid |
False |
Key Property The identifier of the stamp that restricts the query. |
Accessibility |
- |
- |
- |
- |
Edm.String |
True |
Not used. |
AddedTime |
- |
- |
- |
- |
Edm.DateTime |
True |
When the checkpoint was added. |
CheckpointID |
- |
- |
- |
- |
Edm.Guid |
True |
The identifier of the checkpoint. |
Confirm |
- |
- |
- |
- |
Edm.Boolean |
True |
This should always be set to False. |
Description |
Optional |
- |
Optional |
- |
Edm.String |
True |
A friendly description of the checkpoint. |
Enabled |
- |
- |
- |
- |
Edm.Boolean |
True |
When false, indicates that this checkpoint cannot be used. |
ModifiedTime |
- |
- |
- |
- |
Edm.DateTime |
True |
When the checkpoint was last modified. |
Name |
Optional |
- |
Optional |
- |
Edm.String |
True |
The name of the checkpoint. |
ParentCheckpointID |
- |
- |
- |
- |
Edm.Guid |
True |
The identifier of the parent checkpoint. |
RunAsynchronously |
- |
- |
- |
- |
Edm.Boolean |
True |
Run the job asynchronously so that control returns to the command shell immediately. |
VMCheckPointAction |
- |
- |
Optional |
- |
Edm.String |
True |
The action to perform when updating a checkpoint. Either Set or Restore. Restore is only available when you update a checkpoint. |
VMId |
Required |
- |
- |
- |
Edm.Guid |
True |
The identifier of the VM associated with this checkpoint. |
Relationships
For more information about how the relationships of an entity are used, see Entity Basics.
Name |
Relationship Type |
From Property |
To Entity |
To Property |
---|---|---|---|---|
ParentCheckPoint |
One or None |
Not specified |
Not specified |
OData Operations
None
Examples
See Also
Entities [SPFSDK][VMMREF]
VMCheckPoints Collection [SPFSDK][VMMREF]