Bicep Module Documentation
← Back to Overview
Module event-grid-topic
eventGridTopic
| Property | Value | Description |
|---|---|---|
| general (required) | general | |
| identity | identity | Configuration of the Managed Identity for this |
| sku | 'Basic' 'Premium' |
|
| kind | 'Azure' 'AzureArc' |
|
| extendedLocation | extendedLocation | |
| dataResidencyBoundary | 'WithinGeopair' 'WithinRegion' |
|
| disableLocalAuth | bool | This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. |
| eventTypeInfo | inlineEventType | |
| inboundIpRules | inboundIpRules[] | |
| inputSchema (required) | 'CloudEventSchemaV1_0' 'CustomEventSchema' 'EventGridSchema' |
|
| inputSchemaMapping | jsonInputSchemaMapping | |
| minimumTlsVersionAllowed | '1.0' '1.1' '1.2' |
|
| publicNetworkAccess (required) | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
|
| privateLink | privateLink | Settings for the Private Endpoint and Private Link for this resource |
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 |
extendedLocation
| Property | Value | Description |
|---|---|---|
| name (required) | string | |
| type (required) | string |
inboundIpRules
| Property | Value | Description |
|---|---|---|
| action (required) | 'Allow' | |
| ipMask (required) | string |
jsonInputSchemaMapping
| Property | Value | Description |
|---|---|---|
| inputSchemaMappingType (required) | 'Json' | |
| properties (required) | properties |
dataVersion
| Property | Value | Description |
|---|---|---|
| defaultValue (required) | string | |
| sourceField (required) | string |
eventTime
| Property | Value | Description |
|---|---|---|
| sourceField (required) | string |
eventType
| Property | Value | Description |
|---|---|---|
| defaultValue (required) | string | |
| sourceField (required) | string |
id
| Property | Value | Description |
|---|---|---|
| sourceField (required) | string |
subject
| Property | Value | Description |
|---|---|---|
| defaultValue (required) | string | |
| sourceField (required) | string |
topic
| Property | Value | Description |
|---|---|---|
| sourceField (required) | string |
properties
| Property | Value | Description |
|---|---|---|
| dataVersion (required) | dataVersion | |
| eventTime (required) | eventTime | |
| eventType (required) | eventType | |
| id (required) | id | |
| subject (required) | subject | |
| topic (required) | topic |
inlineEventType
| Property | Value | Description |
|---|---|---|
| kind (required) | 'Inline' | |
| inlineEventTypes (required) | object |
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
2.2.0 (2025-10-06)
Features
- update resource api versions
2.1.2 (2025-09-24)
Bug Fixes
- remove deployment name + cleanup
2.1.1 (2025-04-11)
Bug Fixes
- naming connected resources when forceFunctionAsFullName or forceDefaultNaming is true
2.1.0 (2025-03-26)
Features
- add resourceName output
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.