cloudPcSnapshot resource type

Article
10/01/2024

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a snapshot of the device settings of a Cloud PC that can be used to restore the device system.

Inherits from entity.

Methods

Method	Return type	Description
Get	cloudPcSnapshot	Read the properties and relationships of a cloudPcSnapshot object.
List (deprecated)	None	Get a list of the cloudPcSnapshot objects and their properties. This API is deprecated and will stop returning data on February 28, 2025. Going forward, use the cloudPcRetrieveSnapshots API.

Properties

Property	Type	Description
cloudPcId	String	The unique identifier for the Cloud PC.
createdDateTime	DateTimeOffset	The date and time at which the snapshot was taken. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
id	String	The unique identifier for the snapshot of the Cloud PC device at a specific point in time. Inherited from entity.
lastRestoredDateTime	DateTimeOffset	The date and time at which the snapshot was last used to restore the Cloud PC device. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
snapshotType	cloudPcSnapshotType	The type of snapshot that indicates how to create the snapshot. Possible values are `automatic`, `manual`. Default value is `automatic`.
status	cloudPcSnapshotStatus	The status of the Cloud PC snapshot. The possible values are: `ready`, `unknownFutureValue`.
expirationDateTime	DateTimeOffset	The date and time when the snapshot expires. The time is shown in ISO 8601 format and Coordinated Universal Time (UTC) time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.

cloudPcSnapshotStatus values

Member	Description
ready	The snapshot is ready to restore the Cloud PC device.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

cloudPcSnapshotType values

Member	Description
`automatic`	The snapshot is created automatically.
`manual`	The snapshot is created manually.
`unknownFutureValue`	Evolvable enumeration sentinel value. Don't use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.cloudPcSnapshot",
  "cloudPcId": "String",
  "createdDateTime": "String (timestamp)",
  "expirationDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "lastRestoredDateTime": "String (timestamp)",
  "snapshotType": "String",
  "status": "String"
}

Share via