名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
クラウド PC の Azure ネットワーク接続を確立するために使用できる Azure リソース情報の定義済みのコレクションを表します。
重要
オンプレミス ネットワーク接続の名前が Azure ネットワーク接続に変更されました。 cloudPcOnPremisesConnection オブジェクトは、クラウド PC 製品の Azure ネットワーク接続と同等です。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | cloudPcOnPremisesConnection コレクション | cloudPcOnPremisesConnection オブジェクトのプロパティと関係を一覧表示します。 |
| Get | cloudPcOnPremisesConnection | cloudPcOnPremisesConnection オブジェクトのプロパティと関係を読み取ります。 |
| Create | cloudPcOnPremisesConnection | 新しい cloudPcOnPremisesConnection オブジェクトを作成します。 |
| Update | cloudPcOnPremisesConnection | cloudPcOnPremisesConnection オブジェクトのプロパティを更新します。 |
| Delete | なし | cloudPcOnPremisesConnection オブジェクトを削除します。 使用中の接続は削除できません。 |
| 正常性チェックを実行する | なし | cloudPcOnPremisesConnection で正常性チェックを実行します。 |
| Active Directory ドメイン パスワードの更新 | なし | cloudPcOnPremisesConnection を成功させるために、Active Directory ドメイン パスワードを更新します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| adDomainName | 文字列 | 参加する Active Directory ドメインの完全修飾ドメイン名 (FQDN)。 省略可能。 |
| adDomainPassword | 文字列 | adDomainUsername に関連付けられているパスワード。 |
| adDomainUsername | 文字列 | Active Directory でコンピューター オブジェクトを作成するアクセス許可を持つ Active Directory アカウント (ユーザーまたはサービス アカウント) のユーザー名。 必要な形式: admin@contoso.com。 省略可能。 |
| alternateResourceUrl | 文字列 | この Azure ネットワーク接続にリンクするパートナー サービスのリソースのインターフェイス URL。 取得に $select が必要です。 |
| connectionType | cloudPcOnPremisesConnectionType | プロビジョニングされたクラウド PC を Microsoft Entra に参加させる方法を指定します。
azureADJoin オプションは、現在のテナントにオンプレミスの Active Directory (AD) がないことを示します。これにより、クラウド PC デバイスは Microsoft Entra にのみ参加します。
hybridAzureADJoin オプションは、現在のテナントにオンプレミス AD があり、クラウド PC がオンプレミス AD とMicrosoft Entraの両方に参加していることを示します。 選択したオプションによって、割り当て可能でクラウド PC にサインインできるユーザーの種類も決まります。
azureADJoin オプションでは、クラウド専用ユーザーとハイブリッド ユーザーの両方を割り当ててサインインできますが、hybridAzureADJoin はハイブリッド ユーザーのみに制限されます。 既定値は hybridAzureADJoin です。 使用可能な値: hybridAzureADJoin、azureADJoin、unknownFutureValue。 |
| displayName | 文字列 | Azure ネットワーク接続の表示名。 |
| healthCheckPaused | ブール型 | ネットワークまたはドメイン構成の定期的な正常性チェックが一時停止かアクティブかを示します。
false ネットワークまたはドメイン構成の定期的な正常性チェックが現在アクティブな場合。
true チェックが一時停止された場合。
onPremisesNetworkConnection リソースに対して作成または更新操作を実行する場合、この値は 4 週間falseに設定されます。 ネットワークまたはドメイン構成で正常性チェックを再試行すると、この値は 2 週間falseに設定されます。
onPremisesNetworkConnection リソースが過去 4 週間に provisioningPolicy でアタッチされているか、クラウド PC で使用されている場合、healthCheckPaused は false に設定されます。 読み取り専用です。 既定値は false です。 |
| healthCheckStatus | cloudPcOnPremisesConnectionStatus | Azure ネットワーク接続で実行された最新の正常性チェックの状態。 たとえば、状態が passed の場合、Azureネットワーク接続はサービスによって実行されるすべてのチェックに合格しています。 使用可能な値: pending、running、passed、failed、warning、informational、unknownFutureValue。 読み取り専用です。 |
| healthCheckStatusDetails | cloudPcOnPremisesConnectionStatusDetails | 接続のヘルス チェックとそれに対応する結果の詳細。
$select でのみ返されます。
inUse プロパティを取得する方法を示す例については、「例 2: healthCheckStatusDetails を含む、Azure ネットワーク接続の選択されたプロパティを取得する」を参照してください。 読み取り専用です。 |
| healthCheckStatusDetail | cloudPcOnPremisesConnectionStatusDetail | オンプレミス接続で実行された正常性チェックの結果を示します。
$select でのみ返されます。
inUse プロパティを取得する方法を示す例については、「例 2: healthCheckStatusDetails を含む、Azure ネットワーク接続の選択されたプロパティを取得する」を参照してください。 読み取り専用です。 |
| id | 文字列 | Azure ネットワーク接続の一意識別子。 読み取り専用です。 |
| inUse | ブール型 |
trueときは、Azure ネットワーク接続が使用されています。
false の場合、接続は使用されていません。 使用中の接続は削除できません。
$select でのみ返されます。
inUse プロパティを取得する方法を示す例については、「例 2: healthCheckStatusDetails を含む、Azure ネットワーク接続の選択されたプロパティを取得する」を参照してください。 読み取り専用です。 |
| inUseByCloudPc | ブール型 | クラウド PC がこのオンプレミス ネットワーク接続を使用しているかどうかを示します。
true 少なくとも 1 台のクラウド PC で使用している場合。 それ以外の場合は、 false。 読み取り専用です。 既定値は false です。 |
| managedBy | cloudPcManagementService | Azure ネットワーク接続を管理するサービスを指定します。 使用可能な値: windows365、devBox、unknownFutureValue、rpaBox、microsoft365Opal、microsoft365BizChat。
Prefer: include-unknown-enum-members 要求ヘッダーを使用して、この進化可能な列挙型のメンバーを取得します: rpaBox、microsoft365Opal、microsoft365BizChat。 読み取り専用です。 |
| organizationalUnit | 文字列 | コンピューター アカウントが作成されている組織単位 (OU)。 null のままにすると、Active Directory ドメイン (OU) で既定 (既知のコンピューター オブジェクト コンテナー) として構成された OU が使用されます。 省略可能。 |
| resourceGroupId | 文字列 | ターゲット リソース グループの ID。 必要な形式: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}。 |
| scopeIds | String collection | 対応するアクセス許可のスコープ ID。 現在、これは Intune スコープ タグ ID です。 |
| subnetId | 文字列 | ターゲット サブネットの ID。 必要な形式: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}。 |
| subscriptionId | 文字列 | テナントに関連付けられているターゲット Azure サブスクリプションの ID。 |
| subscriptionName | 文字列 | 対象の Azure サブスクリプションの名前。 読み取り専用です。 |
| virtualNetworkId | 文字列 | 対象の仮想ネットワークの ID。 必要な形式: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}。 |
| virtualNetworkLocation | 文字列 | 仮想ターゲット ネットワークのリソースの場所を示します。 読み取り専用の計算値。 |
| healthCheckStatusDetails (非推奨) | cloudPcOnPremisesConnectionStatusDetails | 接続のヘルス チェックとそれぞれの結果を示します。
$select でのみ返されます。
inUse プロパティを取得する方法を示す例については、「例 2: healthCheckStatusDetails を含む、Azure ネットワーク接続の選択されたプロパティを取得する」を参照してください。 読み取り専用です。
healthCheckStatusDetails プロパティは非推奨となり、2024 年 1 月 31 日にデータの返しを停止しました。 以降は、 healthCheckStatusDetail プロパティを使用します。 |
| 種類 (非推奨) | cloudPcOnPremisesConnectionType | プロビジョニングされたクラウド PC を Microsoft Entra に参加させる方法を指定します。
azureADJoin オプションは、現在のテナントにオンプレミスの Active Directory (AD) がないことを示します。これにより、クラウド PC デバイスは Microsoft Entra にのみ参加します。
hybridAzureADJoin オプションは、現在のテナントにオンプレミス AD があり、クラウド PC がオンプレミス AD とMicrosoft Entraの両方に参加していることを示します。 選択したオプションによって、割り当て可能でクラウド PC にサインインできるユーザーの種類も決まります。
azureADJoin オプションでは、クラウド専用ユーザーとハイブリッド ユーザーの両方を割り当ててサインインできますが、hybridAzureADJoin はハイブリッド ユーザーのみに制限されます。 既定値は hybridAzureADJoin です。 使用可能な値: hybridAzureADJoin、azureADJoin、unknownFutureValue。
type プロパティは非推奨となり、2024 年 1 月 31 日にデータの返しを停止しました。 以降は、 connectionType プロパティを使用します。 |
| subnetPrivateIpDetail | cloudPcOnPremisesConnectionSubnetIpDetail | サブネットに関連付けられているプライベート IP アドレスに関する詳細情報が含まれています。
$select でのみ返されます。
$select を使用して特定のプロパティを取得する方法を示す例については、「例 2: healthCheckStatusDetails を含む、Azure ネットワーク接続の選択されたプロパティを取得する」を参照してください。 読み取り専用です。 |
cloudPcManagementService 値
| メンバー | 説明 |
|---|---|
| windows365 | Azure ネットワーク接続は、Windows 365 で正常に作成されました。 |
| devBox | Azure ネットワーク接続は Project Fidalgo を通じて正常に作成されました。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
| rpaBox | Azure ネットワーク接続は、Power Automate プロジェクトを通じて正常に作成されました。 |
| microsoft365Opal | Project Opal を通じてクラウド PC Azure ネットワーク接続が正常に作成されたことを示します。 |
| microsoft365BizChat | Project Biz Chat を通じて Cloud PC Azure ネットワーク接続が正常に作成されたことを示します。 |
cloudPcOnPremisesConnectionType の値
| メンバー | 説明 |
|---|---|
| azureADJoin | Microsoft Entra ID にのみ参加しています。 クラウド専用ユーザーとハイブリッド ユーザーに割り当てて、クラウド PC にサインインできます。 |
| hybridAzureADJoin | オンプレミスの Active Directory と Microsoft Entra ID に参加しています。 ハイブリッド ユーザーのみを割り当てて、クラウド PC にサインインできます。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
cloudPcOnPremisesConnectionStatus の値
| メンバー | 説明 |
|---|---|
| 失敗 | 正常性チェックは、Azure ネットワーク接続が正しく構成されていない、または機能していないことを顧客に通知します。 プロビジョニングに失敗しました。 顧客は問題を特定し、プロビジョニングを正常に行うためには、Azure ネットワーク接続によって提供されるガイダンスを使用して解決する必要があります。 |
| 情報 | 正常性チェックは、シングル サインオンなどのクラウド PC アドオン機能に関する現在または関連する前提条件チェックに関する情報を顧客に提供します。 情報の正常性チェックは、顧客のクラウド PC のプロビジョニングには影響しません。 この情報は、ユーザー エクスペリエンスを最適化することを目的としています。 |
| 成功 | 正常性チェックは、Azure ネットワーク接続が意図したとおりに動作していることを顧客に通知します。 顧客は問題なくクラウド PC をプロビジョニングできます。 |
| 保留中 | 作成され、正常性チェックを待機しています。 |
| 実行中 | 正常性チェックが実行中です。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
| warning | 正常性チェックは、Azure ネットワーク接続がエンドポイント接続などの Microsoft ベスト プラクティス ガイダンスに従って構成されていないことを顧客に通知します。 お客様は、クラウド PC をプロビジョニングする前に、クラウド PC に必要なエンドポイントを構成する必要があります。 お客様のクラウド PC のプロビジョニングには影響しませんが、お客様のエクスペリエンスに影響を与える可能性があります。 |
リレーションシップ
なし。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"adDomainName": "String",
"adDomainPassword": "String",
"adDomainUsername": "String",
"alternateResourceUrl": "String",
"connectionType": "String",
"displayName": "String",
"healthCheckPaused": "Boolean",
"healthCheckStatus": "String",
"healthCheckStatusDetail": { "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionStatusDetail" },
"healthCheckStatusDetails": { "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionStatusDetails" },
"id": "String (identifier)",
"inUse": "Boolean",
"inUseByCloudPc": "Boolean",
"managedBy": "String",
"organizationalUnit": "String",
"resourceGroupId": "String",
"scopeIds": ["String"],
"subnetId": "String",
"subnetPrivateIpDetail": { "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionSubnetIpDetail" },
"subscriptionId": "String",
"subscriptionName": "String",
"type": "String",
"virtualNetworkId": "String",
"virtualNetworkLocation": "String"
}