Module storage-sync

storageSync

Property	Value	Description
general (required)	general
incomingTrafficPolicy	'AllowAllTraffic' 'AllowVirtualNetworksOnly'	Incoming Traffic Policy (default: AllowAllTraffic)
privateLink	privateLink	Settings for the private endpoint and private link for this resource
syncGroups	storageSyncGroup[]	Sync groups in the Storage Sync resource

storageSyncGroup

Property	Value	Description
name (required)	string	The resource name
cloudEndpoint	storageSyncCloudEndpoint	Cloud Endpoint
serverEndpoints	storageSyncServerEndpoint[]	Server Endpoints

storageSyncCloudEndpoint

Property	Value	Description
name (required)	string	The resource name
azureFileShareName (required)	string	Azure file share name
friendlyName (required)	string	Friendly Name
storageAccountResourceId (required)	string	Storage Account Resource Id
storageAccountTenantId	string	Storage Account Tenant Id (default: tenant().tenantId)

storageSyncServerEndpoint

Property	Value	Description
name (required)	string	The resource name
cloudTiering	'off' 'on'	Cloud Tiering. (default: off)
friendlyName	string	Friendly Name
initialDownloadPolicy	'AvoidTieredFiles' 'NamespaceOnly' 'NamespaceThenModifiedFiles'	Policy for how namespace and files are recalled during FastDr. (default: AvoidTieredFiles)
initialUploadPolicy	'Merge' 'ServerAuthoritative'	Policy for how the initial upload sync session is performed. (default: ServerAuthoritative)
localCacheMode	'DownloadNewAndModifiedFiles' 'UpdateLocallyCachedFiles'	Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. (default: DownloadNewAndModifiedFiles)
offlineDataTransfer	'off' 'on'	Offline data transfer (default: off)
offlineDataTransferShareName	string	Offline data transfer share name
serverLocalPath (required)	string	Server Local path.
serverResourceId (required)	string	Server Resource Id.
tierFilesOlderThanDays	int	Tier files older than days.
volumeFreeSpacePercent	int	Level of free space to be maintained by Cloud Tiering if it is enabled.

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. Cant 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 cant 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

1.4.0 (2025-10-06)

Features

• update resource api versions

1.3.2 (2025-09-24)

Bug Fixes

• remove deployment name + cleanup

1.3.1 (2025-04-11)

Bug Fixes

• naming connected resources when forceFunctionAsFullName or forceDefaultNaming is true

1.3.0 (2025-03-26)

Features

• add resourceName output