Skip to content

Commit 8318ed2

Browse files
authored
Merge pull request #26072 from microsoftgraph/users/xianchao/modify-CPC-deviceImage-api-docs
Add new errorcode "sourceImageWithDiskEncryptionSetNotSupported" for CPC device image api
2 parents 9a611ca + 5582766 commit 8318ed2

File tree

2 files changed

+39
-2
lines changed

2 files changed

+39
-2
lines changed

api-reference/beta/resources/cloudpcdeviceimage.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Represents the image resource on a Cloud PC.
3232
|Property|Type|Description|
3333
|:---|:---|:---|
3434
|displayName|String|The display name of the associated device image. The device image display name and the version are used to uniquely identify the Cloud PC device image. Read-only.|
35-
|errorCode|[cloudPcDeviceImageErrorCode](#cloudpcdeviceimageerrorcode-values)|The error code of the status of the image that indicates why the upload failed, if applicable. Possible values are: `internalServerError`, `sourceImageNotFound`, `osVersionNotSupported`, `sourceImageInvalid`, `sourceImageNotGeneralized`, `unknownFutureValue`, `vmAlreadyAzureAdJoined`, `paidSourceImageNotSupport`, `sourceImageNotSupportCustomizeVMName`, `sourceImageSizeExceedsLimitation`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `vmAlreadyAzureAdJoined`, `paidSourceImageNotSupport`, `sourceImageNotSupportCustomizeVMName`, `sourceImageSizeExceedsLimitation`. Read-only.|
35+
|errorCode|[cloudPcDeviceImageErrorCode](#cloudpcdeviceimageerrorcode-values)|The error code of the status of the image that indicates why the upload failed, if applicable. Possible values are: `internalServerError`, `sourceImageNotFound`, `osVersionNotSupported`, `sourceImageInvalid`, `sourceImageNotGeneralized`, `unknownFutureValue`, `vmAlreadyAzureAdJoined`, `paidSourceImageNotSupport`, `sourceImageNotSupportCustomizeVMName`, `sourceImageSizeExceedsLimitation`, `sourceImageWithDataDiskNotSupported`, `sourceImageWithDiskEncryptionSetNotSupported`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `vmAlreadyAzureAdJoined`, `paidSourceImageNotSupport`, `sourceImageNotSupportCustomizeVMName`, `sourceImageSizeExceedsLimitation`, `sourceImageWithDataDiskNotSupported`, `sourceImageWithDiskEncryptionSetNotSupported`. Read-only.|
3636
|expirationDate|Date|The date when the image became unavailable. Read-only.|
3737
|id|String|The unique identifier (ID) of the image resource on the Cloud PC. Read-only.|
3838
|lastModifiedDateTime|DateTimeOffset|The data and time when the image was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.|
@@ -41,7 +41,7 @@ Represents the image resource on a Cloud PC.
4141
|osStatus|[cloudPcDeviceImageOsStatus](#cloudpcdeviceimageosstatus-values)|The OS status of this image. Possible values are: `supported`, `supportedWithWarning`, `unknown`, `unknownFutureValue`. The default value is `unknown`. Read-only.|
4242
|osVersionNumber|String|The operating system version of this image. For example, `10.0.22000.296`. Read-only.|
4343
|sourceImageResourceId|String|The unique identifier (ID) of the source image resource on Azure. The required ID format is: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}". Read-only.|
44-
|status|[cloudPcDeviceImageStatus](#cloudpcdeviceimagestatus-values)|The status of the image on the Cloud PC. Possible values are: `pending`, `ready`, `failed`, `unknownFutureValue`. Read-only.|
44+
|status|[cloudPcDeviceImageStatus](#cloudpcdeviceimagestatus-values)|The status of the image on the Cloud PC. Possible values are: `pending`, `ready`, `warning`, `failed`, `unknownFutureValue`. Read-only.|
4545
|version|String|The image version. For example, `0.0.1` and `1.5.13`. Read-only.|
4646
|statusDetails (deprecated)|[cloudPcDeviceImageStatusDetails](#cloudpcdeviceimagestatusdetails-values)|The details of the status of the image that indicates why the upload failed, if applicable. Possible values are: `internalServerError`, `sourceImageNotFound`, `osVersionNotSupported`, `sourceImageInvalid`, `sourceImageNotGeneralized`, `unknownFutureValue`, `vmAlreadyAzureAdJoined`, `paidSourceImageNotSupport`, `sourceImageNotSupportCustomizeVMName`, `sourceImageSizeExceedsLimitation`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `vmAlreadyAzureAdJoined`, `paidSourceImageNotSupport`, `sourceImageNotSupportCustomizeVMName`, `sourceImageSizeExceedsLimitation`. Read-only. The **statusDetails** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **errorCode** property.|
4747

@@ -59,6 +59,8 @@ Represents the image resource on a Cloud PC.
5959
|paidSourceImageNotSupport|This source image is built from another paid image from the Azure Marketplace and isn't supported; use another source to proceed.|
6060
|sourceImageNotSupportCustomizeVMName|A computer name setting issue exists on the resultant generalized image, which prevents the customization of the VM name with the provided image.|
6161
|sourceImageSizeExceedsLimitation|The size of the customer-uploaded source image exceeds the shared image gallery (SIG) limitations, which results in image creation failure.|
62+
|sourceImageWithDataDiskNotSupported|Indicates the error code where source image has an associated data disk attached. Note that setting up a provisioning policy with this configuration is not supported with W365 Frontline.|
63+
|sourceImageWithDiskEncryptionSetNotSupported|Indicates that the uploaded image uses a disk encryption set with a customer-managed key, which is not supported in Windows 365. Please upload a new image encrypted with a platform-managed key.|
6264

6365
### cloudPcDeviceImageOsStatus values
6466

@@ -75,6 +77,7 @@ Represents the image resource on a Cloud PC.
7577
|:---|:---|
7678
|pending|The image upload is in progress.|
7779
|ready|The image is ready for use on Cloud PCs.|
80+
|warning| Indicates the Cloud PC image uploaded may not be provisioned in certain scenarios. For details, see the error message.|
7881
|failed|Indicates that the image failed to upload. |
7982
|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
8083

changelog/Microsoft.CloudManagedDesktop.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6477,6 +6477,40 @@
64776477
"SubArea": "Cloud PC"
64786478
},
64796479
{
6480+
"ChangeList": [
6481+
{
6482+
"Id": "fd3a1e11-2b40-4b2e-a27f-c8bc529dcc40",
6483+
"ApiChange": "Member",
6484+
"ChangedApiName": "warning",
6485+
"ChangeType": "Addition",
6486+
"Description": "Added the `warning` member to the **cloudPcDeviceImageStatus** enumeration.",
6487+
"Target": "cloudPcDeviceImageStatus"
6488+
},
6489+
{
6490+
"Id": "fd3a1e11-2b40-4b2e-a27f-c8bc529dcc40",
6491+
"ApiChange": "Member",
6492+
"ChangedApiName": "sourceImageWithDataDiskNotSupported",
6493+
"ChangeType": "Addition",
6494+
"Description": "Added the `sourceImageWithDataDiskNotSupported` member to the **cloudPcDeviceImageErrorCode** enumeration.",
6495+
"Target": "cloudPcDeviceImageErrorCode"
6496+
},
6497+
{
6498+
"Id": "fd3a1e11-2b40-4b2e-a27f-c8bc529dcc40",
6499+
"ApiChange": "Member",
6500+
"ChangedApiName": "sourceImageWithDiskEncryptionSetNotSupported",
6501+
"ChangeType": "Addition",
6502+
"Description": "Added the `sourceImageWithDiskEncryptionSetNotSupported` member to the **cloudPcDeviceImageErrorCode** enumeration.",
6503+
"Target": "cloudPcDeviceImageErrorCode"
6504+
}
6505+
],
6506+
"Id": "fd3a1e11-2b40-4b2e-a27f-c8bc529dcc40",
6507+
"Cloud": "Prod",
6508+
"Version": "beta",
6509+
"CreatedDateTime": "2025-02-11T00:25:04.0954058Z",
6510+
"WorkloadArea": "Device and app management",
6511+
"SubArea": "Cloud PC"
6512+
},
6513+
{
64806514
"ChangeList": [
64816515
{
64826516
"Id": "51186d13-0d6a-4a64-a631-e841ccb1f999",

0 commit comments

Comments
 (0)