Skip to content

cloudpc-getfrontlinecloudpcaccessstate.md

Latest commit

 

History

History
187 lines (137 loc) · 6.84 KB

cloudpc-getfrontlinecloudpcaccessstate.md

File metadata and controls

187 lines (137 loc) · 6.84 KB
title cloudPC: getFrontlineCloudPcAccessState
description Get the access state of a frontline Cloud PC.
author ningjingbogithub
ms.localizationpriority medium
ms.subservice cloud-pc
doc_type apiPageType
ms.date 08/16/2024

cloudPC: getFrontlineCloudPcAccessState

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get the frontlineCloudPcAccessState of a frontline Cloud PC.

This API only supports shared-use licenses. For more information, see cloudPcProvisioningPolicy. Shared-use licenses allow three users per license, with one user signed in at a time. Callers can get the latest frontline Cloud PC accessState and determine whether the frontline Cloud PC is accessible to a user.

If a web client needs to connect to a frontline Cloud PC, the sharedCloudPcAccessState validates the bookmark scenario. If sharedCloudPcAccessState isn't active/activating/standbyMode, the web client shows a bad bookmark.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

To get the frontline Cloud PC access state of the signed-in user using delegated permission:

GET /me/cloudPCs/{cloudPCId}/getFrontlineCloudPcAccessState

To get the frontline Cloud PC access state of a signed-in administrator using delegated permission or application permission:

GET /deviceManagement/virtualEndpoint/cloudPCs/{cloudPCId}/getFrontlineCloudPcAccessState

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a frontlineCloudPcAccessState object in the response body.

If the Cloud PC was provisioned as a dedicated device, this method returns a 400 Bad Request response code.

Examples

Example 1: Get the frontline Cloud PC access state for the signed-in user

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/me/cloudPCs/b0a9cde2-e170-4dd9-97c3-ad1d3328a711/getFrontlineCloudPcAccessState

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#Edm.String",
    "value": "active"
}

Example 2: Get the frontline Cloud PC access state for the administrator

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/b0a9cde2-e170-4dd9-97c3-ad1d3328a711/getFrontlineCloudPcAccessState

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#Edm.String",
    "value": "active"
}