cloudPC リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
クラウドで管理される仮想デスクトップを表します。 このクラウド PC は、Intuneにも登録され、Microsoft Endpoint Manager ポータルを介して管理されるため、クラウド PC には対応するIntuneマネージド デバイス ID も含まれます。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List cloudPCs | cloudPC コレクション | クラウド PC オブジェクトのプロパティとリレーションシップを一覧表示します。 |
| cloudPC を取得する | cloudPC | クラウド PC オブジェクトのプロパティとリレーションシップを読み取ります。 |
| プロビジョニングされたクラウド PC を取得する | cloudPC コレクション | Microsoft Entra ユーザー グループのユーザーに対して、特定のサービス プランのすべてのプロビジョニング済みクラウド PC を取得します。 |
| ユーザー アカウントの種類を変更する | なし | 特定のクラウド PC 上のユーザーのアカウントの種類を変更します。 |
| 猶予期間の終了 | なし | クラウド PC オブジェクトの猶予期間を終了します。 |
| 電源オン | なし | 特定の Windows Frontline Cloud PC オブジェクトの電源をオンにします。 このアクションは、MEM 管理シナリオをサポートします。 |
| 電源オフ | なし | 特定の Windows Frontline Cloud PC オブジェクトの電源をオフにします。 このアクションは、MEM 管理シナリオをサポートします。 |
| 再起動 | なし | 特定のクラウド PC オブジェクトを再起動します。 |
| Rename | なし | 特定のクラウド PC オブジェクトの名前を変更します。 この API を使用して、Cloud PC エンティティの displayName を更新します。 |
| 再プロビジョニング | なし | クラウド PC オブジェクトを再プロビジョニングします。 |
| Resize | なし | 新しい仮想 CPU (vCPU) とストレージ サイズを使用して、既存のクラウド PC を構成にアップグレードまたはダウングレードします。 |
| Start | なし | 特定のクラウド PC を起動します。 現時点では、Windows 365 Frontlineクラウド PC のみがサポートされています。 |
| Stop | なし | 特定のクラウドを停止します。 現時点では、Windows 365 Frontlineクラウド PC のみがサポートされています。 |
| トラブルシューティング | なし | 特定のクラウド PC オブジェクトのトラブルシューティングを行います。 この API を使用して、クラウド PC とセッション ホストの正常性状態をチェックします。 |
| 復元 | なし | クラウド PC オブジェクトをスナップショットから以前の状態に復元します。 |
| レビューの状態を設定する | なし | クラウド PC ID を使用して、特定のクラウド PC デバイスのレビュー状態を設定します。 |
| レビューの状態を取得する | cloudPcReviewStatus | クラウド PC の レビュー状態 を取得します。 |
| ユーザーの一覧 | cloudPC コレクション | サインインしているユーザーに属性が設定されているクラウド PC デバイスを一覧表示します。 |
| Get launch info | cloudPcLaunchInfo | 特定のクラウド PC の cloudPCLaunchInfo を取得します。 |
| 接続履歴を取得する | cloudPcConnectivityEvent コレクション | クラウド PC の接続履歴を取得します。 |
| サポートされているリモート アクションを取得する | cloudPcRemoteActionCapability コレクション | アクションの名前と機能など、特定のクラウド PC デバイスでサポートされているクラウド PC リモート アクションの一覧を取得します。 |
| リモート アクションの結果を取得する | cloudPcRemoteActionResult コレクション | リモート アクションの結果を取得し、関連付けられているクラウド PC デバイスで実行された特定のリモート アクションの状態をチェックします。 |
| パートナー エージェントのインストールを再試行する | なし | クラウド PC へのインストールに失敗したパートナー エージェントのインストールを再試行します。 |
| 一括サイズ変更の検証 | cloudPcResizeValidateResult コレクション | 一連のクラウド PC デバイスが、一括サイズ変更の要件を満たしていることを検証します。 |
| スナップショットの作成 | なし | 特定のクラウド PC デバイスのスナップショットを作成します。 |
| スナップショットを取得する | cloudPcSnapshot コレクション | クラウド PC の cloudPcSnapshot リソースの一覧を取得します。 |
| 現場のアクセス状態を取得する | frontlineCloudPcAccessState | 現場のクラウド PC のアクセス状態を取得します。 使用可能な値: unassigned、noLicensesAvailable、activationFailed、active、activating、standbyMode、unknownFutureValue。
noLicensesAvailable メンバーは非推奨となり、2024 年 9 月 30 日に復帰を停止します。 |
| リモート アクションの一括再プロビジョニング (非推奨) | なし | マネージド デバイス ID を使用して一連のクラウド PC デバイスIntune一括再プロビジョニングします。 この API は非推奨であり、2025 年 2 月 28 日にデータの返しを停止します。 今後は、 cloudPcBulkReprovision リソースを 使用します。 |
| 一括サイズ変更 (非推奨) | cloudPcRemoteActionResult コレクション | 検証に成功したクラウド PC のグループのサイズを変更するには、一括サイズ変更アクションを実行します (cloudPC: validateBulkResize)。 サイズを変更できないデバイスがある場合は、"サイズ変更に失敗しました" というラベルが付けられますが、残りのデバイスはサイズ変更プロセスに provisioned されます。 この API は非推奨であり、2025 年 2 月 28 日にデータの返しを停止します。 今後は、 cloudPcBulkResize リソースを使用します。 |
| リモート アクションの一括復元 (非推奨) | cloudPcBulkRemoteActionResult | Intuneマネージド デバイスの ID と復元ポイントの日付と時刻を含む 1 つの要求を使用して、複数のクラウド PC デバイスを復元します。 この API は非推奨であり、2025 年 2 月 28 日にデータの返しを停止します。 今後は、 cloudPcBulkRestore リソースを 使用します。 |
| リモート アクションの結果を取得する (非推奨) | cloudPcRemoteActionResult | クラウド PC デバイスのクラウド PC で指定されたリモート アクションの結果を確認します。 この API は非推奨であり、2025 年 2 月 28 日にデータの返しを停止します。 今後は、 retrieveCloudPcRemoteActionResults API を 使用します。 |
| レビューの状態を取得する (非推奨) | cloudPcReviewStatus | managedDeviceId を使用して、特定のクラウド PC デバイスのレビュー状態を取得します。 この API は非推奨であり、2025 年 2 月 28 日にデータの返しを停止します。 今後は、 cloudPC: retrieveReviewStatus API を 使用します。 |
| レビューの状態を設定する (非推奨) | なし | マネージド デバイス ID を使用して、特定のクラウド PC デバイスのレビュー状態を設定します。 この API は非推奨であり、2025 年 2 月 28 日にデータの返しを停止します。 今後は、 cloudPC: setReviewStatus API を 使用します。 |
| 一括セットレビューの状態 (非推奨) | なし | 複数のクラウド PC デバイスのレビュー状態を、Intuneマネージド デバイスの ID を含む 1 つの要求で設定します。 この API は非推奨であり、2025 年 2 月 28 日にデータの返しを停止します。 今後は、 cloudPcBulkSetReviewStatus リソースを 使用します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| aadDeviceId | String | クラウド PC のMicrosoft Entraデバイス ID。 |
| allotmentDisplayName | String | 割り当て名は、テナント ライセンスを小さなバッチまたはグループに分割し、特定の割り当てで使用できるライセンスの数を制限するのに役立ちます。
provisioningType がdedicatedされると、割り当て名がnullされます。 読み取り専用です。 |
| connectivityResult | cloudPcConnectivityResult | 接続の正常性チェック、更新されたタイムスタンプやクラウド PC を接続できるかどうかなど、クラウド PC の結果です。 |
| deviceRegionName | String | クラウド PC が現在プロビジョニングされている地理的リージョンの名前。 たとえば、 westus3、 eastus2、 southeastasiaなどです。 読み取り専用です。 |
| disasterRecoveryCapability | cloudPcDisasterRecoveryCapability | プライマリ リージョン、セカンダリ リージョン、機能の種類など、クラウド PC のディザスター リカバリーの状態。 既定値は、ディザスター リカバリー設定が無効になっていることを示す null です。
disasterRecoveryCapability プロパティを使用して応答を受信するには、要求 URL にdisasterRecoveryCapability/{subProperty}して$selectして$filterします。 詳細については、「 例 4: ディザスター リカバリー機能の種類でフィルター処理されたクラウド PC を一覧表示する」を参照してください。 読み取り専用です。 |
| diskEncryptionState | cloudPcDiskEncryptionState | クラウド PC に適用されたディスク暗号化。 使用可能な値: notAvailable、notEncrypted、encryptedUsingPlatformManagedKey、encryptedUsingCustomerManagedKey、unknownFutureValue。 |
| displayName | String | クラウド PC の表示名。 |
| gracePeriodEndDateTime | DateTimeOffset | 猶予期間が終了し、再プロビジョニングまたはプロビジョニング解除が行われる日時。 状態が inGracePeriodされている場合にのみ必要です。 タイムスタンプは ISO 8601 形式と協定世界時 (UTC) で表示されます。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| id | String | クラウド PC の一意の識別子。 読み取り専用です。 |
| imageDisplayName | String | クラウド PC 上にある OS イメージの名前。 |
| lastLoginResult | cloudPcLoginResult | クラウド PC の最後のログイン結果。 たとえば、「 { "time": "2014-01-01T00:00:00Z"} 」のように入力します。 |
| lastModifiedDateTime | DateTimeOffset | クラウド PC の最終変更日時。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| lastRemoteActionResult | cloudPcRemoteActionResult | エンタープライズ クラウド PC の最後のリモート アクションの結果。 サポートされているリモート アクションは、 Reboot、 Rename、 Reprovision、 Restore、 Troubleshootです。 |
| managedDeviceId | String | クラウド PC のIntuneデバイス ID。 |
| managedDeviceName | String | クラウド PC のIntuneデバイス名。 |
| onPremisesConnectionName | String | クラウド PC のプロビジョニング中に適用される Azure ネットワーク接続。 |
| osVersion | cloudPcOperatingSystem | クラウド PC でプロビジョニングするオペレーティング システム (OS) のバージョン。 可能な値は windows10、windows11、unknownFutureValue です。 |
| partnerAgentInstallResults | cloudPcPartnerAgentInstallResult コレクション | クラウド PC 上のすべてのパートナー エージェントのインストール状態の結果。 |
| powerState | cloudPcPowerState | クラウド PC の電源状態。 使用可能な値: running、poweredOff、unknown。 このプロパティは、シフトワーククラウドPCのみをサポートします。 |
| provisioningPolicyId | String | クラウド PC のプロビジョニング ポリシー ID。 |
| provisioningPolicyName | String | クラウド PC のプロビジョニング中に適用されるプロビジョニング ポリシー。 |
| provisioningType | cloudPcProvisioningType | このポリシーを使用してクラウド PC をプロビジョニングするときに使用するライセンスの種類。 使用可能な値は、 dedicated、 shared、 unknownFutureValue、sharedByUser、 sharedByEntraGroupです。
Prefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型から次の値を取得する必要があります:sharedByUser、sharedByEntraGroup。 既定値は dedicated です。 注意: shared メンバーは非推奨となり、2027 年 4 月 30 日に戻りを停止します。今後は、 sharedByUser メンバーを使用します。 |
| servicePlanId | String | クラウド PC のサービス プラン ID。 |
| servicePlanName | String | クラウド PC のサービス プラン名。 |
| servicePlanType | cloudPcServicePlanType | クラウド PC のサービス プランの種類。 |
| status | microsoft.graph.cloudPcStatus | クラウド PC の状態。 使用できる値は、 notProvisioned、 provisioning、 provisioned、 inGracePeriod、 deprovisioning、 failed、 provisionedWithWarnings、 resizing、 restoring、 pendingProvision、 unknownFutureValue、 movingRegion、 resizePendingLicense、 modifyingSingleSignOn、 preparingです。
Prefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型から次の値を取得する必要があります:movingRegion、resizePendingLicense、modifyingSingleSignOn、preparing。 |
| statusDetails (非推奨) | cloudPcStatusDetails | クラウド PC の状態の詳細。 たとえば、「 { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null } 」のように入力します。 このプロパティは非推奨であり、2024 年 8 月 31 日からサポートされなくなります。 代わりに statusDetail を使用します。 |
| statusDetail | cloudPcStatusDetail | クラウド PC に関連付けられている詳細な状態 (エラー/警告コード、エラー/警告メッセージ、additionalInformation など) を示します。 たとえば、「 { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null } 」のように入力します。 |
| connectionSetting | cloudPcConnectionSetting | クラウド PC の接続設定。 使用可能な値: enableSingleSignOn。 読み取り専用です。 |
| userAccountType | cloudPcUserAccountType | プロビジョニングされたクラウド PC 上のユーザーのアカウントの種類。 可能な値は standardUser、administrator、unknownFutureValue です。 |
| userPrincipalName | String | クラウド PC に割り当てられているユーザーのユーザー プリンシパル名 (UPN)。 |
cloudPcDiskEncryptionState 値
| メンバー | 説明 |
|---|---|
| notAvailable | クラウド PC がプロビジョニングされていないか、暗号化が使用できない状態です。 |
| notEncrypted | クラウド PC は暗号化する必要がありますが、暗号化はまだ行われていません (予約済み、実行しないでください)。 |
| encryptedUsingPlatformManagedKey | クラウド PC は、プラットフォームで管理されるキーを使用して暗号化されます。 カスタマー マネージド キーが有効になっていない場合、このメンバーは既定値です。 |
| encryptedUsingCustomerManagedKey | クラウド PC は、カスタマー マネージド キーを使用して暗号化されます。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
cloudPcPowerState 値
| メンバー | 説明 |
|---|---|
| ランニング | クラウド PC の状態が実行中です。 |
| poweredOff | クラウド PC の状態がオフになっています。 |
| 不明 | クラウド PC の状態が不明です。 |
cloudPcStatus 値
次の表に、 進化可能な列挙体のメンバーを示します。
Prefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型で次の値を取得する必要があることに注意してください。movingRegion、resizePendingLicense、modifyingSingleSignOn、preparing。
| メンバー | 説明 |
|---|---|
| notProvisioned | クラウド PC はまだプロビジョニングされていません。 |
| プロビジョニング | クラウド PC のプロビジョニングが進行中です。 |
| 準備済み | クラウド PC がプロビジョニングされ、ユーザーがアクセスできます。 |
| inGracePeriod | クラウド PC は、プロビジョニング解除前の 1 週間の猶予期間にあります。 |
| プロビジョニング解除 | クラウド PC はプロビジョニング解除中です。 |
| 失敗 しました | クラウド PC での操作に失敗しました。 |
| provisionedWithWarnings | クラウド PC がプロビジョニングされ、エンド ユーザーは警告とともにアクセスできます。 ユーザーはこのクラウド PC を引き続き使用できます。 |
| サイズ | クラウド PC のサイズが変更されています。 |
| pendingProvision | プロビジョニングはクラウド PC で保留中です。 この場合、猶予期間のクラウド PC の数は、使用可能なライセンスの合計数を超えています。 |
| 復元 | クラウド PC が復元中です。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
| movingRegion | クラウド PC がリージョン間で移動されていることを示します。 |
| resizePendingLicense | クラウド PC のサイズ変更プロセスが開始されたが、ターゲット ライセンスが特定されていないため完了できなかったことを示します。 現在、ライセンスの問題を解決するための顧客のアクションが待っています。 |
| modifyingSingleSignOn | クラウド PC がシングル サインオン設定を更新していることを示します。 |
| 準備 | プロビジョニング状態の後に、クラウド PC が IT 管理者が定義した構成 (アプリケーション、構成、セキュリティ) を使用して準備していることを示します。Frontline 共有デバイスにのみ適用されます。 |
frontlineCloudPcAccessState 値
| メンバー | 説明 |
|---|---|
| 未割り当て | クラウド PC が共有使用ライセンスを使用しない場合は、未割り当てに設定します。 既定値は unassigned です。 |
| noLicensesAvailable (非推奨) | すべての共有使用ライセンスが使用中であることを示します。
noLicensesAvailable メンバーは非推奨となり、2024 年 9 月 30 日に復帰を停止します。 |
| activationFailed | ユーザーが現場のクラウド PC を要求した後に、現場のクラウド PC のライセンス認証が失敗したことを示します。 |
| アクティブ | 現場のクラウド PC が、共有使用ライセンスが割り当てられたアクティブな状態にあり、ユーザーがクラウド PC に接続できることを示します。 |
| アクティブ 化 | ユーザーがクラウド PC とサービスの接続を要求したことを示します。 |
| standbyMode | クラウド PC がシャットダウンされて割り当て解除される前に、現場のクラウド PC がスタンバイ状態であることを示します。 スタンバイ状態の最前線のクラウド PC には、引き続きユーザーがアクセスできます。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
リレーションシップ
なし。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "String",
"allotmentDisplayName": "String",
"connectivityResult": "String",
"deviceRegionName": "String",
"disasterRecoveryCapability": {"@odata.type": "microsoft.graph.cloudPcDisasterRecoveryCapability"},
"diskEncryptionState": "String",
"displayName": "String",
"gracePeriodEndDateTime": "String (timestamp)",
"id": "String (identifier)",
"imageDisplayName": "String",
"lastLoginResult": "String",
"lastModifiedDateTime": "String (timestamp)",
"lastRemoteActionResult": "String",
"managedDeviceId": "String",
"managedDeviceName": "String",
"onPremisesConnectionName": "String",
"powerState": "String",
"osVersion": "String",
"partnerAgentInstallResults": "String",
"provisioningPolicyId": "String",
"provisioningPolicyName": "String",
"provisioningType": "String",
"servicePlanId": "String",
"servicePlanName": "String",
"servicePlanType": "String",
"status": "String",
"userAccountType": "String",
"userPrincipalName": "String"
}