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