Get-AzSentinelAutomationRule
Gets the automation rule.
Syntax
Get-AzSentinelAutomationRule
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-WorkspaceName <String>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSentinelAutomationRule
-Id <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-WorkspaceName <String>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSentinelAutomationRule
-InputObject <ISecurityInsightsIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets the automation rule.
Examples
Example 1: List all Automation Rules
Get-AzSentinelAutomationRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"
DisplayName : VIP automation rule
CreatedByEmail : luke@contoso.com
CreatedByUserPrincipalName : luke@contoso.com
TriggeringLogicIsEnabled : True
TriggeringLogicTriggersOn : Incidents
TriggeringLogicTriggersWhen : Created
Name : 2f32af32-ad13-4fbb-9fbc-e19e0e7ff767
This command lists all Automation Rules under a Microsoft Sentinel workspace.
Example 2: Get an Automation Rule
Get-AzSentinelAutomationRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "2f32af32-ad13-4fbb-9fbc-e19e0e7ff767"
DisplayName : VIP automation rule
CreatedByEmail : luke@contoso.com
CreatedByUserPrincipalName : luke@contoso.com
TriggeringLogicIsEnabled : True
TriggeringLogicTriggersOn : Incidents
TriggeringLogicTriggersWhen : Created
Name : 2f32af32-ad13-4fbb-9fbc-e19e0e7ff767
This command gets an Automation Rule.
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 |
-Id
Automation rule ID
Type: | String |
Aliases: | AutomationRuleId |
Position: | Named |
Default value: | None |
Required: | True |
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: | ISecurityInsightsIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
-WorkspaceName
The name of the workspace.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell