cloudPcOnPremisesConnection 资源类型

命名空间：microsoft.graph

重要

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

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

重要

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

方法

方法	返回类型	说明
列出 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 上返回。
displayName	String	Azure 网络连接的显示名称。
healthCheckStatus	cloudPcOnPremisesConnectionStatus	在 Azure 网络连接上执行的最新运行状况检查的状态。 例如，如果状态为 passed，则 Azure 网络连接已通过服务运行的所有检查。 可取值为：pending、running、passed、failed、unknownFutureValue。 只读。
healthCheckStatusDetails	cloudPcOnPremisesConnectionStatusDetails	连接运行状况检查的详细信息和相应的结果。 仅在 $select 上返回。 有关演示如何获取 inUse 属性的示例，请参阅 示例 2：获取 Azure 网络连接的选定属性，包括 healthCheckStatusDetails。 只读。
id	String	Azure 网络连接的唯一标识符。 只读。
inUse	Boolean	当 trueAzure 网络连接正在使用时。 当 false连接未使用时。 无法删除正在使用的连接。 仅在 $select 上返回。 有关演示如何获取 inUse 属性的示例，请参阅 示例 2：获取 Azure 网络连接的选定属性，包括 healthCheckStatusDetails。 只读。
managedBy	cloudPcManagementService	指定管理 Azure 网络连接的服务。 可能的值是：windows365、devBox, unknownFutureValue。 只读。
organizationalUnit	String	在其中创建计算机帐户的组织单位 (OU) 。 如果留空，则会使用配置为默认 (Active Directory 域中已知计算机对象容器) 的 OU (OU) 。 可选。
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	指定如何将预配的云电脑加入Azure Active Directory。 默认值为 hybridAzureADJoin。 可取值为：azureADJoin、hybridAzureADJoin、unknownFutureValue。
virtualNetworkId	String	目标虚拟网络的 ID。 必需格式： /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}.

cloudPcManagementService 值

成员	值	说明
windows365	1	Azure 网络连接是通过 Windows365 成功创建的。
devBox	2	Azure 网络连接是通过 Project Fidalgo 成功创建的。
unknownFutureValue	4	可变枚举 sentinel 值。 请勿使用。

cloudPcOnPremisesConnectionType 值

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

cloudPcOnPremisesConnectionStatus 值

成员	说明
等待	创建并等待运行状况检查。
运行	运行运行状况检查。
通过	运行状况检查已通过。
失败	运行状况检查失败。
警告	使用警告传递的运行状况检查。
unknownFutureValue	可变枚举 sentinel 值。 请勿使用。

关系

无。

JSON 表示形式

下面是资源的 JSON 表示形式。

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "adDomainName": "String",
  "adDomainPassword": "String",
  "adDomainUsername": "String",
  "alternateResourceUrl": "String",
  "displayName": "String",
  "healthCheckStatus": "String",
  "healthCheckStatusDetails": {
    "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionStatusDetails",
    "endDateTime": "String (timestamp)",
    "healthChecks": [
      { 
        "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionHealthCheck",
        "additionalDetails": "String",
        "displayName": "String",
        "endDateTime": "String (timestamp)",
        "errorType": "String",
        "recommendedAction": "String",
        "startDateTime": "String (timestamp)",
        "status": "String"
      }
    ],
    "startDateTime": "String (timestamp)"
  },
  "id": "String (identifier)",
  "inUse": "Boolean",
  "managedBy": "String",
  "organizationalUnit": "String",
  "resourceGroupId": "String",
  "subnetId": "String",
  "subscriptionId": "String",
  "subscriptionName": "String",
  "type": "String",
  "virtualNetworkId": "String"
}