Skip to content

Commit

Permalink
Merge pull request #25293 from microsoftgraph/main
Browse files Browse the repository at this point in the history
Merge to publish.
  • Loading branch information
Lauragra authored Oct 1, 2024
2 parents 1ace013 + 19e394b commit 84c78b6
Show file tree
Hide file tree
Showing 44 changed files with 487 additions and 94 deletions.
107 changes: 107 additions & 0 deletions api-reference/beta/api/cloudpc-retrievesnapshots.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
title: "cloudPC: retrieveSnapshots"
description: "List all snapshots of a Cloud PC."
author: "doudoujinjin"
ms.localizationpriority: medium
ms.subservice: "cloud-pc"
doc_type: apiPageType
---

# cloudPC: retrieveSnapshots

Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

List all [cloudPcSnapshot](../resources/cloudpcsnapshot.md) resources for a Cloud PC.

## Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

|Permission type|Permissions (from least to most privileged)|
|:---|:---|
|Delegated (work or school account)|CloudPC.ReadWrite.All|
|Delegated (personal Microsoft account)|Not supported.|
|Application|CloudPC.ReadWrite.All|

## HTTP request

<!-- {
"blockType": "ignored"
}
-->

``` http
GET /cloudPCs/{cloudPCId}/retrieveSnapshots
```

## Request headers

|Name |Description |
|:---------- |:------------------ |
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|

## Request body

Don't supply a request body for this method.

## Response

If successful, this method returns a `200 OK` response code and a list of [cloudPcSnapshot](../resources/cloudpcsnapshot.md) object in the response body.

## Examples

### Request

The following example shows a request.

<!-- {
"blockType": "request",
"name": "cloudpc.retrieveSnapshots"
}
-->

``` http
GET https://graph.microsoft.com/beta/cloudPCs/b0a9cde2-e170-4dd9-97c3-ad1d3328a711/retrieveSnapshots
```

### Response

The following example shows the response.

<!-- {
"blockType": "response",
"truncated": true,
"@odata.type": "Collection(microsoft.graph.cloudPcSnapshot)"
}
-->

``` http
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.cloudPcSnapshot)",
"value": [
{
"id": "CPC_d4cfdeb2-d409-4e97-87ce-618b704d75f1_d95c0bde-485d-400e-9bef-083905e1b768",
"cloudPcId": "d8b39ec3-03c9-457f-824e-25f48197cec6",
"status": "ready",
"createdDateTime": "2024-08-19T14:05:17.2480723Z",
"lastRestoredDateTime": null,
"snapshotType": "automatic",
"expirationDateTime": null
},
{
"id": "CPC_d4cfdeb2-d409-4e97-87ce-618b704d75f1_423e5d9d-06e0-4b3b-8f0c-80f5a5215a10",
"cloudPcId": "d8b39ec3-03c9-457f-824e-25f48197cec6",
"status": "ready",
"createdDateTime": "2024-08-19T02:05:15.624315Z",
"lastRestoredDateTime": null,
"snapshotType": "automatic",
"expirationDateTime": null
}
]
}
```
29 changes: 20 additions & 9 deletions api-reference/beta/api/domain-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,10 @@ If successful, this method returns a `200 OK` response code and [domain](../reso
<!-- {
"blockType": "request",
"name": "get_domain",
"sampleKeys": ["contoso.com"]
"sampleKeys": ["woodgrovedemo.com"]
}-->
```msgraph-interactive
GET https://graph.microsoft.com/beta/domains/contoso.com
GET https://graph.microsoft.com/beta/domains/woodgrovedemo.com
```

# [C#](#tab/csharp)
Expand Down Expand Up @@ -150,13 +150,24 @@ HTTP/1.1 200 OK
Content-type: application/json
{
"authenticationType": "authenticationType-value",
"availabilityStatus": "availabilityStatus-value",
"id": "contoso.com",
"isAdminManaged": true,
"isDefault": true,
"isInitial": true,
"isRoot": true
"@odata.context": "https://graph.microsoft.com/beta/$metadata#domains/$entity",
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET domains('<key>')?$select=authenticationType,availabilityStatus",
"authenticationType": "Managed",
"availabilityStatus": null,
"id": "woodgrovedemo.com",
"isAdminManaged": true,
"isDefault": true,
"isInitial": true,
"isRoot": true,
"isVerified": true,
"supportedServices": [
"Email",
"OfficeCommunicationsOnline",
"CustomUrlDomain"
],
"passwordValidityPeriodInDays": 2147483647,
"passwordNotificationWindowInDays": 14,
"state": null
}
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
---
title: "managedDevice: bulkSetCloudPcReviewStatus"
title: "managedDevice: bulkSetCloudPcReviewStatus (deprecated)"
description: "Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices."
author: "yayang3"
author: "doudoujinjin"
ms.localizationpriority: medium
ms.subservice: "cloud-pc"
doc_type: apiPageType
---

# managedDevice: bulkSetCloudPcReviewStatus
# managedDevice: bulkSetCloudPcReviewStatus (deprecated)

Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices.
> [!CAUTION]
> This API is deprecated and stopped returning data on September 30, 2024. Going forward, use the [cloudPcBulkSetReviewStatus](../resources/cloudpcbulksetreviewstatus.md) resource and its supported APIs.
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]

Expand Down Expand Up @@ -47,7 +48,7 @@ The following table shows the parameters that can be used with this action.
|Parameter|Type|Description|
|:---|:---|:---|
|managedDeviceIds|String collection|The managed device IDs of the Cloud PC devices.|
|reviewStatus|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|The new review status of the Cloud PC devices. |
|reviewStatus|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|The new review status of the Cloud PC devices.|


## Response
Expand Down
4 changes: 3 additions & 1 deletion api-reference/beta/api/user-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ PATCH /users/{id | userPrincipalName}
|onPremisesImmutableId|String|This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's **userPrincipalName** (UPN) property. **Important:** The **$** and **_** characters can't be used when specifying this property. |
|otherMails|String collection|A list of additional email addresses for the user; for example: `["bob@contoso.com", "Robert@fabrikam.com"]`.|
|passwordPolicies|String|Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two can be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`.|
|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the user's password. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. This can't be used for federated users. <br><br> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. In application-only access, the calling app must be assigned the *User.ReadWrite.All* application permission and at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).|
|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the user's password. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. This can't be used for federated users. <br><li> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. <li> In application-only access, the calling app must be assigned the *User.ReadWrite.All* (least privilege) or *Directory.ReadWrite.All* (higher privilege) application permission *and* at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).|
|pastProjects|String collection|A list for the user to enumerate their past projects.|
|postalCode|String|The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.|
|preferredLanguage|String|The preferred language for the user. Should follow ISO 639-1 Code; for example, `en-US`.|
Expand Down Expand Up @@ -261,6 +261,8 @@ HTTP/1.1 204 No Content

The following example shows a request that resets the password of another user. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`.

[!INCLUDE [users-passwordprofile-permissions](../includes/users-passwordprofile-permissions.md)]

#### Request


Expand Down
9 changes: 6 additions & 3 deletions api-reference/beta/api/virtualendpoint-list-snapshots.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
---
title: "List snapshots"
title: "List snapshots (deprecated)"
description: "Get a list of cloudPcSnapshot objects and their properties."
author: "xintaozMS"
author: "doudoujinjin"
ms.localizationpriority: medium
ms.subservice: "cloud-pc"
doc_type: apiPageType
---

# List snapshots
# List snapshots (deprecated)
Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

> [!CAUTION]
> This API is deprecated and stopped returning data on September 30, 2024. Going forward, use the [retrieveSnapshots](./cloudpc-retrievesnapshots.md) API.
Get a list of [cloudPcSnapshot](../resources/cloudpcsnapshot.md) objects and their properties.

[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,9 @@ author: jkdouglas
ms.topic: include
---

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *Teams Service Administrator* and *Global Reader* are the least privileged roles supported for this operation.
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation:

- Global Reader
- Extended Directory User Administrator
- Teams Service Administrator

Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,7 @@ author: jkdouglas
ms.topic: include
---

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *Teams Service Administrator* is the least privileged role supported for this operation.
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation:

- Extended Directory User Administrator
- Teams Service Administrator
10 changes: 10 additions & 0 deletions api-reference/beta/includes/users-passwordprofile-permissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
author: "yyuank"
ms.subservice: entra-users
ms.topic: include
---

<!-- markdownlint-disable MD041-->

- In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user.
- In application-only access, the calling app must be assigned the *User.ReadWrite.All* (least privilege) or *Directory.ReadWrite.All* (higher privilege) application permission *and* at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
4 changes: 4 additions & 0 deletions api-reference/beta/resources/authenticationbehaviors.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,7 @@ The following JSON representation shows the resource type.
"requireClientServicePrincipal": "Boolean"
}
```

## Related content

- [How-to: Manage application authenticationBehaviors](/graph/applications-authenticationbehaviors)
3 changes: 2 additions & 1 deletion api-reference/beta/resources/cloudpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in In
|[Restore](../api/cloudpc-restore.md)|None|Restore a Cloud PC object to a previous state from a snapshot.|
|[Set review status](../api/cloudpc-setreviewstatus.md)|None|Set the review status of a specific Cloud PC device using the Cloud PC ID.|
|[Retrieve review status](../api/cloudpc-retrievereviewstatus.md)|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|Get the [review status](..\resources\cloudpcreviewstatus.md) of a Cloud PC.|
|[Bulk set review status](../api/manageddevice-bulksetcloudpcreviewstatus.md)|[cloudPcBulkRemoteActionResult](../resources/cloudpcbulkremoteactionresult.md)|Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices.|
|[List for user](../api/user-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List the Cloud PC devices that are attributed to the signed-in user.|
|[Get launch info for user](../api/cloudpc-getcloudpclaunchinfo.md)|[cloudPcLaunchInfo](../resources/cloudpclaunchinfo.md)|Get the [cloudPcLaunchInfo](../resources/cloudpclaunchinfo.md) for the signed-in user.|
|[Get connectivity history](../api/cloudpc-getcloudpcconnectivityhistory.md)|[cloudPcConnectivityEvent](../resources/cloudpcconnectivityevent.md) collection|Get the Cloud PC connectivity history.|
Expand All @@ -45,6 +44,7 @@ Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in In
|[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents that failed to install on the Cloud PC.|
|[Validate bulk resize](../api/cloudpc-validatebulkresize.md)|[cloudPcResizeValidateResult](../resources/cloudPcResizeValidationResult.md) collection|Validate that a set of Cloud PC devices meet the requirements to be bulk resized.|
|[Create snapshot](../api/cloudpc-createsnapshot.md)|None|Create a snapshot for a specific Cloud PC device.|
|[Retrieve snapshots](../api/cloudpc-retrievesnapshots.md)|[cloudPcSnapshot](../resources/cloudpcsnapshot.md) collection|Get a list of [cloudPcSnapshot](../resources/cloudpcsnapshot.md) resources for a Cloud PC.|
|[Get frontline access state](../api/cloudpc-getfrontlinecloudpcaccessstate.md)|[frontlineCloudPcAccessState](#frontlinecloudpcaccessstate-values)|Get the access state of the frontline Cloud PC. The possible values are: `unassigned`, `noLicensesAvailable`, `activationFailed`, `active`, `activating`, `standbyMode`, `unknownFutureValue`. The `noLicensesAvailable` member is deprecated and will stop returning on September 30, 2024.|
|[Bulk reprovision remote action (deprecated)](../api/manageddevice-bulkreprovisioncloudpc.md) |None|Bulk reprovision a set of Cloud PC devices with Intune managed device IDs. This API is deprecated and stopped returning data on September 24, 2023. Going forward, use the [cloudPcBulkReprovision](../resources/cloudpcbulkreprovision.md) resource. |
|[Bulk resize (deprecated)](../api/cloudpc-bulkresize.md) |[cloudPcRemoteActionResult](../resources//cloudpcremoteactionresult.md) collection|Perform a bulk resize action to resize a group of Cloud PCs that have successfully passed validation (cloudPC: validateBulkResize). If any devices can't be resized, they're labeled as "resize failed", while the remaining devices are `provisioned` for the resize process. This API is deprecated and stopped returning data on September 24, 2023. Going forward, use the [cloudPcBulkResize](../resources/cloudpcbulkresize.md) resource.|
Expand All @@ -55,6 +55,7 @@ Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in In
|[Resize remote action (deprecated)](../api/manageddevice-resizecloudpc.md) |None|Upgrade or downgrade an existing Cloud PC to another configuration with a new vCPU and storage size through Intune managed device ID. This API is deprecated and stopped returning data on October 30, 2023. Going forward, use the [cloudPC: resize](../api/cloudpc-resize.md) API.|
|[Restore remote action (deprecated)](../api/manageddevice-restorecloudpc.md) |None|Restore a Cloud PC device to a previous state with an Intune [managed device](../resources/cloudpc.md) ID. This API is deprecated and will stop returning data on September 30, 2023. Going forward, use the [restore](../api/cloudpc-restore.md) API.|
|[Set review status (deprecated)](../api/manageddevice-setcloudpcreviewstatus.md) |None|Set the review status of a specific Cloud PC device using the managed device ID. This API is deprecated and stopped returning data on April 30, 2024. Going forward, use the [cloudPC: setReviewStatus](../api/cloudpc-setreviewstatus.md) API.|
|[Bulk set review status (deprecated)](../api/manageddevice-bulksetcloudpcreviewstatus.md)|None|Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices. This API is deprecated and stopped returning data on September 30, 2024. Going forward, use the [cloudPcBulkSetReviewStatus](../resources/cloudpcbulksetreviewstatus.md) resource.|

## Properties

Expand Down
Loading

0 comments on commit 84c78b6

Please sign in to comment.