Edit

Share via

Get-AzAutomationWebhook

Module:
Az.Automation Module

Gets webhooks from Automation.

Syntax

ByAll (Default) 

Get-AzAutomationWebhook
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByName 

Get-AzAutomationWebhook
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    -Name <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByRunbookName 

Get-AzAutomationWebhook
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    -RunbookName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzAutomationWebhook cmdlet gets webhooks. To get specific webhooks, specify a webhook name or specify the name of an Azure Automation runbook to get the webhooks connected to it.
Note: The WebhookUri is returned as empty string due to security concerns. Please make sure to save the webhook URL that New-AzAutomationWebhook cmdlet returns, because it cannot be retrieved by using Get-AzAutomationWebhook.

Examples

Example 1: Get all webhooks for a runbook

Get-AzAutomationWebhook -RunbookName "Runbook03" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01"

This command gets all webhooks for a runbook named Runbook03 in the Automation account named AutomationAccount01 in the resource group named ResourceGroup01.

Parameters

-AutomationAccountName

Specifies the name of an Automation account in which this cmdlet gets a webhook.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the webhook that this cmdlet gets.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:WebhookName

Parameter sets

ByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

Specifies the name of the resource group for which this cmdlet gets webhooks.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RunbookName

Specifies the name of a runbook for which this cmdlet gets webhooks.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByRunbookName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

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

Inputs

String

Outputs

Webhook