cloudPcOnPremisesConnection の作成

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

クラウド PC をプロビジョニングするための新しい cloudPcOnPremisesConnection オブジェクトを作成します。

重要

オンプレミスネットワーク接続の名前が Azure ネットワーク接続に変更されました。 cloudPcOnPremisesConnection オブジェクトは、クラウド PC 製品の Azure ネットワーク接続と同等です。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	❌	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	CloudPC.ReadWrite.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	サポートされていません。	サポートされていません。

HTTP 要求

POST /deviceManagement/virtualEndpoint/onPremisesConnections

要求ヘッダー

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

要求本文

要求の本文には、 cloudPcOnPremisesConnection オブジェクトの JSON 表現を指定します。

次の表は、オブジェクトの作成時に指定できるプロパティの一覧です。

ハイブリッド Microsoft Entra 参加接続の場合は、adDomainName と domainJoinCredential プロパティ、または非推奨の adDomainUsername プロパティと adDomainPassword プロパティを指定します。 Microsoft Entra 参加接続には、ドメイン参加資格情報は必要ありません。

domainJoinCredential を指定する場合は、その @odata.type を #microsoft.graph.cloudPcPlainTextDomainJoinCredential または #microsoft.graph.cloudPcKeyVaultDomainJoinCredential に設定します。 domainJoinCredential と非推奨の資格情報プロパティの両方が指定されている場合、domainJoinCredential が優先されます。

プロパティ	型	説明
adDomainName	文字列	参加する Active Directory ドメインの完全修飾ドメイン名 (FQDN)。ハイブリッド Microsoft Entra 参加接続に必要です。
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 ネットワーク接続の表示名。必須です。
domainJoinCredential	cloudPcDomainJoinCredential	Active Directory ドメイン参加資格情報。非推奨の adDomainUsername プロパティと adDomainPassword プロパティが指定されていない限り、ハイブリッド Microsoft Entra 参加接続に必要です。
organizationalUnit	文字列	コンピューターアカウントが作成されている組織単位 (OU)。省略した場合、Active Directory ドメイン内の既定のコンピューターオブジェクトコンテナーが使用されます。省略可能。
resourceGroupId	文字列	ターゲットリソースグループの ID。必要な形式: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}`。必須です。
subnetId	文字列	ターゲットサブネットの ID。必要な形式: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}`。必須です。
subscriptionId	文字列	テナントに関連付けられているターゲット Azure サブスクリプションの ID。必須です。
virtualNetworkId	文字列	対象の仮想ネットワークの ID。必要な形式: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}`。必須です。
adDomainPassword (非推奨)	文字列	adDomainUsername に関連付けられているパスワード。 domainJoinCredential が指定されていない場合、ハイブリッド Microsoft Entra 参加接続には adDomainUsername と共に必要です。このプロパティは非推奨であり、2026 年 12 月 31 日に削除されます。今後は、代わりに domainJoinCredential プロパティを使用します。
adDomainUsername (非推奨)	文字列	Active Directory でコンピューターオブジェクトを作成するアクセス許可を持つ Active Directory アカウントの UPN ( `dcadmin@contoso001.com` など)。 domainJoinCredential が指定されていない場合、ハイブリッド Microsoft Entra 参加接続には adDomainPassword と共に必要です。このプロパティは非推奨であり、2026 年 12 月 31 日に削除されます。今後は、代わりに domainJoinCredential プロパティを使用します。
種類 (非推奨)	cloudPcOnPremisesConnectionType	プロビジョニングされたクラウド PC を Microsoft Entra ID に参加させる方法を指定します。既定値は `hybridAzureADJoin` です。使用可能な値: `hybridAzureADJoin`、`azureADJoin`、`unknownFutureValue`。 type プロパティは非推奨となり、2024 年 1 月 31 日にデータの返しを停止しました。代わりに connectionType を使用してください。

応答

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

例

例 1: adDomainPassword プロパティと adDomainUsername プロパティを使用して接続を作成する

互換性の理由から、次の例では、推奨されていないプロパティを使用して接続を作成する方法を示します。今後は、次の例で示すように domainJoinCredential を使用します。

要求

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

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections
Content-Type: application/json

{
  "displayName": "test-canary-02",
  "connectionType": "hybridAzureADJoin",
  "type": "hybridAzureADJoin",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
  "adDomainName": "contoso001.com",
  "adDomainPassword": "ExamplePassword!42",
  "adDomainUsername": "dcadmin@contoso001.com",
  "organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet"
}

応答

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "id": "ac2ad805-167e-49ee-9bef-196c4ce7ffff",
  "managedBy": "windows365",
  "displayName": "test-canary-02",
  "connectionType": "hybridAzureADJoin",
  "type": "hybridAzureADJoin",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
  "subscriptionName": "CPC customer 001 test subscription",
  "adDomainName": "contoso001.com",
  "adDomainUsername": "dcadmin@contoso001.com",
  "organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
  "healthCheckStatus": "pending"
}

例 2:Azure Key Vault に保存されているパスワードを使用して接続を作成する

次の例では、ドメイン参加ユーザープリンシパル名を直接指定し、パスワードのAzure Key Vault シークレットを参照しています。

要求

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

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections
Content-Type: application/json

{
  "displayName": "test-canary-02",
  "connectionType": "hybridAzureADJoin",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
  "adDomainName": "contoso001.com",
  "organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
  "domainJoinCredential": {
    "@odata.type": "#microsoft.graph.cloudPcKeyVaultDomainJoinCredential",
    "keyVaultResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.KeyVault/vaults/contoso-kv",
    "secretName": "ad-domain-join-password",
    "serviceConnectorResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.Windows365/serviceConnectors/anc-kv-connector",
    "keyVaultIntentConfiguration": {
      "@odata.type": "#microsoft.graph.cloudPcDomainJoinKeyVaultPasswordConfiguration",
      "userIdentity": {
        "@odata.type": "#microsoft.graph.cloudPcDomainJoinPlainTextUserIdentity",
        "domainUserPrincipalName": "dcadmin@contoso001.com"
      }
    }
  }
}

応答

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "id": "ac2ad805-167e-49ee-9bef-196c4ce7ffff",
  "managedBy": "windows365",
  "displayName": "test-canary-02",
  "connectionType": "hybridAzureADJoin",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
  "subscriptionName": "CPC customer 001 test subscription",
  "adDomainName": "contoso001.com",
  "adDomainUsername": "dcadmin@contoso001.com",
  "domainJoinCredential": {
    "@odata.type": "#microsoft.graph.cloudPcKeyVaultDomainJoinCredential",
    "keyVaultResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.KeyVault/vaults/contoso-kv",
    "secretName": "ad-domain-join-password",
    "serviceConnectorResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.Windows365/serviceConnectors/anc-kv-connector",
    "keyVaultIntentConfiguration": {
      "@odata.type": "#microsoft.graph.cloudPcDomainJoinKeyVaultPasswordConfiguration",
      "userIdentity": {
        "@odata.type": "#microsoft.graph.cloudPcDomainJoinPlainTextUserIdentity",
        "domainUserPrincipalName": "dcadmin@contoso001.com"
      }
    }
  },
  "organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
  "healthCheckStatus": "pending"
}

例 3: プレーンテキストの資格情報を使用して接続を作成する

次の例では、 domainJoinCredential を通じてドメイン参加ユーザープリンシパル名とパスワードが提供されますが、非推奨の資格情報プロパティは指定されていません。

要求

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

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections
Content-Type: application/json

{
  "displayName": "Contoso plain-text connection",
  "connectionType": "hybridAzureADJoin",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
  "adDomainName": "contoso001.com",
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
  "domainJoinCredential": {
    "@odata.type": "#microsoft.graph.cloudPcPlainTextDomainJoinCredential",
    "domainUserPrincipalName": "dcadmin@contoso001.com",
    "domainPassword": "ExamplePassword!42"
  }
}

応答

次の例は応答を示しています。 domainPassword プロパティは返されません。

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "id": "5ab42e01-828b-4a80-8a5f-e80bd4b78534",
  "managedBy": "windows365",
  "displayName": "Contoso plain-text connection",
  "connectionType": "hybridAzureADJoin",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
  "adDomainName": "contoso001.com",
  "adDomainUsername": "dcadmin@contoso001.com",
  "domainJoinCredential": {
    "@odata.type": "#microsoft.graph.cloudPcPlainTextDomainJoinCredential",
    "domainUserPrincipalName": "dcadmin@contoso001.com"
  },
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/CustomerRG/providers/Microsoft.Network/virtualNetworks/canary01-MyVNET/subnets/canary01-Subnet",
  "healthCheckStatus": "pending"
}

フィードバック

このページはお役に立ちましたか?

最終更新: 2026-10-30

cloudPcOnPremisesConnection の作成

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

例 1: adDomainPassword プロパティと adDomainUsername プロパティを使用して接続を作成する

要求

応答

例 2:Azure Key Vault に保存されているパスワードを使用して接続を作成する

要求

応答

例 3: プレーンテキストの資格情報を使用して接続を作成する

要求

応答

フィードバック

その他のリソース