You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference/beta/resources/cloudpconpremisesconnection.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -42,22 +42,22 @@ Represents a defined collection of Azure resource information that can be used t
42
42
|displayName|String|The display name for the Azure network connection.|
43
43
|healthCheckStatus|[cloudPcOnPremisesConnectionStatus](#cloudpconpremisesconnectionstatus-values)|The status of the most recent health check done on the Azure network connection. For example, if the status is `passed`, the Azure network connection passed all checks run by the service. Possible values are: `pending`, `running`, `passed`, `failed`, `warning`, `informational`, `unknownFutureValue`. Read-only.|
44
44
|healthCheckStatusDetails|[cloudPcOnPremisesConnectionStatusDetails](../resources/cloudpconpremisesconnectionstatusdetails.md)|The details of the connection's health checks and the corresponding results. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only.|
45
-
|healthCheckStatusDetails (deprecated)|[cloudPcOnPremisesConnectionStatusDetails](../resources/cloudpconpremisesconnectionstatusdetails.md)|Indicates the health checks for the connection and their respective results. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only. The **healthCheckStatusDetails** property is deprecated and stopped returning data on January 31, 2024. Goind forward, use the **healthCheckStatusDetail** property.|
45
+
|healthCheckStatusDetails (deprecated)|[cloudPcOnPremisesConnectionStatusDetails](../resources/cloudpconpremisesconnectionstatusdetails.md)|Indicates the health checks for the connection and their respective results. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only. The **healthCheckStatusDetails** property is deprecated and stopped returning data on January 31, 2024. Going forward, use the **healthCheckStatusDetail** property.|
46
46
|healthCheckStatusDetail|[cloudPcOnPremisesConnectionStatusDetail](../resources/cloudpconpremisesconnectionstatusdetail.md)|Indicates the results of health checks performed on the on-premises connection. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only.|
47
47
|id|String|Unique identifier for the Azure network connection. Read-only.|
48
48
|inUse|Boolean|When `true`, the Azure network connection is in use. When `false`, the connection isn't in use. You can't delete a connection that’s in use. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only.|
49
-
|inUseByCloudPc|Boolean|Indicating whether this OnPremisesNetworkConnection is being used by Cloud PC. When true, at least one Cloud PC is using this OnPremisesNetworkConnection. When false, no Cloud PCs are using this OnPremisesNetworkConnection. Read-only. Default is false. |
50
-
|healthCheckPaused|Boolean|`healthCheckPaused` indicates whether the regular health checks on the network/domain configuration is currently scheduled. When false, the connection will perform health checks regularly. When true, the connection will pause regular health checks. Create or update OnPremisesNetworkConnection will mark `healthCheckPaused` as false for 4 weeks, retry health checks on network/domain configuration will mark `healthCheckPaused` as false for 2 weeks. If the OnPremisesNetworkConnectionis attached in ProvisioningPolicy, or used by CloudPC in the past 4 weeks, `healthCheckPaused`will also be set to false. Read-only. Default is false.|
51
-
|managedBy|[cloudPcManagementService](#cloudpcmanagementservice-values)|Specifies which services manage the Azure network connection. Possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `rpaBox`. Read-only.|
52
-
|organizationalUnit|String|The organizational unit (OU) in which the computer account is created. If left null, the OU that’s configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.|
49
+
|inUseByCloudPc|Boolean|Indicates whether a Cloud PC is using this **OnPremisesNetworkConnection**. `true` if at least one Cloud PC is using this **OnPremisesNetworkConnection**. Otherwise, `false`. Read-only. Default is false. |
50
+
|healthCheckPaused|Boolean|`false` if the regular health checks on the network/domain configuration are currently active. `true` if the checks are paused. If you perform a create or update operations on **OnPremisesNetworkConnection** resources, this value is set to `false`for 4 weeks. If you retry a health check on network/domain configuration, this value is set to `false` for two weeks. If the **OnPremisesNetworkConnection** resource is attached in a **ProvisioningPolicy**, or used by a Cloud PC in the past 4 weeks, `healthCheckPaused`is also set to `false`. Read-only. Default is `false`.|
51
+
|managedBy|[cloudPcManagementService](#cloudpcmanagementservice-values)|Specifies which services manage the Azure network connection. Possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `rpaBox`. Read-only.|
52
+
|organizationalUnit|String|The organizational unit (OU) in which the computer account is created. If left null, the OU configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.|
53
53
|organizationalUnit|String|The organizational unit (OU) in which the computer account is created. If left null, the OU configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.|
54
54
|virtualNetworkId|String|The ID of the target virtual network. Required format: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}`.|
55
55
|virtualNetworkLocation|String|Indicates the resource location of the virtual target network. Read-only, computed value.|
56
56
|resourceGroupId|String|The ID of the target resource group. Required format: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}`.|
57
57
|subnetId|String|The ID of the target subnet. Required format: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}`.|
58
58
|subscriptionId|String|The ID of the target Azure subscription associated with your tenant.|
59
59
|subscriptionName|String|The name of the target Azure subscription. Read-only.|
60
-
|type (deprecated)|[cloudPcOnPremisesConnectionType](../resources/cloudpconpremisesconnection.md#cloudpconpremisesconnectiontype-values)|Specifies the method by which a provisioned Cloud PC is joined to Microsoft Entra. The `azureADJoin` option indicates the absence of an on-premises Active Directory (AD) in the current tenant that results in the Cloud PC device only joining to Microsoft Entra. The `hybridAzureADJoin` option indicates the presence of an on-premises AD in the current tenant and that the Cloud PC joins both the on-premises AD and Microsoft Entra. The selected option also determines the types of users who can be assigned and can sign into a Cloud PC. The `azureADJoin` option allows both cloud-only and hybrid users to be assigned and sign in, whereas `hybridAzureADJoin` is restricted to hybrid users only. The default value is `hybridAzureADJoin`. The possible values are: `hybridAzureADJoin`, `azureADJoin`, `unknownFutureValue`. The **type** property is deprecated and stopped returning data on January 31, 2024. Goind forward, use the **connectionType** property.|
60
+
|type (deprecated)|[cloudPcOnPremisesConnectionType](../resources/cloudpconpremisesconnection.md#cloudpconpremisesconnectiontype-values)|Specifies the method by which a provisioned Cloud PC is joined to Microsoft Entra. The `azureADJoin` option indicates the absence of an on-premises Active Directory (AD) in the current tenant that results in the Cloud PC device only joining to Microsoft Entra. The `hybridAzureADJoin` option indicates the presence of an on-premises AD in the current tenant and that the Cloud PC joins both the on-premises AD and Microsoft Entra. The selected option also determines the types of users who can be assigned and can sign into a Cloud PC. The `azureADJoin` option allows both cloud-only and hybrid users to be assigned and sign in, whereas `hybridAzureADJoin` is restricted to hybrid users only. The default value is `hybridAzureADJoin`. The possible values are: `hybridAzureADJoin`, `azureADJoin`, `unknownFutureValue`. The **type** property is deprecated and stopped returning data on January 31, 2024. Going forward, use the **connectionType** property.|
0 commit comments