Edit

Get-AzElasticMonitor

  • Reference
Module:
Az.Elastic

Get the properties of a specific monitor resource.

Syntax

Get-AzElasticMonitor
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzElasticMonitor
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzElasticMonitor
   -InputObject <IElasticIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzElasticMonitor
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the properties of a specific monitor resource.

Examples

Example 1: List all elastic monitors under a subscription

Get-AzElasticMonitor

Name                           SkuName                         MonitoringStatus Location      ResourceGroupName
----                           -------                         ---------------- --------      -----------------
kk-elastictest02               ess-monthly-consumption_Monthly Enabled          westus2       kk-rg
kk-elastictest03               ess-monthly-consumption_Monthly Enabled          westus2       kk-rg
wusDeployValidate              ess-monthly-consumption_Monthly Enabled          westus2       poshett-rg
poshett-WestUS2-01             staging_Monthly                 Enabled          westus2       poshett-rg
hashahdemo01                   staging_Monthly                 Enabled          westus2       test-sub

This command lists all elastic monitors under a subscription.

Example 2: List all elastic monitors under a resource group

Get-AzElasticMonitor -ResourceGroupName azure-elastic-test

Name             SkuName                         MonitoringStatus Location ResourceGroupName
----             -------                         ---------------- -------- -----------------
elastic-portal01 ess-monthly-consumption_Monthly Enabled          westus2  azure-elastic-test
elastic-portal02 ess-monthly-consumption_Monthly Enabled          westus2  azure-elastic-test
elastic-pwsh01   ess-monthly-consumption_Monthly Enabled          westus2  azure-elastic-test
elastic-pwsh02   ess-monthly-consumption_Monthly Enabled          westus2  azure-elastic-test

This command lists all elastic monitors under a resource group.

Example 3: Get the properties of a specific monitor resource

Get-AzElasticMonitor -ResourceGroupName azure-elastic-test -Name elastic-pwsh02

Name           SkuName                         MonitoringStatus Location ResourceGroupName
----           -------                         ---------------- -------- -----------------
elastic-pwsh02 ess-monthly-consumption_Monthly Enabled          westus2  azure-elastic-test

This command gets the properties of a specific monitor resource.

Example 4: Get the properties of a specific monitor resource by pipeline

New-AzElasticMonitor -ResourceGroupName azps-elastic-test -Name elastic-pwsh02 -Location "westus2" -Sku "ess-monthly-consumption_Monthly" -UserInfoEmailAddress 'xxx@microsoft.com' | Get-AzElasticMonitor

Name           SkuName                         MonitoringStatus Location ResourceGroupName
----           -------                         ---------------- -------- -----------------
elastic-pwsh02 ess-monthly-consumption_Monthly Enabled          westus2  azure-elastic-test

This command gets the properties of a specific monitor resource by pipeline.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IElasticIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Monitor resource name

Type:String
Aliases:MonitorName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group to which the Elastic resource belongs.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IElasticIdentity

Outputs

IElasticMonitorResource

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IElasticIdentity>: Identity Parameter

  • [Id <String>]: Resource identity path
  • [MonitorName <String>]: Monitor resource name
  • [ResourceGroupName <String>]: The name of the resource group to which the Elastic resource belongs.
  • [RuleSetName <String>]: Tag Rule Set resource name
  • [SubscriptionId <String>]: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)