Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The automationAccounts/webhooks resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Automation/automationAccounts/webhooks resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Automation/automationAccounts/webhooks@2024-10-23' = {
parent: resourceSymbolicName
name: 'string'
properties: {
expiryTime: 'string'
isEnabled: bool
parameters: {
{customized property}: 'string'
}
runbook: {
name: 'string'
}
runOn: 'string'
uri: 'string'
}
}
Property Values
Microsoft.Automation/automationAccounts/webhooks
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: automationAccounts |
| properties | Gets or sets the properties of the webhook. | WebhookCreateOrUpdatePropertiesOrWebhookProperties (required) |
RunbookAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the runbook. | string |
WebhookCreateOrUpdatePropertiesOrWebhookProperties
| Name | Description | Value |
|---|---|---|
| expiryTime | Gets or sets the expiry time. | string |
| isEnabled | Gets or sets the value of the enabled flag of webhook. | bool |
| parameters | Gets or sets the parameters of the job. | WebhookCreateOrUpdatePropertiesParameters |
| runbook | Gets or sets the runbook. | RunbookAssociationProperty |
| runOn | Gets or sets the name of the hybrid worker group the webhook job will run on. | string |
| uri | Gets or sets the uri. | string |
WebhookCreateOrUpdatePropertiesParameters
| Name | Description | Value |
|---|
ARM template resource definition
The automationAccounts/webhooks resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Automation/automationAccounts/webhooks resource, add the following JSON to your template.
{
"type": "Microsoft.Automation/automationAccounts/webhooks",
"apiVersion": "2024-10-23",
"name": "string",
"properties": {
"expiryTime": "string",
"isEnabled": "bool",
"parameters": {
"{customized property}": "string"
},
"runbook": {
"name": "string"
},
"runOn": "string",
"uri": "string"
}
}
Property Values
Microsoft.Automation/automationAccounts/webhooks
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-10-23' |
| name | The resource name | string (required) |
| properties | Gets or sets the properties of the webhook. | WebhookCreateOrUpdatePropertiesOrWebhookProperties (required) |
| type | The resource type | 'Microsoft.Automation/automationAccounts/webhooks' |
RunbookAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the runbook. | string |
WebhookCreateOrUpdatePropertiesOrWebhookProperties
| Name | Description | Value |
|---|---|---|
| expiryTime | Gets or sets the expiry time. | string |
| isEnabled | Gets or sets the value of the enabled flag of webhook. | bool |
| parameters | Gets or sets the parameters of the job. | WebhookCreateOrUpdatePropertiesParameters |
| runbook | Gets or sets the runbook. | RunbookAssociationProperty |
| runOn | Gets or sets the name of the hybrid worker group the webhook job will run on. | string |
| uri | Gets or sets the uri. | string |
WebhookCreateOrUpdatePropertiesParameters
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The automationAccounts/webhooks resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Automation/automationAccounts/webhooks resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Automation/automationAccounts/webhooks@2024-10-23"
name = "string"
parent_id = "string"
body = {
properties = {
expiryTime = "string"
isEnabled = bool
parameters = {
{customized property} = "string"
}
runbook = {
name = "string"
}
runOn = "string"
uri = "string"
}
}
}
Property Values
Microsoft.Automation/automationAccounts/webhooks
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: automationAccounts |
| properties | Gets or sets the properties of the webhook. | WebhookCreateOrUpdatePropertiesOrWebhookProperties (required) |
| type | The resource type | "Microsoft.Automation/automationAccounts/webhooks@2024-10-23" |
RunbookAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the runbook. | string |
WebhookCreateOrUpdatePropertiesOrWebhookProperties
| Name | Description | Value |
|---|---|---|
| expiryTime | Gets or sets the expiry time. | string |
| isEnabled | Gets or sets the value of the enabled flag of webhook. | bool |
| parameters | Gets or sets the parameters of the job. | WebhookCreateOrUpdatePropertiesParameters |
| runbook | Gets or sets the runbook. | RunbookAssociationProperty |
| runOn | Gets or sets the name of the hybrid worker group the webhook job will run on. | string |
| uri | Gets or sets the uri. | string |
WebhookCreateOrUpdatePropertiesParameters
| Name | Description | Value |
|---|