Get-CrmMonitoringResult
Retrieves results from the monitoring service operations tests for the Dynamics 365 deployment.
Syntax
Get-CrmMonitoringResult
[-TestName <String>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Server <String>]
[-Role <String>]
[-Status <String>]
[-Timeout <Int32>]
[-Diag]
[-Credential <PSCredential>]
[-DwsServerUrl <String>] Get-CrmMonitoringResult
[-ServiceHealth]
[-Timeout <Int32>]
[-Diag]
[-Credential <PSCredential>]
[-DwsServerUrl <String>] Description
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 -ServiceHealthIf 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.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DwsServerUrl
The URL of the Deployment Web Service. This should be in the format: https://, for example, https://contoso.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EndTime
Filters test results that were reported earlier than this time.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Server
Comma delimited list of servers to filter results by.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StartTime
Filters results to test results that were reported later than this time.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Status
Filters results based on the status.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Timeout
For internal use only.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
System.Management.Automation.SwitchParameter
System.Int32 System.Management.Automation.PSCredential System.String
Outputs
Microsoft.Crm.PowerShell.MonitoringResultInfo[]
Microsoft.Xrm.Sdk.Deployment.ServiceHealthStatus