通过

cloudPcOnPremisesConnection 资源类型

命名空间：microsoft.graph

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

重要

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

方法

方法 返回类型 Description
List cloudPcOnPremisesConnection 集合 列出 cloudPcOnPremisesConnection 对象的属性和关系。
获取 cloudPcOnPremisesConnection 读取 cloudPcOnPremisesConnection 对象的属性和关系。
创建 cloudPcOnPremisesConnection 创建新的 cloudPcOnPremisesConnection 对象。
更新 cloudPcOnPremisesConnection 更新 cloudPcOnPremisesConnection 对象的属性。
删除 None 删除 cloudPcOnPremisesConnection 对象。 无法删除正在使用的连接。
运行运行状况检查 None 在 cloudPcOnPremisesConnection 上运行运行状况检查。

属性

属性 类型 说明
adDomainName String 要加入的 Active Directory 域 (FQDN) 的完全限定域名。 最大长度为 255。 可选。
adDomainPassword String 与 active Directory 帐户的用户名关联的密码 (adDomainUsername) 。
adDomainUsername String Active Directory 帐户的用户名 (有权在 Active Directory 中创建计算机对象的用户或服务帐户) 。 必需格式： admin@contoso.com。 可选。
alternateResourceUrl String 链接到此 Azure 网络连接的合作伙伴服务资源的接口 URL。 仅在 $select 上返回。
connectionType cloudPcOnPremisesConnectionType 指定预配的云电脑如何加入到Microsoft Entra。 它包括不同的类型，其中一种是Microsoft Entra ID联接，这意味着当前租户中没有本地 Active Directory (AD) ，并且云电脑设备通过Microsoft Entra加入。 另一个是混合AzureADJoin，这意味着当前租户中还有一个本地 Active Directory (AD) ，云电脑设备会加入到本地 Active Directory (AD) 和Microsoft Entra。 该类型还确定可以分配和可以登录到云电脑的用户类型。 azureADJoin 类型指示可以分配仅限云的用户和混合用户并将其登录到云电脑。hybridAzureADJoin 指示只能向混合用户分配并登录到云电脑。 默认值为 hybridAzureADJoin。
displayName String Azure 网络连接的显示名称。
healthCheckStatus cloudPcOnPremisesConnectionStatus 在本地连接上完成的最新运行状况检查的状态。 例如，如果状态为 passed，则本地连接已通过服务运行的所有检查。 可能的值：pending、、running、passedfailed、warning、 informational。 默认值为“pending”。 只读。
healthCheckStatusDetail cloudPcOnPremisesConnectionStatusDetail 指示在本地连接上执行的运行状况检查结果。 只读。 仅在 $select 上返回。 有关演示如何获取 inUse 属性的示例，请参阅 示例 2：获取 Azure 网络连接的选定属性，包括 healthCheckStatusDetail。 只读。
id String Azure 网络连接的唯一标识符。 只读。
inUse 布尔值 当 为 时 true，Azure 网络连接正在使用中。 当 为 时 false，连接未使用。 无法删除正在使用的连接。 仅在 $select 上返回。 有关演示如何获取 inUse 属性的示例，请参阅 示例 2：获取 Azure 网络连接的选定属性，包括 healthCheckStatusDetail。 此为只读属性。
organizationalUnit String 组织单位 (在其中创建计算机帐户的 OU) 。 如果保留 null，则使用租户 Active Directory 域中的已知计算机对象容器) (配置为默认的 OU (OU) 。 可选。
resourceGroupId String 与云电脑的本地网络连接关联的目标资源组的唯一标识符。 必需格式：“/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}”
subnetId String 与云电脑的本地网络连接关联的目标子网的唯一标识符。 必需格式：“/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}”
subscriptionId String 与租户关联的 Azure 订阅的唯一标识符。
subscriptionName String Azure 订阅的名称用于创建 Azure 网络连接。 此为只读属性。
virtualNetworkId String 与云电脑的本地网络连接关联的目标虚拟网络的唯一标识符。 必需格式：“/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}”
virtualNetworkLocation String 指示目标虚拟网络的资源位置。 例如，位置可以是 eastus2、westeurope 等。只读 (计算值) 。

cloudPcOnPremisesConnectionType 值

成员 说明
azureADJoin 指示云电脑设备仅加入到Microsoft Entra ID。
hybridAzureADJoin 指示云电脑设备已加入本地 Active Directory并注册到 Microsoft Entra ID。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。

cloudPcOnPremisesConnectionStatus 值

成员 说明
失败 指示云电脑 Azure 网络连接运行状况检查现已完成，但失败。 客户的环境配置不正确，这会导致预配云电脑失败。 客户需要识别问题并使用本地连接提供的指南来解决该问题，以便成功预配。
信息 指示云电脑 Azure 网络连接运行状况检查现已完成，并显示运行状况检查信息。 运行状况检查向客户提供有关云电脑加载项功能（例如单一登录）的当前或关联的先决条件检查状态的信息。 它不会影响客户的云电脑预配，但旨在优化用户体验。
通过 指示已完成并通过云电脑 Azure 网络连接运行状况检查。 客户可以毫无问题地预配其云电脑。
待定 默认值。 指示云电脑 Azure 网络连接运行状况检查已启动并等待完成。
运行 指示云电脑 Azure 网络连接运行状况检查仍在运行。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。
警告 指示云电脑 Azure 网络连接运行状况检查现已完成，但失败。 客户的环境配置不正确，这会导致预配云电脑失败。 客户需要识别问题并使用本地连接提供的指南来解决该问题，以便成功预配。

关系

无。

JSON 表示形式

以下示例显示了资源类型。

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "adDomainName": "String",
  "adDomainPassword": "String",
  "adDomainUsername": "String",
  "alternateResourceUrl": "String",
  "displayName": "String",
  "healthCheckStatus": "String",
  "healthCheckStatusDetail": {
    "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionStatusDetail",
    "endDateTime": "String (timestamp)",
    "healthChecks": [
      {
        "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionHealthCheck",
        "additionalDetail": "String",
        "displayName": "String",
        "endDateTime": "String (timestamp)",
        "errorType": "String",
        "recommendedAction": "String",
        "correlationId": "String",
        "startDateTime": "String (timestamp)",
        "status": "String"
      }
    ],
    "startDateTime": "String (timestamp)"
  },
  "id": "String (identifier)",
  "inUse": "Boolean",
  "organizationalUnit": "String",
  "resourceGroupId": "String",
  "subnetId": "String",
  "subscriptionId": "String",
  "subscriptionName": "String",
  "connnecetionType": "String",
  "virtualNetworkId": "String"
}
  • Last updated on