Microsoft.Automation automationAccounts/hybridRunbookWorkerGroups

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@2024-10-23' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    credential: {
      name: 'string'
    }
  }
}

Property Values

Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups

HybridRunbookWorkerGroupCreateOrUpdatePropertiesOrHybridRunbookWorkerGroupProperties

RunAsCredentialAssociationProperty

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": "2024-10-23",
  "name": "string",
  "properties": {
    "credential": {
      "name": "string"
    }
  }
}

Property Values

Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups

HybridRunbookWorkerGroupCreateOrUpdatePropertiesOrHybridRunbookWorkerGroupProperties

RunAsCredentialAssociationProperty

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@2024-10-23"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      credential = {
        name = "string"
      }
    }
  }
}

Property Values

Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups

HybridRunbookWorkerGroupCreateOrUpdatePropertiesOrHybridRunbookWorkerGroupProperties

RunAsCredentialAssociationProperty

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    = ["*"]
}