Module automation-account

automationAccount

Property	Value	Description
general (required)	general
identity	identity
disableLocalAuth	bool	Indicates whether requests using non-AAD authentication are blocked
encryption	encryption	Set the encryption properties for the automation account
publicNetworkAccess	bool	Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet (default: true)
sku	sku	Gets or sets account SKU.
privateLinkDSCHybridWorker	privateLink	Settings for the private endpoint and private link for this resource
privateLinkWebHook	privateLink	Settings for the private endpoint and private link for this resource

identity

Property	Value	Description
userAssignedIdentity (required)	string

keyVaultProperties

Property	Value	Description
keyName (required)	string	The name of key used to encrypt data.
keyvaultUri (required)	string	The URI of the key vault key used to encrypt data.
keyVersion (required)	string	The key version of the key used to encrypt data.

encryption

Property	Value	Description
identity	identity	User identity used for CMK.
keySource (required)	'Microsoft.Automation' 'Microsoft.Keyvault'	Encryption Key Source
keyVaultProperties	keyVaultProperties	Key vault properties.

sku

Property	Value	Description
capacity	int	Gets or sets the SKU capacity.
family	string	Gets or sets the SKU family.
name	'Basic' 'Free'	Gets or sets the SKU name of the account. (default: Basic)

naming

Property	Value	Description
forceFunctionAsFullName	bool	Use the function value as the full name of the resource
abbreviation	string	Override the abbreviation of this resource with this parameter
environment	string	The resource environment (for example: dev, tst, acc, prd)
location	string	The resource location (for example: weu, we, westeurope)
customer	string	The name of the customer
delimiter	string	The delimiter between resources (default: -)
nameFormat	Array containing any of: 'abbreviation' 'customer' 'environment' 'function' 'location' 'param1' 'param2' 'param3' 'useCaseName'	The order of the array defines the order of elements in the naming scheme
param1	string	Extra parameter self defined
param2	string	Extra parameter self defined
param3	string	Extra parameter self defined
function (required)	string	Function of the resource [can be app, db, security,...]
useCaseName	string	Name of the use case [can be hub, spoke,...]
suffix	string	Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...]
forceDefaultNaming	bool	Force the CAF naming instead of default company naming

resourceLock

Property	Value	Description
name	string	Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Can't end in period.
level (required)	'CanNotDelete' 'ReadOnly'	The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Read-Only locks must be commented to be able to deploy again
notes	string	Notes about the lock. Maximum of 512 characters.
owners	resourceLockOwner[]	The owners of the lock

resourceLockOwner

Property	Value	Description
applicationId (required)	string	The application ID of the lock owner.

roleAssignment

Property	Value	Description
principalId (required)	string	The principal ID
roleDefinitionId (required)	string	The role definition ID, data file can be used for this
condition	string	Condition on the role assignment
conditionVersion	string	Version of the condition. Currently the only accepted value is "2.0"
delegatedManagedIdentityResourceId	string	Id of the delegated managed identity resource
description	string	Description of role assignment

general

Property	Value	Description
tags	object	Tags of the resource [hashtable]
location (required)	string	Location of the resource
naming (required)	naming	Naming module of the resource
resourceGroupName (required)	string	Name of the resource group where the resource should be located
sharedNaming (required)	naming	Reference to the default naming
roleAssignments	roleAssignment[]	Role assignments on the resource
resourceLocks	resourceLock[]	Resource Locks on the resource

privateLink

Property	Value	Description
pepNaming	naming	Name of the private endpoint
nicNaming	naming	Name of the network interface of the private endpoint
privateLinkNaming	naming	Name of the private link connection
subnets (required)	subnets[]	Id of the subnets and optionally the name of the resourcegroup in which the private endpoint should be created
dnsZoneIds (required)	string[]	List of DNS zone ids that need to be linked

subnets

Property	Value	Description
resourceGroupName	string	Resourcegroup (default: resourcegroup defined here => resourceGroup of pep resource => resourceGroup of subnet)
id (required)	string	Id of the subnet
location	string	Location if Vnet is in different location

Changelog

4.2.0 (2025-10-06)

Features

• update resource api version

4.1.2 (2025-09-24)

Bug Fixes

• remove deployment name + cleanup

4.1.1 (2025-04-11)

Bug Fixes

• naming connected resources when forceFunctionAsFullName or forceDefaultNaming is true

4.1.0 (2025-03-26)

Features

• add resourceName output

4.0.0 (2025-01-03)

⚠ BREAKING CHANGES

• use new toObject function for UserAssignedIdentities. Only breaking when using managed identities.

Features

• use new toObject function for UserAssignedIdentities. Only breaking when using managed identities.

3.0.4 (2024-12-04)

Bug Fixes

• test aa version

3.0.3 (2024-12-04)

Bug Fixes

• aa test

3.0.2 (2024-12-04)

Bug Fixes

• inline script pipeline

3.0.1 (2024-12-04)

Bug Fixes

• automation account test version