创建 cloudPcOnPremisesConnection

命名空间:microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

创建用于预配云电脑的新 cloudPcOnPremisesConnection 对象。

重要

本地网络连接 已重命名为 Azure 网络连接。 此处 的 cloudPcOnPremisesConnection 对象等效于云电脑产品的 Azure 网络连接

权限

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限

权限类型 权限(从最低特权到最高特权)
委派(工作或学校帐户) CloudPC.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。
Application 不支持。

HTTP 请求

POST /deviceManagement/virtualEndpoint/onPremisesConnections

请求标头

名称 说明
Authorization Bearer {token}。必需。
Content-Type application/json. Required.

请求正文

在请求正文中,提供 cloudPcOnPremisesConnection 对象的 JSON 表示形式。

下表显示了创建 cloudPcOnPremisesConnection 对象时所需的属性。

属性 类型 说明
displayName 字符串 Azure 网络连接的显示名称。
type cloudPcOnPremisesConnectionType 指定如何将预配的云电脑加入Azure Active Directory。 默认值为 hybridAzureADJoin。 可取值为:azureADJoinhybridAzureADJoinunknownFutureValue
subscriptionId 字符串 与租户关联的目标 Azure 订阅的 ID。
adDomainName 字符串 要加入的 Active Directory 域的完全限定域名 (FQDN) 。
adDomainUsername String Active Directory 帐户的用户名 (用户或服务帐户) ,该帐户有权在 Active Directory 中创建计算机对象。 必需格式:admin@contoso.com。
adDomainPassword 字符串 与 adDomainUsername 关联的密码。
resourceGroupId 字符串 目标资源组的 ID。 必需格式:"/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}"。
virtualNetworkId 字符串 目标虚拟网络的 ID。 必需格式:"/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}"。
subnetId String 目标子网的 ID。 必需格式:"/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}"。

响应

如果成功,此方法在响应正文中返回 201 Created 响应代码和 cloudPcOnPremisesConnection 对象。

示例

请求

请求示例如下所示。

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

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "displayName": "test-canary-02",
  "type": "hybridAzureADJoin",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
  "subscriptionName": "CPC customer 001 test subscription",
  "adDomainName": "contoso001.com",
  "adDomainUsername": "dcadmin",
  "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",
  "type": "hybridAzureADJoin",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
  "subscriptionName": "CPC customer 001 test subscription",
  "adDomainName": "contoso001.com",
  "adDomainUsername": "dcadmin",
  "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"
}