cloudPcOnPremisesConnection 资源类型

命名空间：microsoft.graph

重要

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

表示可用于为云电脑建立 Azure 网络连接的已定义的 Azure 资源信息集合。

重要

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

方法

方法	返回类型	说明
List onPremisesConnections	cloudPcOnPremisesConnection 集合	列出 cloudPcOnPremisesConnection 对象的属性和关系。
获取 cloudPcOnPremisesConnection	cloudPcOnPremisesConnection	读取 cloudPcOnPremisesConnection 对象的属性和关系。
创建 cloudPcOnPremisesConnection	cloudPcOnPremisesConnection	创建新的 cloudPcOnPremisesConnection 对象。
更新 cloudPcOnPremisesConnection	cloudPcOnPremisesConnection	更新 cloudPcOnPremisesConnection 对象的属性。
删除 cloudPcOnPremisesConnection	无	删除 cloudPcOnPremisesConnection 对象。 无法删除正在使用的连接。
cloudPcOnPremisesConnection 的 RunHealthChecks	无	在 cloudPcOnPremisesConnection 上运行运行状况检查。
updateAdDomainPassword	无	为成功的 cloudPcOnPremisesConnection 更新 Active Directory 域密码。 当 cloudPcOnPremisesConnection 对象的类型为 hybridAzureADJoin时，支持此 API。

属性

属性	类型	说明
adDomainName	String	要加入的 Active Directory 域 (FQDN) 的完全限定域名。 可选。
adDomainPassword	String	与 adDomainUsername 关联的密码。
adDomainUsername	String	Active Directory 帐户的用户名 (有权在 Active Directory 中创建计算机对象的用户或服务帐户) 。 必需格式： admin@contoso.com。 可选。
alternateResourceUrl	String	链接到此 Azure 网络连接的合作伙伴服务资源的接口 URL。 仅在 $select 上返回。
connectionType	cloudPcOnPremisesConnectionType	指定将预配的云电脑联接到Microsoft Entra的方法。 选项azureADJoin指示当前租户中缺少本地 Active Directory (AD) ，导致云电脑设备仅加入到Microsoft Entra。 hybridAzureADJoin选项指示当前租户中是否存在本地 AD，并且云电脑同时加入本地 AD 和 Microsoft Entra。 所选选项还确定可以分配并可以登录到云电脑的用户的类型。 选项 azureADJoin 允许分配仅云用户和混合用户并登录，而 hybridAzureADJoin 仅限于混合用户。 默认值为 hybridAzureADJoin。 可能的值包括 hybridAzureADJoin、azureADJoin、unknownFutureValue。
displayName	String	Azure 网络连接的显示名称。
healthCheckStatus	cloudPcOnPremisesConnectionStatus	在 Azure 网络连接上完成的最新运行状况检查的状态。 例如，如果状态为 passed，则 Azure 网络连接通过了服务运行的所有检查。 可能的值是：pending、running、passed、failed、warning、informational、unknownFutureValue。 此为只读属性。
healthCheckStatusDetails	cloudPcOnPremisesConnectionStatusDetails	连接运行状况检查的详细信息以及相应的结果。 仅在 $select 上返回。 有关如何获取 inUse 属性的示例，请参阅 示例 2：获取 Azure 网络连接的选定属性，包括 healthCheckStatusDetails。 此为只读属性。
healthCheckStatusDetails (已弃用)	cloudPcOnPremisesConnectionStatusDetails	指示连接的运行状况检查及其各自的结果。 仅在 $select 上返回。 有关如何获取 inUse 属性的示例，请参阅 示例 2：获取 Azure 网络连接的选定属性，包括 healthCheckStatusDetails。 此为只读属性。 healthCheckStatusDetails 属性已弃用，并且已于 2024 年 1 月 31 日停止返回数据。 Goind 向前，使用 healthCheckStatusDetail 属性。
healthCheckStatusDetail	cloudPcOnPremisesConnectionStatusDetail	指示在本地连接上执行的运行状况检查结果。 仅在 $select 上返回。 有关如何获取 inUse 属性的示例，请参阅 示例 2：获取 Azure 网络连接的选定属性，包括 healthCheckStatusDetails。 只读。
id	String	Azure 网络连接的唯一标识符。 此为只读属性。
inUse	布尔值	当 为 时 true，Azure 网络连接正在使用中。 当 为 时 false，连接未使用。 无法删除正在使用的连接。 仅在 $select 上返回。 有关如何获取 inUse 属性的示例，请参阅 示例 2：获取 Azure 网络连接的选定属性，包括 healthCheckStatusDetails。 此为只读属性。
managedBy	cloudPcManagementService	指定管理 Azure 网络连接的服务。 可能的值是：windows365、devBox、unknownFutureValue、rpaBox。 必须使用 Prefer: include-unknown-enum-members 请求标头来获取以下值 (此 可演变枚举中的) ： rpaBox。 此为只读属性。
organizationalUnit	String	组织单位 (在其中创建计算机帐户的 OU) 。 如果保留 null，则使用 Active Directory 域中的已知计算机对象容器) (配置为默认的 OU (OU) 。 可选。
organizationalUnit	String	组织单位 (在其中创建计算机帐户的 OU) 。 如果保留 null，则使用 active Directory 域中已知计算机对象容器) (配置为默认的 OU (OU) 。 可选。
virtualNetworkId	String	目标虚拟网络的 ID。 必需格式： /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}。
virtualNetworkLocation	String	指示虚拟目标网络的资源位置。 只读的计算值。
resourceGroupId	String	目标资源组的 ID。 必需格式： /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}。
subnetId	String	目标子网的 ID。 必需格式： /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}。
subscriptionId	String	与租户关联的目标 Azure 订阅的 ID。
subscriptionName	String	目标 Azure 订阅的名称。 此为只读属性。
类型 (已弃用)	cloudPcOnPremisesConnectionType	指定将预配的云电脑联接到Microsoft Entra的方法。 选项azureADJoin指示当前租户中缺少本地 Active Directory (AD) ，导致云电脑设备仅加入到Microsoft Entra。 hybridAzureADJoin选项指示当前租户中是否存在本地 AD，并且云电脑同时加入本地 AD 和 Microsoft Entra。 所选选项还确定可以分配并可以登录到云电脑的用户的类型。 选项 azureADJoin 允许分配仅云用户和混合用户并登录，而 hybridAzureADJoin 仅限于混合用户。 默认值为 hybridAzureADJoin。 可能的值包括 hybridAzureADJoin、azureADJoin、unknownFutureValue。 type 属性在 2024 年 1 月 31 日已弃用并停止返回数据。 Goind 向前，使用 connectionType 属性。

cloudPcManagementService 值

成员	说明
devBox	Azure 网络连接已通过 Project Fidalgo 成功创建。
rpaBox	Azure 网络连接已通过 Power Automate 项目成功创建。
unknownFutureValue	可演变枚举 sentinel 值。 请勿使用。
windows365	Azure 网络连接已通过 Windows 365 成功创建。

cloudPcOnPremisesConnectionType 值

成员	说明
azureADJoin	仅联接到Microsoft Entra ID。 可以分配仅限云的用户和混合用户并登录到云电脑。
hybridAzureADJoin	已加入到本地 Active Directory和Microsoft Entra ID。 只能分配混合用户并登录到云电脑。
unknownFutureValue	可演变枚举 sentinel 值。 请勿使用。

cloudPcOnPremisesConnectionStatus 值

成员	说明
失败	运行状况检查通知客户 Azure 网络连接未正确配置或未正常运行。 预配失败。 客户需要根据 Azure 网络连接提供的指南确定问题并解决问题，才能成功预配。
信息	运行状况检查向客户提供有关云电脑加载项功能（例如单一登录）的当前或关联的先决条件检查的信息。 这不会影响客户的云电脑的预配，但该信息旨在优化用户体验。
通过	运行状况检查通知客户 Azure 网络连接按预期运行。 客户可以毫无问题地预配其云电脑。
等待	已创建并等待运行状况检查。
运行	运行状况检查正在运行。
unknownFutureValue	可演变枚举 sentinel 值。 请勿使用。
警告	运行状况检查通知客户 Azure 网络连接未按照 Microsoft 最佳做法指南（例如终结点连接）进行配置。 在预配云电脑之前，客户应配置云电脑所需的终结点。 它不会影响客户的云电脑预配，但可能会影响客户体验。

关系

无。

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",
  "managedBy": "String",
  "organizationalUnit": "String",
  "resourceGroupId": "String",
  "subnetId": "String",
  "subscriptionId": "String",
  "subscriptionName": "String",
  "type": "String",
  "virtualNetworkId": "String",
  "virtualNetworkLocation": "String"
}