cloudPcOnPremisesConnectionHealthCheck resource type

Article
09/28/2023

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

The result of a Cloud PC Azure network connection health check.

Important

On-premises network connection has been renamed as Azure network connection. cloudPcOnPremisesConnection objects here are equivalent to Azure network connection for the Cloud PC product.

Methods

Method	Return type	Description
RunHealthChecks of cloudPcOnPremisesConnection	None	Run the health checks of a cloudPcOnPremisesConnection.

Properties

Property	Type	Description
additionalDetails	String	Additional details about the health check or the recommended action.
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. 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. Possible values are: `pending`, `running`, `passed`, `failed`, `unknownFutureValue`. Read-only.

cloudPcOnPremisesConnectionHealthCheckErrorType values

Member	Description
dnsCheckFqdnNotFound	The DNS resolution failed for the domain name. Possible error causes: 1. The specified Azure virtual network's DNS server can't resolve the domain name. Update the virtual network with an appropriate DNS server; 2. The domain name provided doesn't exist or isn't correct. Update the Azure network connection with the correct domain name. Make sure that the virtual network defined in the Azure network connection can resolve the domain name.
dnsCheckNameWithInvalidCharacter	The DNS check failed because the domain name entered contains an unsupported character. Make sure the domain name only contains supported characters.
dnsCheckUnknownError	The DNS resolution failed for the domain name. Possible error causes: 1. The specified Azure virtual network's DNS server can't resolve the domain name. Update the virtual network with an appropriate DNS server; 2. The domain name provided doesn't exist or isn't correct. Update the Azure network connection with the correct domain name. Make sure that the virtual network defined in the Azure network connection can resolve the domain name.
adJoinCheckFqdnNotFound	The domain join check failed because the domain name couldn't be found. Make sure a domain controller for the domain name can be contacted by the virtual network defined in the Azure network connection.
adJoinCheckIncorrectCredentials	The domain join check failed because the credentials provided for the domain aren't correct. Update the Azure network connection with correct credentials.
adJoinCheckOrganizationalUnitNotFound	The domain join check failed because the organizational unit (OU) can't be found. Provide an OU in the domain. The OU must be in distinguished name format. Example format: “OU=OU1,OU=OU2,OU=OU3,DC=DC1”.
adJoinCheckOrganizationalUnitIncorrectFormat	The domain join check failed because the organizational unit (OU) can't be found. Provide an OU in the domain. The OU must be in distinguished name format. Example format: “OU=OU1,OU=OU2,OU=OU3,DC=DC1”.
adJoinCheckComputerObjectAlreadyExists	The computer account can't be found in the organizational unit (OU) provided in the Azure network connection but the computer name already exists in the domain. This often occurs after the computer object was moved out of the OU configured in the Azure network connection. Move the computer object back to the target OU.
adJoinCheckAccessDenied	The domain join check failed because the user account provided doesn't have sufficient permissions to join the domain. Make sure that the account provided has sufficient permissions or change the user account defined in the Azure network connection properties. Permissions needed: Create computer objects and Delete computer objects.
adJoinCheckCredentialsExpired	The domain join check failed because the password of the domain join user has expired. First update the password and then update the Azure network connection with the new credentials.
adJoinCheckAccountLockedOrDisabled	The domain join check failed because the domain join user account is currently locked out or disabled. Ensure the domain join user account is unlocked, active, and able to authenticate to the domain.
adJoinCheckAccountQuotaExceeded	The domain join check failed because the domain join user has exceeded maximum domain joins. Make sure the domain join is allowed and the ms-DS-MachineAccountQuota Active Directory property allows sufficient domain joins.
adJoinCheckUnknownError	The domain join check failed due to an unknown error. Make sure that the Azure network connection can successfully join the domain using the details provided.
endpointConnectivityCheckCloudPcUrlNotAllowListed	During provisioning, one or more required URLs couldn't be contacted. Make sure that all of the required URLs are allowed through the firewalls and proxies.
endpointConnectivityCheckWVDUrlNotAllowListed	During provisioning, one or more required WVD URLs couldn't be contacted. Make sure that all of the required URLs are allowed through the firewalls and proxies.
endpointConnectivityCheckIntuneUrlNotAllowListed	During provisioning, one or more required Intune URLs couldn't be contacted. Make sure that all of the required URLs are allowed through the firewalls and proxies.
endpointConnectivityCheckAzureADUrlNotAllowListed	During provisioning, one or more required Azure Active Directory (Azure AD) URLs couldn't be contacted. Make sure that all of the required URLs are allowed through the firewalls and proxies.
endpointConnectivityCheckLocaleUrlNotAllowListed	During provisioning, one or more language pack URLs couldn't be contacted. If you choose a non-English (United States) Language & Region setting in a provisioning policy, the language pack might not be successfully installed. Make sure that all of the required URLs are allowed through your firewalls and proxies. For a list or required URLs, see Azure network connections health checks.
endpointConnectivityCheckUnknownError	During provisioning, one or more required URLs couldn't be contacted. Make sure that all of the required URLs are allowed through the firewalls and proxies.
azureAdDeviceSyncCheckDeviceNotFound	The Cloud PC computer object can't be found in Azure Active Directory (Azure AD). Make sure that Azure AD connect works and syncs frequently so that the Cloud PC computer objects are synced to Azure AD. Azure AD device sync must be enabled and synced within the last 60 minutes.
azureAdDeviceSyncCheckLongSyncCircle	The check whether the Cloud PC computer object has been synced to Azure Active Directory (Azure AD) has timed out. Make sure that Azure AD connect works and syncs frequently so that the Cloud PC computer objects are synced to Azure AD. Azure AD device sync must be enabled and synced within the last 60 minutes.
azureAdDeviceSyncCheckConnectDisabled	The Azure Active Directory (Azure AD) device sync check failed because the Azure AD Connect is disabled. Make sure the Azure AD Connect is enabled and it syncs frequently. If the Azure AD Connect doesn't sync the computer within 60 minutes, then the check fails.
azureAdDeviceSyncCheckDurationExceeded	The Azure Active Directory (Azure AD) device sync check failed because the Azure AD Connect sync didn't sync within 60 minutes. Make sure the Azure AD Connect is enabled and it syncs frequently. If the Azure AD Connect doesn't sync the computer within 60 minutes, then the check fails.
azureAdDeviceSyncCheckScpNotConfigured	The Hybrid Azure Active Directory (Azure AD) join failed due to misconfiguration in the Service Configuration Point (SCP). Make sure your SCP configuration is valid and available to perform a Hybrid Azure AD join. Your SCP can be created and configured in the Azure AD Connect wizard.
azureAdDeviceSyncCheckTransientServiceError	The Azure Active Directory (Azure AD) device sync check failed due to a transient error. Try it again. If the issue persists, please contact customer support.
azureAdDeviceSyncCheckUnknownError	Hybrid Azure Active Directory (Azure AD) connectivity check failed. Make sure that Azure AD connect works and syncs frequently so that the Cloud PC computer objects are synced to Azure AD. Azure AD device sync must be enabled and synced within the last 60 minutes.
resourceAvailabilityCheckNoSubnetIP	The subnet provided doesn't have IP addresses available. Make sure that the subnet provided in the Azure network connection has sufficient IP addresses available. Expand the current selected subnet or select a different subnet to be used for provisioning.
resourceAvailabilityCheckSubscriptionDisabled	The Azure subscription provided is disabled. Make sure that the Azure subscription is enabled and available for provisioning.
resourceAvailabilityCheckAzurePolicyViolation	The Azure subscription provided can't be found. Ensure that the Azure subscription is available for provisioning.
resourceAvailabilityCheckSubscriptionNotFound	The Azure subscription provided can't be accessed. Ensure that the Azure subscription is available for provisioning.
resourceAvailabilityCheckSubscriptionTransferred	The Azure subscription provided can't be accessed. Ensure that the Azure subscription is available for provisioning.
resourceAvailabilityCheckGeneralSubscriptionError	An Azure policy is restricting the creation of resources. Ensure that there's no Azure policy that restricts creating resources in the subscription and/or resource group.
resourceAvailabilityCheckUnsupportedVNetRegion	The selected virtual network is located in an unsupported region. Ensure that the selected virtual network is located in a supported region.
resourceAvailabilityCheckResourceGroupInvalid	The selected Azure resource group is invalid or not found. Make sure the selected Azure resource group is available to provision resources. Alternatively, update this Azure network connection with another resource group.
resourceAvailabilityCheckVNetInvalid	The selected Azure virtual network is invalid. Make sure the selected virtual network is available and healthy. Alternatively, update this Azure network connection with another virtual network.
resourceAvailabilityCheckSubnetInvalid	The selected Azure subnet is invalid. Make sure the selected subnet is available and healthy. Alternatively, update this Azure network connection with another subnet.
resourceAvailabilityCheckResourceGroupBeingDeleted	The selected Azure resource group is being deleted. Make sure the selected Azure resource group is available to provision resources. Alternatively, update this Azure network connection with another resource group.
resourceAvailabilityCheckVNetBeingMoved	The selected Azure virtual network is being moved. Ensure your virtual network isn't changing or being moved and try again. Alternatively, update this Azure network connection with another virtual network.
resourceAvailabilityCheckSubnetDelegationFailed	The selected Azure virtual network has subnet delegation that blocks the creation of a network interface (Nic). Ask your Azure virtual network owner to modify their subnet delegation policy to allow provisioning to succeed.
resourceAvailabilityCheckSubnetWithExternalResources	The selected subnet can't be used because it contains external resources. Remove any resources that could cause conflicts and try again. Alternatively, update this Azure network connection with another subnet.
resourceAvailabilityCheckResourceGroupLockedForReadonly	The selected resource group is locked and can't be modified for provisioning. Remove this lock to allow provisioning to succeed.
resourceAvailabilityCheckResourceGroupLockedForDelete	The selected resource group or its parent scope has been locked for delete actions. It might be because the IP addresses are used up. Remove the lock and try again.
resourceAvailabilityCheckTransientServiceError	The resource availability check failed due to a transient error. Try it again. If the issue persists, please contact customer support.
resourceAvailabilityCheckNoIntuneReaderRoleError	The Cloud PC service principal doesn't have sufficient permissions to check the Intune platform restriction settings. Make sure that the Cloud PC service principal has the Reader permissions on the subscription.
resourceAvailabilityCheckIntuneDefaultWindowsRestrictionViolation	The Intune has a default Windows platform restriction policy, which may block you from provisioning.
resourceAvailabilityCheckIntuneCustomWindowsRestrictionViolation	The Intune has a custom Windows platform restriction policy, which may block you from provisioning.
resourceAvailabilityCheckUnknownError	The resource availability check for Azure resources failed due to an unknown error. Ensure that all Azure resources meet the prerequisites.
permissionCheckNoSubscriptionReaderRole	The Cloud PC service principal doesn't have sufficient permissions on the Azure subscription. Make sure that the Cloud PC service principal has the Reader permissions on the subscription.
permissionCheckNoResourceGroupOwnerRole	The Cloud PC service principal doesn't have sufficient permissions on the Azure resource group. Make sure that the Cloud PC service principal has the Owner permissions on the resource group.
permissionCheckNoVNetContributorRole	The Cloud PC service principal doesn't have sufficient permissions on the Azure virtual network. Make sure that the Cloud PC service has the Network contributor permissions on the virtual network.
permissionCheckNoResourceGroupNetworkContributorRole	Cloud PC service principal doesn't have sufficient permissions on the Azure resource group. Make sure that the application has Network contributor permissions on the resource group.
permissionCheckTransientServiceError	The first-party app permission check failed due to a transient error. Try it again. If the issue persists, please contact customer support.
permissionCheckUnknownError	The Cloud PC service principal doesn't have sufficient permissions. Make sure that the Cloud PC service principal is granted sufficient Azure permissions.
udpConnectivityCheckStunUrlNotAllowListed	Your current network configuration doesn't allow the use of UDP direct connect Session Traversal Utilities for NAT (STUN). This doesn't prevent the use of Cloud PCs but can prevent optimal performance. Consider your own network configuration policies before you apply changes.
udpConnectivityCheckTurnUrlNotAllowListed	Your current network configuration doesn't allow the use of UDP direct connect Session Traversal Utilities for NAT (TURN). This doesn't prevent the use of Cloud PCs but can prevent optimal performance. Consider your own network configuration policies before you apply changes.
udpConnectivityCheckUrlsNotAllowListed	Your current network configuration doesn't allow the use of UDP direct connect Session Traversal Utilities for NAT (STUN and TURN). This doesn't prevent the use of Cloud PCs but can prevent optimal performance. Consider your own network configuration policies before you apply changes.
udpConnectivityCheckUnknownError	An unknown error occurred when trying to check UDP direct connect. Make sure your own network configuration policies can allow UDP direct connect.
internalServerErrorDeploymentCanceled	The deployment was canceled. Try again later. If the problem persists, please contact support.
internalServerErrorAllocateResourceFailed	The allocation of resources failed. Try again later. If the problem persists, please contact support.
internalServerErrorVMDeploymentTimeout	The virtual machine deployment timed out. Try again later. If the problem persists, please contact support.
internalServerErrorUnableToRunDscScript	During provisioning, some PowerShell DSC scripts are executed on the Cloud PC. Unable to either download these DSC scripts or execute them during the health check. Ensure virtual network has unrestricted access to the required endpoints, and PowerShell isn't blocked in the environment or Group Policy.
ssoCheckKerberosConfigurationError	The Azure Active Directory (Azure AD) Kerberos is not configured properly, so the user failed to sign in to the Cloud PC through single sign-on (SSO) or receive SSO access to Kerberos-based resources on the network.
internalServerUnknownError	The provisioning has failed due to an internal error. Contact customer support.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

Relationships

None.

JSON representation

Here's a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnectionHealthCheck",
  "displayName": "String",
  "status": "String",
  "startDateTime": "String (timestamp)",
  "endDateTime": "String (timestamp)",
  "errorType": "String",
  "recommendedAction": "String",
  "additionalDetails": "String",
  "correlationId": "String"
}