Bicep Module Documentation

← Back to Overview

Module bastion-host

bastionHost

Property Value Description
general (required) general
publicIPAddressNaming naming Override name of the public IP address
skuName 'Basic'
'Developer'
'Standard'
The sku of this Bastion Host.
ddosProtectionMode 'Disabled'
'Enabled'
'VirtualNetworkInherited'
DDoS Protection plan for public IP, Enabled = configure per IP (default = VirtualNetworkInherited)
disableCopyPaste bool Enable/Disable Copy/Paste feature of the Bastion Host resource. (default: false)
dnsName string FQDN for the endpoint on which bastion host is accessible.
enableFileCopy bool Enable/Disable File Copy feature of the Bastion Host resource. (default: true)
enableIpConnect bool Enable/Disable IP Connect feature of the Bastion Host resource. (default: true)
enableKerberos bool Enable/Disable Kerberos feature of the Bastion Host resource. (default: true)
enableShareableLink bool Enable/Disable Shareable Link of the Bastion Host resource. (default: true)
enableTunneling bool Enable/Disable Tunneling feature of the Bastion Host resource. (default: true)
scaleUnits int The scale units for the Bastion Host resource. (default: 2)
subnetId (required) string Subnet ID (for Developer SKU enter any subnetId or just the vNetID)
ipRules bastionIpRule[] Sets the IP ACL rules for Developer Bastion Host.

bastionIpRule

Property Value Description
addressPrefix (required) string Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.

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

4.1.0 (2025-10-06)

Features

  • update resource api version

4.0.1 (2025-09-24)

Bug Fixes

  • remove deployment name + cleanup

4.0.0 (2025-09-24)

⚠ BREAKING CHANGES

  • remove deprecated outputs

Bug Fixes

  • remove deprecated outputs

3.3.1 (2025-04-11)

Bug Fixes

  • naming connected resources when forceFunctionAsFullName or forceDefaultNaming is true

3.3.0 (2025-03-26)

Features

  • add resourceName output

3.2.2 (2025-02-28)

Bug Fixes

  • revise descriptions