Module vm-scale-set

vmss

Property	Value	Description
general (required)	general
identity	identity
keyVaultId (required)	string	Resource ID of the Key Vault used for admin password
sku (required)	sku	The virtual machine scale set sku.
zones	Array containing any of: '1' '2' '3'	The virtual machine scale set zones.
properties (required)	properties	Describes the properties of a Virtual Machine Scale Set.

identity

Property	Value	Description
type	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'	The types of identities associated with this resource. (default: none)
userAssignedIdentities	string[]	Resource IDs of User Assigned Identities to associate with this resource

sku

Property	Value	Description
capacity (required)	int	Specifies the number of virtual machines in the scale set.
name (required)	string	The sku name.
tier	'Basic' 'Standard'	Specifies the tier of virtual machines in a scale set. Possible Values: Standard, Basic

additionalCapabilities

Property	Value	Description
hibernationEnabled	bool	The flag that enables or disables hibernation capability on the VM.
ultraSSDEnabled	bool	The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

automaticRepairsPolicy

Property	Value	Description
enabled (required)	bool	Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.
gracePeriod (required)	string	The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).
repairAction (required)	'Reimage' 'Replace' 'Restart'	Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

hostGroup

Property	Value	Description
id (required)	string	Resource Id

priorityMixPolicy

Property	Value	Description
baseRegularPriorityCount (required)	int	The base number of regular priority VMs that will be created in this scale set as it scales out.
regularPriorityPercentageAboveBase (required)	int	The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority.

proximityPlacementGroup

Property	Value	Description
id (required)	string	Resource Id

resilientVMCreationPolicy

Property	Value	Description
enabled (required)	bool	Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false.

resilientVMDeletionPolicy

Property	Value	Description
enabled (required)	bool	Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false.

resiliencyPolicy

Property	Value	Description
resilientVMCreationPolicy (required)	resilientVMCreationPolicy	The configuration parameters used while performing resilient VM creation.
resilientVMDeletionPolicy (required)	resilientVMDeletionPolicy	The configuration parameters used while performing resilient VM deletion.

scaleInPolicy

Property	Value	Description
forceDeletion (required)	bool	This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.
rules (required)	Array containing any of: 'Default' 'NewestVM' 'OldestVM'	The rules to be followed when scaling-in a virtual machine scale set.

eventGridAndResourceGraph

Property	Value	Description
enable (required)	bool	Specifies if event grid and resource graph is enabled for Scheduled event related configurations.

scheduledEventsAdditionalPublishingTargets

Property	Value	Description
eventGridAndResourceGraph (required)	eventGridAndResourceGraph	The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.

userInitiatedReboot

Property	Value	Description
automaticallyApprove (required)	bool	Specifies Reboot Scheduled Event related configurations.

userInitiatedRedeploy

Property	Value	Description
automaticallyApprove (required)	bool	Specifies Redeploy Scheduled Event related configurations.

scheduledEventsPolicy

Property	Value	Description
scheduledEventsAdditionalPublishingTargets	scheduledEventsAdditionalPublishingTargets	The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
userInitiatedReboot	userInitiatedReboot	The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
userInitiatedRedeploy	userInitiatedRedeploy	The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.

vmSizes

Property	Value	Description
name (required)	string	Specifies the name of the VM Size.

skuProfile

Property	Value	Description
allocationStrategy (required)	'CapacityOptimized' 'LowestPrice'	Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated.
vmSizes (required)	vmSizes[]	Specifies the VM sizes for the virtual machine scale set.

spotRestorePolicy

Property	Value	Description
enabled (required)	bool	Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints
restoreTimeout (required)	string	Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances

automaticOSUpgradePolicy

Property	Value	Description
disableAutomaticRollback (required)	bool	Whether OS image rollback feature should be disabled. Default value is false.
enableAutomaticOSUpgrade (required)	bool	Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, enableAutomaticUpdates is automatically set to false and cannot be set to true.
osRollingUpgradeDeferral (required)	bool	Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag Platform.PendingOSUpgrade. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call.
useRollingUpgradePolicy (required)	bool	Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

rollingUpgradePolicy

Property	Value	Description
enableCrossZoneUpgrade	bool	Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.
maxBatchInstancePercent	int	The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.
maxSurge	bool	Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch.
maxUnhealthyInstancePercent	int	The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.
maxUnhealthyUpgradedInstancePercent	int	The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.
pauseTimeBetweenBatches	string	The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).
prioritizeUnhealthyInstances	bool	Upgrade all unhealthy instances in a scale set before any healthy instances.
rollbackFailedInstancesOnPolicyBreach	bool	Rollback failed instances to previous model if the Rolling Upgrade policy is violated.

upgradePolicy

Property	Value	Description
automaticOSUpgradePolicy	automaticOSUpgradePolicy	Configuration parameters used for performing automatic OS Upgrade.
mode (required)	'Automatic' 'Manual' 'Rolling'	Specifies the mode of an upgrade to virtual machines in the scale set.
rollingUpgradePolicy	rollingUpgradePolicy	The configuration parameters used while performing a rolling upgrade.

bootDiagnostics

Property	Value	Description
enabled (required)	bool	Whether boot diagnostics should be enabled on the Virtual Machine.
storageUri	string	Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.

diagnosticsProfile

Property	Value	Description
bootDiagnostics (required)	bootDiagnostics	Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

healthProbe

Property	Value	Description
id (required)	string	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

dnsSettings

Property	Value	Description
dnsServers (required)	string[]	List of DNS servers IP addresses

applicationGatewayBackendAddressPools

Property	Value	Description
id (required)	string	Resource Id

applicationSecurityGroups

Property	Value	Description
id (required)	string	Resource Id

loadBalancerBackendAddressPools

Property	Value	Description
id (required)	string	Resource Id

loadBalancerInboundNatPools

Property	Value	Description
id (required)	string	Resource Id

subnet

Property	Value	Description
id (required)	string	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

properties

Property	Value	Description
additionalCapabilities	additionalCapabilities	Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
automaticRepairsPolicy	automaticRepairsPolicy	Policy for automatic repairs.
constrainedMaximumCapacity	bool	Optional property which must either be set to True or omitted.
doNotRunExtensionsOnOverprovisionedVMs	bool	When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
hostGroup	hostGroup	Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
orchestrationMode (required)	'Flexible' 'Uniform'	Specifies the orchestration mode for the virtual machine scale set.
overprovision	bool	Specifies whether the Virtual Machine Scale Set should be overprovisioned.
platformFaultDomainCount	int	Fault Domain count for each placement group.
priorityMixPolicy	priorityMixPolicy	Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
proximityPlacementGroup	proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
resiliencyPolicy	resiliencyPolicy	Policy for Resiliency
scaleInPolicy	scaleInPolicy	Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
scheduledEventsPolicy	scheduledEventsPolicy	The ScheduledEventsPolicy.
singlePlacementGroup	bool	When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
skuProfile	skuProfile	Specifies the sku profile for the virtual machine scale set.
spotRestorePolicy	spotRestorePolicy	Specifies the Spot Restore properties for the virtual machine scale set.
upgradePolicy (required)	upgradePolicy	The upgrade policy.
virtualMachineProfile (required)	virtualMachineProfile	The virtual machine profile.
zonalPlatformFaultDomainAlignMode	'Aligned' 'Unaligned'	Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.
zoneBalance	bool	Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

ipConfiguration

Property	Value	Description
name (required)	string	The IP configuration name.
properties (required)	properties	Describes a virtual machine scale set network profiles IP configuration properties.

networkSecurityGroup

Property	Value	Description
id (required)	string	Resource Id

networkInterfaceConfiguration

Property	Value	Description
auxiliaryMode	'AcceleratedConnections' 'Floating' 'None'	Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
auxiliarySku	'A1' 'A2' 'A4' 'A8' 'None'	Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
disableTcpStateTracking	bool	Specifies whether the network interface is disabled for tcp state tracking.
dnsSettings	dnsSettings	The dns settings to be applied on the network interfaces.
enableAcceleratedNetworking	bool	Specifies whether the network interface is accelerated networking-enabled.
enableFpga	bool	Specifies whether the network interface is FPGA networking-enabled.
enableIPForwarding	bool	Whether IP forwarding enabled on this NIC.
ipConfiguration (required)	ipConfiguration	Specifies the IP configurations of the network interface.
networkSecurityGroup	networkSecurityGroup	The network security group.

networkProfile

Property	Value	Description
healthProbe	healthProbe	A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set.
networkInterfaceConfiguration (required)	networkInterfaceConfiguration	The list of network configurations.

automaticByPlatformSettings

Property	Value	Description
bypassPlatformSafetyChecksOnUserSchedule (required)	bool	Enables customer to schedule patching without accidental upgrades
rebootSetting	'Always' 'IfRequired' 'Never'	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

patchSettings

Property	Value	Description
assessmentMode	'AutomaticByPlatform' 'ImageDefault'	Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.
enableHotpatching	bool	Enables customers to patch their Azure VMs without requiring a reboot.
patchMode	'AutomaticByOS' 'AutomaticByPlatform' 'Manual'	pecifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

publicKeys

Property	Value	Description
keyData (required)	string	SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]/azure/virtual-machines/linux/create-ssh-keys-detailed).
path (required)	string	Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

ssh

Property	Value	Description
publicKeys (required)	publicKeys[]	The list of SSH public keys used to authenticate with linux based VMs.

linuxConfiguration

Property	Value	Description
enableVMAgentPlatformUpdates	bool	Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.
disablePasswordAuthentication (required)	bool	Specifies whether password authentication should be disabled.
patchSettings	patchSettings	[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
provisionVMAgent (required)	bool	Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ssh	ssh	Specifies the ssh key configuration for a Linux OS.

additionalUnattendContent

Property	Value	Description
componentName	'Microsoft-Windows-Shell-Setup'	The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
content	string	Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
passName	'OobeSystem'	The pass name. Currently, the only allowable value is OobeSystem.
settingName	'AutoLogon' 'FirstLogonCommands'	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

windowsConfiguration

Property	Value	Description
additionalUnattendContent	additionalUnattendContent[]	Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
enableAutomaticUpdates	bool	Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
patchSettings	patchSettings	Specifies settings related to VM Guest Patching on Windows.
provisionVMAgent	bool	Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
timeZone (required)	string	Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.

osProfile

Property	Value	Description
adminUsername (required)	string	Specifies the name of the administrator account. (default: arxus)
adminPasswordKeyVaultSecretName (required)	string	Key Vault Secret name of for the password
computerNamePrefix (required)	string	Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.
linuxConfiguration	linuxConfiguration	Specifies the Linux operating system settings on the virtual machine
windowsConfiguration	windowsConfiguration	Specifies Windows operating system settings on the virtual machine.

managedDisk

Property	Value	Description
storageAccountType (required)	'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' 'Standard_LRS' 'UltraSSD_LRS'	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

dataDisks

Property	Value	Description
caching	'None' 'ReadOnly' 'ReadWrite'	Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
createOption (required)	'Attach' 'Copy' 'Empty' 'FromImage' 'Restore'	The create option.
deleteOption	'Delete' 'Detach'	Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).
diskIOPSReadWrite	int	Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
diskMBpsReadWrite	int	Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
diskSizeGB (required)	int	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
lun (required)	int	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
managedDisk (required)	managedDisk	The managed disk parameters.
name (required)	string	The disk name.
writeAcceleratorEnabled	bool	Specifies whether writeAccelerator should be enabled or disabled on the disk.

imageReference

Property	Value	Description
communityGalleryImageId	string	Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.
id	string	Resource Id
offer	string	Specifies the offer of the platform image or marketplace image used to create the virtual machine.
publisher	string	The image publisher.
sharedGalleryImageId	string	Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
sku	string	The image SKU.
version	string	Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or "latest". Major, Minor, and Build are decimal numbers. Specify "latest" to use the latest version of an image available at deploy time. Even if you use "latest", the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field "version" for gallery image deployment, gallery image should always use "id" field for deployment, to use "latest" version of gallery image, just set "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}" in the "id" field without version input.

diffDiskSettings

Property	Value	Description
option (required)	'Local'	Specifies the ephemeral disk settings for operating system disk.
placement (required)	'CacheDisk' 'NvmeDisk' 'ResourceDisk'	Specifies the ephemeral disk placement for operating system disk.

image

Property	Value	Description
uri (required)	string	Specifies the virtual hard disks uri.

osDisk

Property	Value	Description
caching	'None' 'ReadOnly' 'ReadWrite'	Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
createOption	'Attach' 'Copy' 'Empty' 'FromImage' 'Restore'	Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
deleteOption	'Delete' 'Detach'	Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).
diffDiskSettings	diffDiskSettings	Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
diskSizeGB	int	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
image	image	Specifies information about the unmanaged user image to base the scale set on.
managedDisk (required)	managedDisk	The managed disk parameters.
osType (required)	'Linux' 'Windows'	This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.
vhdContainers	string[]	Specifies the container urls that are used to store operating system disks for the scale set.
writeAcceleratorEnabled	bool	Specifies whether writeAccelerator should be enabled or disabled on the disk.

storageProfile

Property	Value	Description
dataDisks	dataDisks[]	Specifies the parameters that are used to add data disks to the virtual machines in the scale set.
diskControllerType	string
imageReference (required)	imageReference	Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.
osDisk (required)	osDisk	Specifies information about the operating system disk used by the virtual machines in the scale set.

virtualMachineProfile

Property	Value	Description
diagnosticsProfile	diagnosticsProfile	Specifies the boot diagnostic settings state
licenseType	'RHEL_BYOS' 'SLES_BYOS' 'Windows_Client' 'Windows_Server'	Specifies that the image or disk that is being used was licensed on-premises.
networkProfile (required)	networkProfile	Specifies properties of the network interfaces of the virtual machines in the scale set.
osProfile (required)	osProfile	Specifies the operating system settings for the virtual machines in the scale set.
priority	'Low' 'Regular' 'Spot'	Specifies the priority for the virtual machines in the scale set.
storageProfile (required)	storageProfile	Specifies the storage settings for the virtual machine disks.

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

Changelog

3.2.0 (2025-10-07)

Features

• update resource api version

3.1.1 (2025-09-24)

Bug Fixes

• remove deployment name + cleanup

3.1.0 (2025-03-26)

Features

• add resourceName output

3.0.0 (2025-03-17)

⚠ BREAKING CHANGES

• remove role-assignment principalType parameter

Features

• remove role-assignment principalType parameter

2.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.

1.0.1 (2025-01-02)

Bug Fixes

• use new toObject function for UserAssignedIdentities