Get-AzHDInsightMonitoring
Gets the status of the Classic Azure Monitor logs integration on an HDInsight cluster.
Syntax
Default (Default)
Get-AzHDInsightMonitoring
[-Name] <String>
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzHDInsightMonitoring cmdlet gets the status of the Classic Azure Monitor logs integration on an HDInsight cluster. If monitoring is enabled then it will also return the log analytics workspace id.
Examples
Example 1
Get-AzHDInsightMonitoring -Name testcluster
{'ClusterMonitoringEnabled':'true', 'workspaceId':'1d364e89-bb71-4503-aa3d-a23535aea7bd'}
Monitoring is enabled on the cluster because the ClusterMonitoringEnabled property is true. The monitoring workspace id where the logs are flowing is 1d364e89-bb71-4503-aa3d-a23535aea7bd
Example 2
Get-AzHDInsightMonitoring -Name testcluster -ResourceGroupName testrg
{'ClusterMonitoringEnabled':'true', 'workspaceId':'1d364e89-bb71-4503-aa3d-a23535aea7bd'}
Monitoring is enabled on the cluster because the ClusterMonitoringEnabled property is true. The monitoring workspace id where the logs are flowing is 1d364e89-bb71-4503-aa3d-a23535aea7bd
Example 3
Get-AzHDInsightMonitoring -Name testcluster
{'ClusterMonitoringEnabled':'false', 'workspaceId': null}
Monitoring is disabled on the cluster because the ClusterMonitoringEnabled property is false.
Example 4
Get-AzHDInsightMonitoring -Name testcluster -ResourceGroupName testrg
{'ClusterMonitoringEnabled':'false', 'workspaceId': null}
Monitoring is disabled on the cluster because the ClusterMonitoringEnabled property is false.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the cluster to get the status of monitoring.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ClusterName |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group of the cluster.
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 |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
