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/hybridRunbookWorkerGroups 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/hybridRunbookWorkerGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups@2021-06-22' = {
parent: resourceSymbolicName
credential: {
name: 'string'
}
name: 'string'
}
Property Values
Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups
| Name | Description | Value |
|---|---|---|
| credential | Sets the credential of a worker group. | RunAsCredentialAssociationProperty |
| 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 |
RunAsCredentialAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the credential. | string |
Usage Examples
Bicep Samples
A basic example of deploying Automation Account Runbook Worker Group.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
@secure()
@description('The password for the automation account credential')
param credentialPassword string
resource automationAccount 'Microsoft.Automation/automationAccounts@2021-06-22' = {
name: resourceName
location: location
properties: {
encryption: {
keySource: 'Microsoft.Automation'
}
publicNetworkAccess: true
sku: {
name: 'Basic'
}
}
}
resource credential 'Microsoft.Automation/automationAccounts/credentials@2020-01-13-preview' = {
parent: automationAccount
name: resourceName
properties: {
description: ''
password: null
userName: 'test_user'
}
}
resource hybridRunbookWorkerGroup 'Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups@2021-06-22' = {
parent: automationAccount
name: resourceName
credential: {
name: credential.name
}
}
ARM template resource definition
The automationAccounts/hybridRunbookWorkerGroups 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/hybridRunbookWorkerGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups",
"apiVersion": "2021-06-22",
"name": "string",
"credential": {
"name": "string"
}
}
Property Values
Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-06-22' |
| credential | Sets the credential of a worker group. | RunAsCredentialAssociationProperty |
| name | The resource name | string (required) |
| type | The resource type | 'Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups' |
RunAsCredentialAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the credential. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The automationAccounts/hybridRunbookWorkerGroups 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/hybridRunbookWorkerGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups@2021-06-22"
name = "string"
parent_id = "string"
body = {
credential = {
name = "string"
}
}
}
Property Values
Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups
| Name | Description | Value |
|---|---|---|
| credential | Sets the credential of a worker group. | RunAsCredentialAssociationProperty |
| 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 |
| type | The resource type | "Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups@2021-06-22" |
RunAsCredentialAssociationProperty
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the name of the credential. | string |
Usage Examples
Terraform Samples
A basic example of deploying Automation Account Runbook Worker Group.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
variable "credential_password" {
type = string
description = "The password for the automation account credential"
sensitive = true
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "automationAccount" {
type = "Microsoft.Automation/automationAccounts@2021-06-22"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
encryption = {
keySource = "Microsoft.Automation"
}
publicNetworkAccess = true
sku = {
name = "Basic"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "credential" {
type = "Microsoft.Automation/automationAccounts/credentials@2020-01-13-preview"
parent_id = azapi_resource.automationAccount.id
name = var.resource_name
body = {
properties = {
description = ""
password = var.credential_password
userName = "test_user"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "hybridRunbookWorkerGroup" {
type = "Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups@2021-06-22"
parent_id = azapi_resource.automationAccount.id
name = var.resource_name
body = {
credential = {
name = azapi_resource.credential.name
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}