Skip to content

Latest commit

 

History

History
164 lines (126 loc) · 3.82 KB

Get-AzPrometheusRuleGroup.md

File metadata and controls

164 lines (126 loc) · 3.82 KB
Raw
external help file Module Name online version schema
Az.PrometheusRuleGroups.psm1-help.xml
Az.AlertsManagement
2.0.0

Get-AzPrometheusRuleGroup

SYNOPSIS

Retrieve a Prometheus rule group definition.

SYNTAX

List (Default)

Get-AzPrometheusRuleGroup [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
 [<CommonParameters>]

List1

Get-AzPrometheusRuleGroup -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Get

Get-AzPrometheusRuleGroup -ResourceGroupName <String> -RuleGroupName <String> [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>] [<CommonParameters>]

GetViaIdentity

Get-AzPrometheusRuleGroup -InputObject <IPrometheusRuleGroupsIdentity> [-DefaultProfile <PSObject>]
 [<CommonParameters>]

DESCRIPTION

Retrieve a Prometheus rule group definition.

EXAMPLES

Example 1: Retrieve a Prometheus rule group definition from subscription.

Get-AzPrometheusRuleGroup
Name     Location ClusterName Enabled
----     -------- ----------- -------
newrule  eastus               True
newrule2 eastus               False

Retrieve a Prometheus rule group definition from subscription.

Example 2: Retrieve a certain Prometheus rule group definition.

Get-AzPrometheusRuleGroup -RuleGroupName newrule -ResourceGroupName MyGroupName
Name    Location ClusterName Enabled
----    -------- ----------- -------
newrule eastus               True

Retrieve a certain Prometheus rule group definition from ResourceGroup.

PARAMETERS

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

Required: False
Position: Named
Default value: None
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: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.IPrometheusRuleGroupsIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type: System.String
Parameter Sets: List1, Get
Aliases:

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

-RuleGroupName

The name of the rule group.

Type: System.String
Parameter Sets: Get
Aliases:

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

-SubscriptionId

The ID of the target subscription.

Type: System.String[]
Parameter Sets: List, List1, Get
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.IPrometheusRuleGroupsIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRuleGroupResource

NOTES

RELATED LINKS