次の方法で共有


cloudPC を取得する

名前空間: 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 要求

委任されたアクセス許可を使用して、組織内の指定されたユーザー (サインインしているユーザー) の cloudPC を取得するには、

GET /me/cloudPCs/{id}
GET /users/{userId}/cloudPCs/{id}

委任されたアクセス許可 (サインインしているユーザーが管理者である必要があります) またはアプリケーションのアクセス許可を使用して、組織内の指定された cloudPC を取得するには、次のようにします。

GET /deviceManagement/virtualEndpoint/cloudPCs/{id}

オプションのクエリ パラメーター

このメソッドは、応答のカスタマイズに役立つ $select OData クエリ パラメーターをサポートします。 一般的な情報については、「OData クエリ パラメーター」を参照してください。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは応答コード 200 OK と応答本文に cloudPC オブジェクトを返します。

例 1: クラウド PC の既定のプロパティを取得する

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc43ec9

応答

次の例は応答を示しています。

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 の選択したプロパティを取得する

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/40cee9d2-03fb-4066-8d35-dbdf2875c33f?$select=id,displayName,imageDisplayName,lastModifiedDateTime,lastRemoteActionResult,lastLoginResult,connectivityResult,allotmentDisplayName,deviceRegionName

応答

次の例は応答を示しています。

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"
}

Exmaple 3: サインインしているユーザーのクラウド PC の既定のプロパティを取得する

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/beta/me/cloudPCs/36bd4942-0ca8-11ed-861d-0242ac120002

応答

次の例は応答を示しています。

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"
}

例 4: ディザスター リカバリー機能の種類でフィルター処理されたクラウド PC を一覧表示する

次の例では、ディザスター リカバリー機能の種類でフィルター処理されたクラウド PC を一覧表示し、特定のパラメーターを選択する方法を示します。

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs?$select=id,displayName,disasterRecoveryCapability&$filter=disasterRecoveryCapability/capabilityType eq 'failover'

応答

次の例は応答を示しています。

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/cloudPCs(id,displayName,disasterRecoveryCapability)",
  "value": [
    {
      "id": "662009bc-7732-4f6f-8726-25883518b33e",
      "displayName": "Demo-0",
      "disasterRecoveryCapability": {
        "primaryRegion": "eastus",
        "secondaryRegion": "westus",
        "capabilityType": "failover"
      }
    },
    {
      "id": "ac74ae8b-85f7-4272-88cc-5419267403ed",
      "displayName": "Demo-1",
      "disasterRecoveryCapability": {
        "primaryRegion": "eastus",
        "secondaryRegion": "westus",
        "capabilityType": "failover"
      }
    }
  ]
}