Get-AzScheduledQueryRule

Retrieve an scheduled query rule definition.

Syntax

Get-AzScheduledQueryRule
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzScheduledQueryRule
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzScheduledQueryRule
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
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: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:IScheduledQueryRuleIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the rule.

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

-ResourceGroupName

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

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

-SubscriptionId

The ID of the target subscription.

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

Inputs

IScheduledQueryRuleIdentity

Outputs

IScheduledQueryRuleResource