Skip to content

Commit 24c3a88

Browse files
authored
Merge pull request #27788 from microsoftgraph/users/sitaolu/cloudPcDeviceImage_getSourceImages_doc_update
Add category field to cloudpcsourcedeviceimage and adding filter to g…
2 parents d05e3d3 + 3d80d1e commit 24c3a88

4 files changed

Lines changed: 106 additions & 4 deletions

File tree

api-reference/beta/api/cloudpcdeviceimage-getsourceimages.md

Lines changed: 69 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ Choose the permission or permissions marked as least privileged for this API. Us
3636
GET /deviceManagement/virtualEndpoint/deviceImages/getSourceImages
3737
```
3838

39+
## Optional query parameters
40+
41+
This method supports the `$filter` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
42+
3943
## Request headers
4044

4145
|Name|Description|
@@ -48,11 +52,15 @@ Don't supply a request body for this method.
4852

4953
## Response
5054

51-
If successful, this function returns a `200 OK` response code and a [cloudPcSourceDeviceImage](../resources/cloudpcsourcedeviceimage.md) collection in the response body.
55+
If successful, this function returns a `200 OK` response code and a collection of [cloudPcSourceDeviceImage](../resources/cloudpcsourcedeviceimage.md) objects in the response body.
5256

5357
## Examples
5458

55-
### Request
59+
### Example 1: Get cloudPcSourceDeviceImage objects without any query parameters
60+
61+
The following example shows how to get **cloudPcSourceDeviceImage** objects without any query parameters.
62+
63+
#### Request
5664

5765
The following example shows a request.
5866

@@ -93,7 +101,63 @@ GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImag
93101

94102
---
95103

96-
### Response
104+
#### Response
105+
106+
The following example shows the response.
107+
108+
>**Note:** The response object shown here might be shortened for readability.
109+
<!-- {
110+
"blockType": "response",
111+
"truncated": true,
112+
"@odata.type": "Collection(microsoft.graph.cloudPcSourceDeviceImage)"
113+
}
114+
-->
115+
116+
``` http
117+
HTTP/1.1 200 OK
118+
Content-Type: application/json
119+
120+
{
121+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.cloudPcSourceDeviceImage)",
122+
"value": [
123+
{
124+
"id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/images/exampleImageForDev",
125+
"resourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/images/exampleImageForDev",
126+
"displayName": "exampleImageForDev",
127+
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
128+
"subscriptionDisplayName": "Reserved for IT",
129+
"category": "managedImage"
130+
},
131+
{
132+
"id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/galleries/exampleGallery/images/exampleImageForDev/versions/1.0.0",
133+
"resourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/galleries/exampleGallery/images/exampleImageForDev/versions/1.0.0",
134+
"displayName": "1.0.0",
135+
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
136+
"subscriptionDisplayName": "Reserved for IT",
137+
"category": "azureComputeGallery"
138+
}
139+
]
140+
}
141+
```
142+
143+
### Example 2: Get cloudPcSourceDeviceImage objects with a specific category
144+
145+
The following example shows how to get **cloudPcSourceDeviceImage** objects with a specific category.
146+
147+
#### Request
148+
149+
The following example shows a request.
150+
151+
<!-- {
152+
"blockType": "request",
153+
"name": "cloudpcdeviceimage_getsourceimageswithcategory"
154+
}
155+
-->
156+
``` http
157+
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImages/getSourceImages?$filter=category eq 'managedImage'
158+
```
159+
160+
#### Response
97161

98162
The following example shows the response.
99163

@@ -117,7 +181,8 @@ Content-Type: application/json
117181
"resourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/images/exampleImageForDev",
118182
"displayName": "exampleImageForDev",
119183
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
120-
"subscriptionDisplayName": "Reserved for IT"
184+
"subscriptionDisplayName": "Reserved for IT",
185+
"category": "managedImage"
121186
}
122187
]
123188
}

api-reference/beta/resources/cloudpcsourcedeviceimage.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,21 @@ Represents the source image associated with your Azure subscription.
2020

2121
|Property|Type|Description|
2222
|:---|:---|:---|
23+
|category|[cloudPcSourceImageCategory](#cloudpcsourceimagecategory-values)|The category of the source image that is requested. Possible values are: `managedImage`, `azureComputeGallery`, `unknownFutureValue`. The default value is `managedImage`. Read-only.|
2324
|displayName|String|The display name for the source image. Read-only.|
2425
|resourceId|String| The fully qualified unique identifier (ID) of the source image resource in Azure. The ID format is: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}". Read-only.|
2526
|subscriptionDisplayName|String|The display name of the subscription that hosts the source image. Read-only.|
2627
|subscriptionId|String|The unique identifier (ID) of the subscription that hosts the source image. Read-only.|
2728
|id (deprecated)|String|The unique identifier (ID) of the source image. Read-only. The **id** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **resourceId** property.|
2829

30+
### cloudPcSourceImageCategory values
31+
32+
|Member|Description|
33+
|:---|:---|
34+
|managedImage|Indicates that the source image is from a managed image.|
35+
|azureComputeGallery|Indicates that the source image is from an Azure compute gallery.|
36+
|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
37+
2938
## Relationships
3039

3140
None.
@@ -42,6 +51,7 @@ The following JSON representation shows the resource type.
4251
``` json
4352
{
4453
"@odata.type": "#microsoft.graph.cloudPcSourceDeviceImage",
54+
"category": "String",
4555
"displayName": "String",
4656
"id": "String (identifier)",
4757
"resourceId": "String (identifier)",

changelog/Microsoft.CloudManagedDesktop.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
11
{
22
"changelog": [
3+
{
4+
"ChangeList": [
5+
{
6+
"Id": "b88cc6c6-4eff-4a61-9835-9086446bdcb6",
7+
"ApiChange": "Enumeration",
8+
"ChangedApiName": "cloudPcSourceImageCategory",
9+
"ChangeType": "Addition",
10+
"Description": "Added the **cloudPcSourceImageCategory** enumeration type.",
11+
"Target": "cloudPcSourceImageCategory"
12+
},
13+
{
14+
"Id": "b88cc6c6-4eff-4a61-9835-9086446bdcb6",
15+
"ApiChange": "Property",
16+
"ChangedApiName": "category",
17+
"ChangeType": "Addition",
18+
"Description": "Added the **category** property to the [cloudPcSourceDeviceImage](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcSourceDeviceImage?view=graph-rest-beta) resource.",
19+
"Target": "cloudPcSourceDeviceImage"
20+
}
21+
],
22+
"Id": "b88cc6c6-4eff-4a61-9835-9086446bdcb6",
23+
"Cloud": "Prod",
24+
"Version": "beta",
25+
"CreatedDateTime": "2026-01-21T02:49:22.7461765Z",
26+
"WorkloadArea": "Devices and app management",
27+
"SubArea": "Cloud PC"
28+
},
329
{
430
"ChangeList": [
531
{

concepts/whats-new-overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ The `TeamsAppInstallation.ManageSelectedForTeam.All` is the least privileged app
4444

4545
- Added `mexico` as a new supported value for the **cloudPcGeographicLocationType** enumeration type. This enum is the return type for the **geographicLocationType** property on [cloudPcDomainJoinConfiguration](/graph/api/resources/cloudpcdomainjoinconfiguration?view=graph-rest-beta&preserve-view=true) and [cloudPcSupportedRegion](/graph/api/resources/cloudpcsupportedregion?view=graph-rest-beta&preserve-view=true).
4646
- Added the `cloudPCInventoryReport` member to the **cloudPcReportName** enumeration type. This enum is the return type for the **reportName** property on [cloudPcExportJob](/graph/api/resources/cloudPcExportJob?view=graph-rest-beta&preserve-view=true), [getFrontlineReport action](/graph/api/resources/cloudpcreports-getfrontlinereport?view=graph-rest-beta&preserve-view=true), and [getCloudPcRecommendationReports action](/graph/api/resources/cloudpcreports-getcloudpcrecommendationreports?view=graph-rest-beta&preserve-view=true).
47+
- Use the **category** property on [cloudPcSourceDeviceImage](/graph/api/resources/cloudpcsourcedeviceimage?view=graph-rest-beta&preserve-view=true) to get the category of the source image that is requested. For more information, see [Get cloudPcSourceDeviceImage objects with a specific category](/graph/api/cloudpcdeviceimage-getsourceimages?view=graph-rest-beta&preserve-view=true#example-2-get-cloudpcsourcedeviceimage-objects-with-a-specific-category).
4748

4849
### Message trace
4950

0 commit comments

Comments
 (0)