Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Microsoft.Automation automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers

Bicep resource definition

The automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers@2024-10-23' = {
 parent: resourceSymbolicName
 name: 'string'
 properties: {
 vmResourceId: 'string'
 }
}

Property Values

Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers

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/hybridRunbookWorkerGroups
properties Gets or sets hybrid runbook worker group create or update properties. HybridRunbookWorkerCreateOrUpdateParametersOrHybridRunbookWorkerProperties

HybridRunbookWorkerCreateOrUpdateParametersOrHybridRunbookWorkerProperties

Name Description Value
vmResourceId Azure Resource Manager Id for a virtual machine. string

Usage Examples

Bicep Samples

A basic example of deploying Automation.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@secure()
@description('The password for the automation account hybrid runbook worker')
param automationWorkerPassword string
@secure()
@description('The administrator password for the virtual machine')
param vmAdminPassword string

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2022-07-01' = {
 name: resourceName
 location: location
 properties: {
 addressSpace: {
 addressPrefixes: [
 '10.0.0.0/16'
 ]
 }
 dhcpOptions: {
 dnsServers: []
 }
 subnets: []
 }
}

resource subnet 'Microsoft.Network/virtualNetworks/subnets@2022-07-01' = {
 name: 'internal'
 parent: virtualNetwork
 properties: {
 addressPrefix: '10.0.2.0/24'
 delegations: []
 privateEndpointNetworkPolicies: 'Enabled'
 privateLinkServiceNetworkPolicies: 'Enabled'
 serviceEndpointPolicies: []
 serviceEndpoints: []
 }
}

resource automationAccount 'Microsoft.Automation/automationAccounts@2021-06-22' = {
 name: resourceName
 location: location
 properties: {
 encryption: {
 keySource: 'Microsoft.Automation'
 }
 publicNetworkAccess: true
 sku: {
 name: 'Basic'
 }
 }
}

resource hybridRunbookWorkerGroup 'Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups@2021-06-22' = {
 name: resourceName
 parent: automationAccount
}

resource hybridRunbookWorker 'Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers@2021-06-22' = {
 name: 'c7714056-5ba8-4bbe-920e-2993171164eb'
 parent: hybridRunbookWorkerGroup
 properties: {
 vmResourceId: virtualMachine.id
 }
}

resource virtualMachine 'Microsoft.Compute/virtualMachines@2023-03-01' = {
 name: resourceName
 location: location
 properties: {
 additionalCapabilities: {}
 applicationProfile: {
 galleryApplications: []
 }
 diagnosticsProfile: {
 bootDiagnostics: {
 enabled: false
 storageUri: ''
 }
 }
 extensionsTimeBudget: 'PT1H30M'
 hardwareProfile: {
 vmSize: 'Standard_D2s_v3'
 }
 networkProfile: {
 networkInterfaces: [
 {
 id: networkInterface.id
 properties: {
 primary: true
 }
 }
 ]
 }
 osProfile: {
 adminPassword: vmAdminPassword
 adminUsername: 'adminuser'
 allowExtensionOperations: true
 computerName: resourceName
 linuxConfiguration: {
 disablePasswordAuthentication: false
 patchSettings: {
 assessmentMode: 'ImageDefault'
 patchMode: 'ImageDefault'
 }
 provisionVMAgent: true
 ssh: {
 publicKeys: []
 }
 }
 secrets: []
 }
 priority: 'Regular'
 storageProfile: {
 dataDisks: []
 imageReference: {
 offer: 'UbuntuServer'
 publisher: 'Canonical'
 sku: '16.04-LTS'
 version: 'latest'
 }
 osDisk: {
 caching: 'ReadWrite'
 createOption: 'FromImage'
 managedDisk: {
 storageAccountType: 'Standard_LRS'
 }
 osType: 'Linux'
 writeAcceleratorEnabled: false
 }
 }
 }
}

resource networkInterface 'Microsoft.Network/networkInterfaces@2022-07-01' = {
 name: resourceName
 location: location
 properties: {
 enableAcceleratedNetworking: false
 enableIPForwarding: false
 ipConfigurations: [
 {
 name: 'testconfiguration1'
 properties: {
 primary: true
 privateIPAddressVersion: 'IPv4'
 privateIPAllocationMethod: 'Dynamic'
 subnet: {
 id: subnet.id
 }
 }
 }
 ]
 }
}

resource credential 'Microsoft.Automation/automationAccounts/credentials@2020-01-13-preview' = {
 name: resourceName
 parent: automationAccount
 properties: {
 description: ''
 password: automationWorkerPassword
 userName: 'test_user'
 }
}

ARM template resource definition

The automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers resource, add the following JSON to your template.

{
 "type": "Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers",
 "apiVersion": "2024-10-23",
 "name": "string",
 "properties": {
 "vmResourceId": "string"
 }
}

Property Values

Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers

Name Description Value
apiVersion The api version '2024-10-23'
name The resource name string (required)
properties Gets or sets hybrid runbook worker group create or update properties. HybridRunbookWorkerCreateOrUpdateParametersOrHybridRunbookWorkerProperties
type The resource type 'Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers'

HybridRunbookWorkerCreateOrUpdateParametersOrHybridRunbookWorkerProperties

Name Description Value
vmResourceId Azure Resource Manager Id for a virtual machine. string

Usage Examples

Terraform (AzAPI provider) resource definition

The automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers 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/hybridRunbookWorkers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
 type = "Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers@2024-10-23"
 name = "string"
 parent_id = "string"
 body = {
 properties = {
 vmResourceId = "string"
 }
 }
}

Property Values

Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers

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/hybridRunbookWorkerGroups
properties Gets or sets hybrid runbook worker group create or update properties. HybridRunbookWorkerCreateOrUpdateParametersOrHybridRunbookWorkerProperties
type The resource type "Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers@2024-10-23"

HybridRunbookWorkerCreateOrUpdateParametersOrHybridRunbookWorkerProperties

Name Description Value
vmResourceId Azure Resource Manager Id for a virtual machine. string

Usage Examples

Terraform Samples

A basic example of deploying Automation.

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 "automation_worker_password" {
 type = string
 description = "The password for the automation account hybrid runbook worker"
 sensitive = true
}

variable "vm_admin_password" {
 type = string
 description = "The administrator password for the virtual machine"
 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" "virtualNetwork" {
 type = "Microsoft.Network/virtualNetworks@2022-07-01"
 parent_id = azapi_resource.resourceGroup.id
 name = var.resource_name
 location = var.location
 body = {
 properties = {
 addressSpace = {
 addressPrefixes = [
 "10.0.0.0/16",
 ]
 }
 dhcpOptions = {
 dnsServers = [
 ]
 }
 subnets = [
 ]
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
 lifecycle {
 ignore_changes = [body.properties.subnets]
 }
}

resource "azapi_resource" "subnet" {
 type = "Microsoft.Network/virtualNetworks/subnets@2022-07-01"
 parent_id = azapi_resource.virtualNetwork.id
 name = "internal"
 body = {
 properties = {
 addressPrefix = "10.0.2.0/24"
 delegations = [
 ]
 privateEndpointNetworkPolicies = "Enabled"
 privateLinkServiceNetworkPolicies = "Enabled"
 serviceEndpointPolicies = [
 ]
 serviceEndpoints = [
 ]
 }
 }
 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.automation_worker_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 = ["*"]
}

resource "azapi_resource" "networkInterface" {
 type = "Microsoft.Network/networkInterfaces@2022-07-01"
 parent_id = azapi_resource.resourceGroup.id
 name = var.resource_name
 location = var.location
 body = {
 properties = {
 enableAcceleratedNetworking = false
 enableIPForwarding = false
 ipConfigurations = [
 {
 name = "testconfiguration1"
 properties = {
 primary = true
 privateIPAddressVersion = "IPv4"
 privateIPAllocationMethod = "Dynamic"
 subnet = {
 id = azapi_resource.subnet.id
 }
 }
 },
 ]
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}

resource "azapi_resource" "virtualMachine" {
 type = "Microsoft.Compute/virtualMachines@2023-03-01"
 parent_id = azapi_resource.resourceGroup.id
 name = var.resource_name
 location = var.location
 body = {
 properties = {
 additionalCapabilities = {
 }
 applicationProfile = {
 galleryApplications = [
 ]
 }
 diagnosticsProfile = {
 bootDiagnostics = {
 enabled = false
 storageUri = ""
 }
 }
 extensionsTimeBudget = "PT1H30M"
 hardwareProfile = {
 vmSize = "Standard_D2s_v3"
 }
 networkProfile = {
 networkInterfaces = [
 {
 id = azapi_resource.networkInterface.id
 properties = {
 primary = true
 }
 },
 ]
 }
 osProfile = {
 adminPassword = var.vm_admin_password
 adminUsername = "adminuser"
 allowExtensionOperations = true
 computerName = var.resource_name
 linuxConfiguration = {
 disablePasswordAuthentication = false
 patchSettings = {
 assessmentMode = "ImageDefault"
 patchMode = "ImageDefault"
 }
 provisionVMAgent = true
 ssh = {
 publicKeys = [
 ]
 }
 }
 secrets = [
 ]
 }
 priority = "Regular"
 storageProfile = {
 dataDisks = [
 ]
 imageReference = {
 offer = "UbuntuServer"
 publisher = "Canonical"
 sku = "16.04-LTS"
 version = "latest"
 }
 osDisk = {
 caching = "ReadWrite"
 createOption = "FromImage"
 managedDisk = {
 storageAccountType = "Standard_LRS"
 }
 osType = "Linux"
 writeAcceleratorEnabled = false
 }
 }
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}

resource "azapi_resource" "hybridRunbookWorker" {
 type = "Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers@2021-06-22"
 parent_id = azapi_resource.hybridRunbookWorkerGroup.id
 name = "c7714056-5ba8-4bbe-920e-2993171164eb"
 body = {
 properties = {
 vmResourceId = azapi_resource.virtualMachine.id
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}

Feedback

Was this page helpful?

Additional resources

  • Last updated on