名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
特定の cloudPC オブジェクトのプロパティとリレーションシップを読み取ります。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
✅ |
✅ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
CloudPC.Read.All |
CloudPC.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
CloudPC.Read.All |
CloudPC.ReadWrite.All |
HTTP 要求
委任されたアクセス許可を使用して、organizationで指定されたユーザー (サインインしているユーザー) の cloudPC を取得するには、
GET /me/cloudPCs/{id}
GET /users/{userId}/cloudPCs/{id}
委任されたアクセス許可 (サインインしているユーザーが管理者である必要があります) またはアプリケーションのアクセス許可を使用して、organizationで指定された cloudPC を取得するには、
GET /deviceManagement/virtualEndpoint/cloudPCs/{id}
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに役立つ $selectOData クエリ パラメーター をサポートします。
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは応答コード 200 OK と応答本文に cloudPC オブジェクトを返します。
例
例 1: クラウド PC の既定のプロパティを取得する
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc43ec9
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.VirtualEndpoint.CloudPCs["{cloudPC-id}"].GetAsync();
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
cloudPCs, err := graphClient.DeviceManagement().VirtualEndpoint().CloudPCs().ByCloudPCId("cloudPC-id").Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPC result = graphClient.deviceManagement().virtualEndpoint().cloudPCs().byCloudPCId("{cloudPC-id}").get();
const options = {
authProvider,
};
const client = Client.init(options);
let cloudPC = await client.api('/deviceManagement/virtualEndpoint/cloudPCs/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc43ec9')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->cloudPCs()->byCloudPCId('cloudPC-id')->get()->wait();
Import-Module Microsoft.Graph.Beta.DeviceManagement.Administration
Get-MgBetaDeviceManagementVirtualEndpointCloudPc -CloudPCId $cloudPCId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.device_management.virtual_endpoint.cloud_p_cs.by_cloud_p_c_id('cloudPC-id').get()
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "f5ff445f-7488-40f8-8ab9-ee784a9c1f33",
"id": "ac74ae8b-85f7-4272-88cc-54192674ffff",
"displayName": "Demo-0",
"imageDisplayName": "Windows-10 19h1-evd",
"managedDeviceId": "e87f50c7-fa7f-4687-aade-dd45f3d6ffff",
"managedDeviceName": "A00002GI001",
"provisioningPolicyId": "13fa0778-ba00-438a-96d3-488c8602ffff",
"provisioningPolicyName": "Marketing provisioning policy",
"onPremisesConnectionName": "Azure network connection for Marketing",
"servicePlanId": "da5615b4-a484-4742-a019-2d52c91cffff",
"servicePlanName": "standard",
"servicePlanType": "enterprise",
"status": "failed",
"statusDetails": {
"@odata.type": "microsoft.graph.cloudPcStatusDetails",
"code": "internalServerError",
"message": "There was an internal server error. Please contact support xxx.",
"additionalInformation": [
{
"@odata.type": "microsoft.graph.keyValuePair",
"name": "correlationId",
"value": "52367774-cfb7-4e9c-ab51-1b864c31f2d1"
}
]
},
"userPrincipalName": "pmitchell@contoso.com",
"lastModifiedDateTime": "2020-11-03T18:14:34Z",
"gracePeriodEndDateTime": "2020-11-010T20:00:34Z",
"provisioningType": "sharedByUser",
"diskEncryptionState": "notAvailable"
}
例 2: クラウド PC の選択したプロパティを取得する
次の例は、$select OData クエリ パラメーターを使用して cloudPC オブジェクトの選択したプロパティを取得する方法を示しています。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/40cee9d2-03fb-4066-8d35-dbdf2875c33f?$select=id,displayName,imageDisplayName,lastModifiedDateTime,lastRemoteActionResult,lastLoginResult,connectivityResult,allotmentDisplayName,deviceRegionName,productType,provisionedDateTime,sharedDeviceDetail,groupDetail,userDetail
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.VirtualEndpoint.CloudPCs["{cloudPC-id}"].GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Select = new string []{ "id","displayName","imageDisplayName","lastModifiedDateTime","lastRemoteActionResult","lastLoginResult","connectivityResult","allotmentDisplayName","deviceRegionName","productType","provisionedDateTime","sharedDeviceDetail","groupDetail","userDetail" };
});
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
//other-imports
)
requestParameters := &graphdevicemanagement.VirtualEndpointCloudPCsItemRequestBuilderGetQueryParameters{
Select: [] string {"id","displayName","imageDisplayName","lastModifiedDateTime","lastRemoteActionResult","lastLoginResult","connectivityResult","allotmentDisplayName","deviceRegionName","productType","provisionedDateTime","sharedDeviceDetail","groupDetail","userDetail"},
}
configuration := &graphdevicemanagement.VirtualEndpointCloudPCsItemRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
cloudPCs, err := graphClient.DeviceManagement().VirtualEndpoint().CloudPCs().ByCloudPCId("cloudPC-id").Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPC result = graphClient.deviceManagement().virtualEndpoint().cloudPCs().byCloudPCId("{cloudPC-id}").get(requestConfiguration -> {
requestConfiguration.queryParameters.select = new String []{"id", "displayName", "imageDisplayName", "lastModifiedDateTime", "lastRemoteActionResult", "lastLoginResult", "connectivityResult", "allotmentDisplayName", "deviceRegionName", "productType", "provisionedDateTime", "sharedDeviceDetail", "groupDetail", "userDetail"};
});
const options = {
authProvider,
};
const client = Client.init(options);
let cloudPC = await client.api('/deviceManagement/virtualEndpoint/cloudPCs/40cee9d2-03fb-4066-8d35-dbdf2875c33f')
.version('beta')
.select('id,displayName,imageDisplayName,lastModifiedDateTime,lastRemoteActionResult,lastLoginResult,connectivityResult,allotmentDisplayName,deviceRegionName,productType,provisionedDateTime,sharedDeviceDetail,groupDetail,userDetail')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\CloudPCs\Item\CloudPCItemRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new CloudPCItemRequestBuilderGetRequestConfiguration();
$queryParameters = CloudPCItemRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["id","displayName","imageDisplayName","lastModifiedDateTime","lastRemoteActionResult","lastLoginResult","connectivityResult","allotmentDisplayName","deviceRegionName","productType","provisionedDateTime","sharedDeviceDetail","groupDetail","userDetail"];
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->cloudPCs()->byCloudPCId('cloudPC-id')->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.DeviceManagement.Administration
Get-MgBetaDeviceManagementVirtualEndpointCloudPc -CloudPCId $cloudPCId -Property "id,displayName,imageDisplayName,lastModifiedDateTime,lastRemoteActionResult,lastLoginResult,connectivityResult,allotmentDisplayName,deviceRegionName,productType,provisionedDateTime,sharedDeviceDetail,groupDetail,userDetail"
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.device_management.virtual_endpoint.cloud_p_cs.item.cloud_p_c_item_request_builder import CloudPCItemRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = CloudPCItemRequestBuilder.CloudPCItemRequestBuilderGetQueryParameters(
select = ["id","displayName","imageDisplayName","lastModifiedDateTime","lastRemoteActionResult","lastLoginResult","connectivityResult","allotmentDisplayName","deviceRegionName","productType","provisionedDateTime","sharedDeviceDetail","groupDetail","userDetail"],
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.device_management.virtual_endpoint.cloud_p_cs.by_cloud_p_c_id('cloudPC-id').get(request_configuration = request_configuration)
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPC",
"id": "ac74ae8b-85f7-4272-88cc-54192674ffff",
"displayName": "Demo-0",
"imageDisplayName": "Windows-10 19h1-evd",
"lastModifiedDateTime": "2020-11-03T18:14:34Z",
"lastLoginResult": {
"time": "2021-06-23T09:28:32.8260335Z"
},
"lastRemoteActionResult": {
"actionName": "Reboot",
"actionState": "done",
"startDateTime": "2021-06-23T09:28:32.8260335Z",
"lastUpdatedDateTime": "2021-06-23T09:28:32.8260338Z",
"cloudPcId": "662009bc-7732-4f6f-8726-25883518b33e",
"managedDeviceId": "bdc8e6dd-0455-4412-83d9-c818664fe1f1",
"statusDetails": null
},
"connectivityResult": {
"status": "unavailable",
"updatedDatetime": "2022-03-22T10:28:32.8260335Z",
"failedHealthCheckItems": [
{
"displayName": "DomainJoinCheck",
"result": "failure",
"lastHealthCheckDateTime": "2022-03-22T10:28:32.8260335Z",
"additionalDetails": "SessionHost unhealthy: SessionHost is not joined to a domain"
}
]
},
"allotmentDisplayName": null,
"deviceRegionName": "eastus2",
"productType": null,
"provisionedDateTime": "2025-04-23T10:29:57Z",
"sharedDeviceDetail": {
"assignedToUserPrincipalName": "john.doe@contoso.onmicrosoft.com",
"sessionStartDateTime": "2025-09-08T10:10:00Z"
},
"groupDetail": {
"groupId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"groupDisplayName": "Contoso Cloud PC Users"
},
"userDetail": {
"userId": "e798de27-1806-4433-9ac3-4db7a985a12b",
"userDisplayName": "Peter Mitchell"
}
}
Exmaple 3: サインインしているユーザーのクラウド PC の既定のプロパティを取得する
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/me/cloudPCs/36bd4942-0ca8-11ed-861d-0242ac120002
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.CloudPCs["{cloudPC-id}"].GetAsync();
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
cloudPCs, err := graphClient.Me().CloudPCs().ByCloudPCId("cloudPC-id").Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPC result = graphClient.me().cloudPCs().byCloudPCId("{cloudPC-id}").get();
const options = {
authProvider,
};
const client = Client.init(options);
let cloudPC = await client.api('/me/cloudPCs/36bd4942-0ca8-11ed-861d-0242ac120002')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->me()->cloudPCs()->byCloudPCId('cloudPC-id')->get()->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.me.cloud_p_cs.by_cloud_p_c_id('cloudPC-id').get()
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "61204a22-0ca8-11ed-861d-0242ac120002",
"id": "36bd4942-0ca8-11ed-861d-0242ac120002",
"displayName": "Demo-1",
"imageDisplayName": "Windows-10 19h1-evd",
"managedDeviceId": "70341bb0-0ca8-11ed-861d-0242ac120002",
"managedDeviceName": "A00002GI001",
"provisioningPolicyId": "7a3bdee0-0ca8-11ed-861d-0242ac120002",
"provisioningPolicyName": "Marketing provisioning policy",
"onPremisesConnectionName": "Azure network connection for Marketing",
"servicePlanId": "83fca22a-0ca8-11ed-861d-0242ac120002",
"servicePlanName": "standard",
"servicePlanType": "enterprise",
"status": "failed",
"statusDetails": {
"@odata.type": "microsoft.graph.cloudPcStatusDetails",
"code": "internalServerError",
"message": "There was an internal server error. Please contact support xxx.",
"additionalInformation": [
{
"@odata.type": "microsoft.graph.keyValuePair",
"name": "correlationId",
"value": "8fea34e4-0ca8-11ed-861d-0242ac120002"
}
]
},
"userPrincipalName": "pmitchell@contoso.com",
"lastModifiedDateTime": "2020-11-03T18:14:34Z",
"gracePeriodEndDateTime": "2020-11-010T20:00:34Z",
"provisioningType": "dedicated",
"diskEncryptionState": "notAvailable"
}