Skip to content

Latest commit

 

History

History
158 lines (120 loc) · 3.61 KB

Get-AzScheduledQueryRule.md

File metadata and controls

158 lines (120 loc) · 3.61 KB
Raw
external help file Module Name online version schema
Az.ScheduledQueryRule.psm1-help.xml
Az.Monitor
2.0.0

Get-AzScheduledQueryRule

SYNOPSIS

Retrieve an scheduled query rule definition.

SYNTAX

List (Default)

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

Get

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

List1

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

GetViaIdentity

Get-AzScheduledQueryRule -InputObject <IScheduledQueryRuleIdentity> [-DefaultProfile <PSObject>]
 [<CommonParameters>]

DESCRIPTION

Retrieve an scheduled query rule definition.

EXAMPLES

Example 1: List scheduled query rules under current subscription

Get-AzScheduledQueryRule

List scheduled query rules under current subscription

Example 2: List scheduled query rules for resource group

Get-AzScheduledQueryRule -ResourceGroupName "test-group"

List scheduled query rules for resource group: "test-group"

Example 3: Get scheduled query rule by name

Get-AzScheduledQueryRule -ResourceGroupName "test-group" -Name "test-rule"

Get scheduled query rule by name

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.Monitor.ScheduledQueryRule.Models.IScheduledQueryRuleIdentity
Parameter Sets: GetViaIdentity
Aliases:

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

-Name

The name of the rule.

Type: System.String
Parameter Sets: Get
Aliases:

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

-ResourceGroupName

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

Type: System.String
Parameter Sets: Get, List1
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, Get, List1
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.Monitor.ScheduledQueryRule.Models.IScheduledQueryRuleIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.IScheduledQueryRuleResource

NOTES

RELATED LINKS