| title | cloudPcOnPremisesConnectionHealthCheck resource type |
|---|---|
| description | Represents the result of a Cloud PC Azure network connection health check. |
| author | AshleyYangSZ |
| ms.localizationpriority | medium |
| ms.subservice | cloud-pc |
| doc_type | resourcePageType |
| ms.date | 11/26/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Represents the result of a Cloud PC Azure network connection health check.
[!INCLUDE on-premise-rename-note]
| Method | Return type | Description |
|---|---|---|
| Run health checks | None | Run the health checks of a cloudPcOnPremisesConnection. |
| Property | Type | Description |
|---|---|---|
| additionalDetail | String | More details about the health check or the recommended action. Read-only. |
| correlationId | String | The unique identifier of the health check item-related activities. This identifier can be useful in troubleshooting. |
| displayName | String | The display name for this health check item. |
| status | cloudPcOnPremisesConnectionStatus | The status of the health check item. The possible values are: pending, running, passed, failed, warning, informational, unknownFutureValue. Read-only. |
| startDateTime | DateTimeOffset | The start time of the health check item. Read-only. |
| endDateTime | DateTimeOffset | The end time of the health check item. Read-only. |
| errorType | cloudPcOnPremisesConnectionHealthCheckErrorType | The type of error that occurred during this health check. |
| recommendedAction | String | The recommended action to fix the corresponding error. |
| startDateTime | DateTimeOffset | The start time of the health check item. Read-only. |
| status | cloudPcOnPremisesConnectionStatus | The status of the health check item. The possible values are: pending, running, passed, failed, unknownFutureValue. Read-only. |
| additionalDetails (deprecated) | String | More details about the health check or the recommended action. Read-only. The additionalDetails property is deprecated and stopped returning data on January 31, 2024. Goind forward, use the additionalDetail property. |
None.
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.cloudPcOnPremisesConnectionHealthCheck",
"additionalDetail": "String",
"additionalDetails": "String",
"correlationId": "String",
"displayName": "String",
"endDateTime": "String (timestamp)",
"errorType": "String",
"recommendedAction": "String",
"startDateTime": "String (timestamp)",
"status": "String"
}