Microsoft.Automation automationAccounts/webhooks
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@2015-10-31' = {
name: 'string'
parent: resourceSymbolicName
properties: {
expiryTime: 'string'
isEnabled: bool
parameters: {}
runbook: {
name: 'string'
}
runOn: 'string'
uri: 'string'
}
}
Property values
automationAccounts/webhooks
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-128 Valid characters: Can't use: <>*%&:\?.+/ or control characters Can't end with space. |
| 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) |
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. | object |
| 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 |
RunbookAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the runbook. | string |
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": "2015-10-31",
"name": "string",
"properties": {
"expiryTime": "string",
"isEnabled": "bool",
"parameters": {},
"runbook": {
"name": "string"
},
"runOn": "string",
"uri": "string"
}
}
Property values
automationAccounts/webhooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Automation/automationAccounts/webhooks' |
| apiVersion | The resource api version | '2015-10-31' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-128 Valid characters: Can't use: <>*%&:\?.+/ or control characters Can't end with space. |
| properties | Gets or sets the properties of the webhook. | WebhookCreateOrUpdatePropertiesOrWebhookProperties (required) |
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. | object |
| 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 |
RunbookAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the runbook. | string |
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@2015-10-31"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
expiryTime = "string"
isEnabled = bool
parameters = {}
runbook = {
name = "string"
}
runOn = "string"
uri = "string"
}
})
}
Property values
automationAccounts/webhooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Automation/automationAccounts/webhooks@2015-10-31" |
| name | The resource name | string (required) Character limit: 1-128 Valid characters: Can't use: <>*%&:\?.+/ or control characters Can't end with space. |
| 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) |
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. | object |
| 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 |
RunbookAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the runbook. | string |