创建 cloudPcOnPremisesConnection

  • 项目

命名空间：microsoft.graph

重要

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

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

重要

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

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） CloudPC.ReadWrite.All 不可用。
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 不支持。 不支持。

HTTP 请求

POST /deviceManagement/virtualEndpoint/onPremisesConnections

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

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

下表列出了创建 cloudPcOnPremisesConnection 对象时所需的属性。

属性 类型 说明
displayName String Azure 网络连接的显示名称。
connectionType cloudPcOnPremisesConnectionType 指定将预配的云电脑联接到Microsoft Entra的方法。 选项azureADJoin指示当前租户中缺少本地 Active Directory (AD) ，导致云电脑设备仅加入到Microsoft Entra。 hybridAzureADJoin选项指示当前租户中是否存在本地 AD，并且云电脑同时加入本地 AD 和 Microsoft Entra。 所选选项还确定可以分配并可以登录到云电脑的用户的类型。 选项 azureADJoin 允许分配仅云用户和混合用户并登录，而 hybridAzureADJoin 仅限于混合用户。 默认值为 hybridAzureADJoin。 可能的值包括 hybridAzureADJoin、azureADJoin、unknownFutureValue。
subscriptionId String 与租户关联的目标 Azure 订阅的 ID。
adDomainName String 要加入的 Active Directory 域 (FQDN) 的完全限定域名。
adDomainPassword String 与 adDomainUsername 关联的密码。
adDomainUsername String Active Directory 帐户的用户名 (有权在 Active Directory 中创建计算机对象的用户或服务帐户) 。 必需格式： admin@contoso.com。
displayName String Azure 网络连接的显示名称。
resourceGroupId String 目标资源组的 ID。 必需格式：“/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}”。
subnetId String 目标子网的 ID。 必需格式：“/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}”。
类型 (已弃用) cloudPcOnPremisesConnectionType 指定预配的云电脑如何加入到Microsoft Entra ID。 默认值为 hybridAzureADJoin。 可取值为：hybridAzureADJoin、azureADJoin、unknownFutureValue。 type 属性在 2024 年 1 月 31 日已弃用并停止返回数据。 Goind 向前，使用 connectionType 属性。
subscriptionId String 与租户关联的目标 Azure 订阅的 ID。
virtualNetworkId String 目标虚拟网络的 ID。 必需格式：“/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}”。
type cloudPcOnPremisesConnectionType 指定预配的云电脑如何加入到Microsoft Entra ID。 默认值为 hybridAzureADJoin。 可取值为：azureADJoin、hybridAzureADJoin、unknownFutureValue。

响应

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

示例

请求

以下示例显示了一个请求。

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",
  "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",
  "connectionType": "hybridAzureADJoin",
  "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"
}