Bicep Module Documentation

← Back to Overview

Module network-security-group

networkSecurityGroup

Property Value Description
general (required) general
securityRules securityRule[] Security rules contained in the network security group [Array of security groups]

securityRule

Property Value Description
naming (required) naming
priority int The priority of the rule, the priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule (default: 1000+index of rule) [integer 100-4096]
direction (required) 'Inbound'
'Outbound'
The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic
access 'Allow'
'Deny'
The network traffic is allowed or denied (default: Allow)
protocol '*'
'Ah'
'Esp'
'Icmp'
'Tcp'
'Udp'
Network protocol this rule applies to (default: *)
sourceAddressPrefix string The source IP range (default: Any) [CIDR notation
sourceAddressPrefixes string[] The source IP ranges [Array of CIDR notations]
sourceApplicationSecurityGroups string[] The array of application security groups specified as source [Array of ResourceIds]
sourcePortRange string The source port range (default: Any) [string 0-65535]
sourcePortRanges string[] The source port ranges [array of strings 0-65535]
destinationAddressPrefix string The destination IP range (default: Any) [CIDR notation
destinationAddressPrefixes string[] The destination IP ranges [Array of CIDR notations or ServiceTags]
destinationApplicationSecurityGroups string[] The array of application security groups specified as destination [Array of ResourceIds]
destinationPortRange string The destination port range (default: Any) [string 0-65535]
destinationPortRanges string[] The destination port ranges [array of strings 0-65535]

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

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

Changelog

2.0.1 (2025-09-24)

Bug Fixes

  • remove deployment name + cleanup

2.0.0 (2025-09-24)

⚠ BREAKING CHANGES

  • remove deprecated outputs

Bug Fixes

  • remove deprecated outputs

1.5.1 (2025-06-25)

Bug Fixes

  • remove deployment names

1.5.0 (2025-03-26)

Features

  • add resourceName output

1.4.1 (2025-02-24)

Bug Fixes

  • update deployment names to uniqueDeploymentNames