Edit

cloudPcGalleryImage resource type

  • Article

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 the gallery image resource of the current organization that can be used to provision a Cloud PC.

Methods

Method Return type Description
List galleryImages cloudPcGalleryImage collection List the properties and relationships of cloudPcGalleryImage objects.
Get cloudPcGalleryImage cloudPcGalleryImage Read the properties and relationships of a specific cloudPcGalleryImage object.

Properties

Property Type Description
displayName String The display name of this gallery image. For example, Windows 11 Enterprise + Microsoft 365 Apps 22H2. Read-only.
endDate Date The date when the status of image becomes supportedWithWarning. Users can still provision new Cloud PCs if the current time is later than endDate and earlier than expirationDate. For example, assume the endDate of a gallery image is 2023-9-14 and expirationDate is 2024-3-14, users are able to provision new Cloud PCs if today is 2023-10-01. Read-only.
expirationDate Date The date when the image is no longer available. Users are unable to provision new Cloud PCs if the current time is later than expirationDate. The value is usually endDate plus six months. For example, if the startDate is 2025-10-14, the expirationDate is usually 2026-04-14. Read-only.
id String The unique identifier (ID) of the gallery image resource on Cloud PC. The ID format is {publisherName_offerName_skuName}. For example, MicrosoftWindowsDesktop_windows-ent-cpc_win11-22h2-ent-cpc-m365. You can find the publisherName, offerName, and skuName in the Azure Marketplace. Read-only.
offerName String The offer name of this gallery image that is passed to ARM to retrieve the image resource. Read-only.
publisherName String The publisher name of this gallery image that is passed to ARM to retrieve the image resource. Read-only.
sizeInGB Int32 Indicates the size of this image in gigabytes. For example, 64. Read-only.
skuName String The SKU name of this image that is passed to ARM to retrieve the image resource. Read-only.
startDate Date The date when the Cloud PC image is available for provisioning new Cloud PCs. For example, 2022-09-20. Read-only.
status cloudPcGalleryImageStatus The status of the gallery image on the Cloud PC. Possible values are: supported, supportedWithWarning, notSupported, unknownFutureValue. The default value is supported. Read-only.
offer (deprecated) String The offer name of this gallery image that is passed to ARM to retrieve the image resource. Read-only. The offer property is deprecated and will stop returning data on January 31, 2024. Going forward, use the offerName property.
offerDisplayName (deprecated) String The official display offer name of this gallery image. For example, Windows 10 Enterprise + OS Optimizations. The offerDisplayName property is deprecated and will stop returning data on January 31, 2024.
publisher (deprecated) String The publisher name of this gallery image that is passed to ARM to retrieve the image resource. Read-only. The publisher property is deprecated and will stop returning data on January 31, 2024. Going forward, use the publisherName property.
recommendedSku (deprecated) String The recommended Cloud PC SKU for this gallery image. Read-only. The recommendedSku property is deprecated and will stop returning data on January 31, 2024.
sku (deprecated) String The SKU name of this image that is passed to ARM to retrieve the image resource. Read-only. The sku property is deprecated and will stop returning data on January 31, 2024. Going forward, use the skuName property.
skuDisplayName (deprecated) String The official display SKU name of this gallery image. For example, 2004. Read-only. The skuDisplayName property is deprecated and will stop returning data on January 31, 2024.

cloudPcGalleryImageStatus values

Member Description
supported The gallery image is active and ready to be used for provisioning.
supportedWithWarning The gallery image has expired, but the Cloud PC will continue support for six months, after which it will be unsupported and can't be used.
notSupported The gallery image is out of support.
unknownFutureValue Evolvable enumeration sentinel value. Don't use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.cloudPcGalleryImage",
  "displayName": "String",
  "endDate": "String (Date)",
  "expirationDate": "String (Date)",
  "id": "String (identifier)",
  "offer": "String",
  "offerDisplayName": "String",
  "offerName": "String",
  "publisher": "String",
  "publisherName": "String",
  "recommendedSku": "String",
  "sizeInGB": "Int32",
  "sku": "String",
  "skuDisplayName": "String",
  "skuName": "String",
  "startDate": "String (Date)",
  "status": "String"
}