The Get-CrmMonitoringResult cmdlet returns the results from the monitoring service. These tests report the overall health of the Dynamics 365 deployment. This cmdlet also allows you to report on specific tests or date ranges.
Examples
Example 1
PS C:\> Get-CrmMonitoringResult -ServiceHealth
If data monitoring data is available, returns information for overall system health of the deployment.
Parameters
-Credential
Expects a variable that contains the user credentials used for signing in to Dynamics 365 on-premises organization. To establish this variable, run the PowerShell command $Cred = Get-Credential.
Parameter properties
Type:
PSCredential
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Diag
Turns on stack traces for error reports returned from Dynamics 365 service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the Dynamics 365 PowerShell command.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DwsServerUrl
The URL of the Deployment Web Service. This should be in the format: https://<serverurl>, for example, https://contoso.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-EndTime
Filters test results that were reported earlier than this time.
Parameter properties
Type:
DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
FilterMonitoringResults
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Role
Specifies a comma delimited list of roles to filter results by. Possible roles for this are: AppServer, AsyncService, SrsDataConnector, DiscoveryService, EmailService, WebService, SqlServer, ApiServer,SrsSqlServer, SandboxServer, and DeploymentManagementTools.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
FilterMonitoringResults
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Server
Comma delimited list of servers to filter results by.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
FilterMonitoringResults
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ServiceHealth
Reports the overall Dynamics 365 Service health. Possible results are: Healthy - Service Verification Only, Healthy, and Not Healthy. For a full report, a monitoring organization needs to be defined for this deployment. To configure this, use the Set-CrmSettings cmdlet and configure the monitoring organization in the MonitoringSettings object.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
ServiceHealth
Position:
0
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-StartTime
Filters results to test results that were reported later than this time.
Parameter properties
Type:
DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
FilterMonitoringResults
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Status
Filters results based on the status.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
FilterMonitoringResults
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TestName
Specifies the name of the test to get the results for. Possible tests at the time of this release are: VerifyAsyncServiceMaintenanceRunning, VerifyAsyncServiceRunning, VerifySandboxServiceIsRunning, VerifyUnZipServiceIsRunning, VerifyVSSWriterServiceIsRunning, VerifyWebsiteIsRunning, VerifyApplicationAppPoolIsRunning, VerifyDeploymentWebServiceAppPoolIsRunning, CheckApiServer, CheckWebApp, VerifyActiveCrmKeys, VerifyAsyncBacklogTest, VerifyHelpContent, CheckReportServer, CheckCrmReporting, CheckReportServerFromSrsDataConnector, and CheckFetchBasedReport.