Skip to content

Commit

Permalink
modularized eventgrid creation to avoid changing values by mistake.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmservera
jmservera committed Apr 18, 2024
1 parent bf3e5f5 commit 661af27
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 69 deletions.
132 changes: 80 additions & 52 deletions eventgrid/templates/eventgrid.bicep
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
param location string = resourceGroup().location
@description('The name of the Event Grid namespace.')
param namespaces_name string = 'jmeventgrid'
@minLength(3)
param custom_topic_name string = 'test'
@description('An array containing the clients that will be allowed to interact with the Event Grid namespace. Each client must have a name, a thumbprint, and a role. The role can be either "service" or "device".')
param clients array = [
Expand All @@ -12,133 +13,158 @@ param clients array = [
}
]

resource namespace_resource 'Microsoft.EventGrid/namespaces@2023-12-15-preview' = {
name: namespaces_name
location: location
sku: {
name: 'Standard'
capacity: 1
var names = {
topics:{
data: 'data'
devices: 'devices'
}
identity: {
type: 'SystemAssigned'
clientGroups:{
publishers: 'publishers'
datasubscribers: 'datasubscribers'
devices: 'devices'
}
properties: {
topicsConfiguration: {}
topicSpacesConfiguration: {
state: 'Enabled'
maximumSessionExpiryInHours: 2
maximumClientSessionsPerAuthenticationName: 2 // to allow for some disconnection test scenarios
//routeTopicResourceId: resourceId('Microsoft.EventGrid/namespaces/topics', namespaces_name, custom_topic_name)
}
isZoneRedundant: true
publicNetworkAccess: 'Enabled'
}

// we use a module to create the basic Event Grid namespace
// because when building the integration with Event Hub and assigning the routeTopicResourceId
// we will need to call the module again
module namespace_creation 'modules/eventgridinstance.bicep' = {
name: namespaces_name
params: {
location: location
namespaces_name: namespaces_name
}
}

resource topics 'topics' = {
name: custom_topic_name
properties: {
inputSchema: 'CloudEventSchemaV1_0'
}
resource topics 'Microsoft.EventGrid/namespaces/topics@2023-12-15-preview' = {
name: '${namespaces_name}/${custom_topic_name}' // now with the module we cannot use the parent property, so using the names instead
properties: {
inputSchema: 'CloudEventSchemaV1_0'
}
dependsOn:[
namespace_creation
]
}

// ********************************************************************************************************************
// * Create client groups
// ********************************************************************************************************************

resource namespace_group_c2d_publishers 'Microsoft.EventGrid/namespaces/clientGroups@2023-12-15-preview' = {
parent: namespace_resource
name: 'publishers'
name: '${namespaces_name}/${names.clientGroups.publishers}'
properties: {
description: 'Group for services that can send data to devices.'
query: 'attributes.role in [\'service\']'
}
dependsOn:[
namespace_creation
]
}

resource namespace_group_telemetry_subscribers 'Microsoft.EventGrid/namespaces/clientGroups@2023-12-15-preview' = {
parent: namespace_resource
name: 'datasubscribers'
name: '${namespaces_name}/${names.clientGroups.datasubscribers}'
properties: {
description: 'Group for services that can subscribe to the device data feed.'
query: 'attributes.role in [\'service\', \'device\']'
}
dependsOn:[
namespace_creation
]
}

resource namespace_group_devices 'Microsoft.EventGrid/namespaces/clientGroups@2023-12-15-preview' = {
parent: namespace_resource
name: 'devices'
name: '${namespaces_name}/${names.clientGroups.devices}'
properties: {
description: 'Group for the devices.'
query: 'attributes.role in [\'device\']'
}
dependsOn:[
namespace_creation
]
}

// ********************************************************************************************************************
// * Create permission bindings
// ********************************************************************************************************************

resource namespace_telemetrypublish 'Microsoft.EventGrid/namespaces/permissionBindings@2023-12-15-preview' = {
parent: namespace_resource
name: 'telemetrypublish'
name: '${namespaces_name}/telemetrypublish'
properties: {
topicSpaceName: namespace_topic_spaces_data.name
topicSpaceName: names.topics.data //cannot contain namespace name prefix, so we cannot use the namespace_topic_spaces_data.name variable
permission: 'Publisher'
clientGroupName: namespace_group_devices.name
clientGroupName: names.clientGroups.devices // cannot contain the namespace prefix, so we cannot use the namespace_group_devices.name variable
}
dependsOn:[
namespace_creation
namespace_group_devices
]
}

resource namespace_telemetryread 'Microsoft.EventGrid/namespaces/permissionBindings@2023-12-15-preview' = {
parent: namespace_resource
name: 'telemetryread'
name: '${namespaces_name}/telemetryread'
properties: {
topicSpaceName: namespace_topic_spaces_data.name
topicSpaceName: names.topics.data
permission: 'Subscriber'
clientGroupName: namespace_group_telemetry_subscribers.name
clientGroupName: names.clientGroups.datasubscribers
}
dependsOn:[
namespace_creation
namespace_group_telemetry_subscribers
]
}

resource namespace_devicespublish 'Microsoft.EventGrid/namespaces/permissionBindings@2023-12-15-preview' = {
parent: namespace_resource
name: 'devicespublish'
name: '${namespaces_name}/devicespublish'
properties: {
topicSpaceName: namespace_topic_spaces_devices.name
topicSpaceName: names.topics.devices
permission: 'Publisher'
clientGroupName: namespace_group_c2d_publishers.name
clientGroupName: names.clientGroups.publishers
}
dependsOn:[
namespace_creation
namespace_group_c2d_publishers
]
}

resource namespace_devicessubscribe 'Microsoft.EventGrid/namespaces/permissionBindings@2023-12-15-preview' = {
parent: namespace_resource
name: 'devicessubscribe'
name: '${namespaces_name}/devicessubscribe'
properties: {
topicSpaceName: namespace_topic_spaces_devices.name
topicSpaceName: names.topics.devices
permission: 'Subscriber'
clientGroupName: namespace_group_telemetry_subscribers.name
clientGroupName: names.clientGroups.datasubscribers
}
dependsOn:[
namespace_creation
namespace_group_telemetry_subscribers
]
}

// ********************************************************************************************************************
// * Create topic spaces
// ********************************************************************************************************************
resource namespace_topic_spaces_data 'Microsoft.EventGrid/namespaces/topicSpaces@2023-12-15-preview' = {
parent: namespace_resource
name: 'data'
name: '${namespaces_name}/${names.topics.data}'
properties: {
topicTemplates: [
'data/#'
'data/\${client.authenticationName}/telemetry'
]
}
dependsOn:[
namespace_creation
]
}

resource namespace_topic_spaces_devices 'Microsoft.EventGrid/namespaces/topicSpaces@2023-12-15-preview' = {
parent: namespace_resource
name: 'devices'
name: '${namespaces_name}/${names.topics.devices}'
properties: {
topicTemplates: [
'devices/#'
]
}
dependsOn:[
namespace_creation
]
}

// ********************************************************************************************************************
Expand All @@ -147,8 +173,7 @@ resource namespace_topic_spaces_devices 'Microsoft.EventGrid/namespaces/topicSpa

resource namespaces_name_clients 'Microsoft.EventGrid/namespaces/clients@2023-12-15-preview' = [
for (config, i) in clients: {
parent: namespace_resource
name: config.name
name: '${namespaces_name}/${config.name}'
properties: {
authenticationName: '${config.name}-authn-ID'
clientCertificateAuthentication: {
Expand All @@ -162,7 +187,10 @@ resource namespaces_name_clients 'Microsoft.EventGrid/namespaces/clients@2023-12
role: config.role
}
}
dependsOn:[
namespace_creation
]
}
]

output namespace_mqtt_hostname string = namespace_resource.properties.topicSpacesConfiguration.hostname
output namespace_mqtt_hostname string = namespace_creation.outputs.namespace_resource.properties.topicSpacesConfiguration.hostname
30 changes: 13 additions & 17 deletions eventgrid/templates/eventhubintegration.bicep
View file
Original file line number Diff line number Diff line change
@@ -1,38 +1,34 @@
param eventhub_namespace_name string
@minLength(3)
param topic_name string
param eventhub_name string
@description('The name of the Event Grid namespace.')
param eventgrid_name string
param location string = resourceGroup().location
param location string

resource eventhub 'Microsoft.EventHub/namespaces/eventhubs@2023-01-01-preview' existing = {
name: '${eventhub_namespace_name}/${eventhub_name}'
}

// resource eventgrid_namespace 'Microsoft.EventGrid/namespaces@2023-12-15-preview' existing = {
// name: eventgrid_name
// }

resource eventgrid_topic 'Microsoft.EventGrid/namespaces/topics@2023-12-15-preview' existing = {
parent: eventgrid_namespace
name: topic_name
name: '${eventgrid_name}/${topic_name}'
}

resource eventgrid_namespace 'Microsoft.EventGrid/namespaces@2023-12-15-preview' = {
// need this trick, routeTopic cannot be set during creation, so we have to "recreate" it again after
// the namespace is created to enable the topic
module eventgrid_namespace 'modules/eventgridinstance.bicep' = {
name: eventgrid_name
location: location
properties: {
topicSpacesConfiguration: {
state: 'Enabled'
routeTopicResourceId: resourceId('Microsoft.EventGrid/namespaces/topics', eventgrid_name, topic_name)
}
params: {
location: location
namespaces_name: eventgrid_name
routeTopicResourceId: eventgrid_topic.id // resourceId('Microsoft.EventGrid/namespaces/topics', eventgrid_name, topic_name)
}
}

@description('This is the built-in Azure Event Hubs Data Sender. See https://docs.microsoft.com/azure/role-based-access-control/built-in-roles#contributor')
resource eventHubsDataSenderRoleDefinition 'Microsoft.Authorization/roleDefinitions@2018-01-01-preview' existing = {
scope: eventhub
name: '2b629674-e913-4c01-ae53-ef4638d8f975'
name: '2b629674-e913-4c01-ae53-ef4638d8f975' // id for contributor role
}

// Event Grid needs permissions to send messages to the Event Hub, so we use a role assignment
Expand All @@ -41,15 +37,15 @@ resource roleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = {
name: guid('roleAssignment')
scope: eventhub
properties: {
principalId: eventgrid_namespace.identity.principalId
principalId: eventgrid_namespace.outputs.namespace_resource.identity.principalId
roleDefinitionId: eventHubsDataSenderRoleDefinition.id
}
}


resource eventHubEventSubscription 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview' = {
parent: eventgrid_topic
name: 'ehsub2'
name: 'ehsubscription'
properties: {
deliveryConfiguration: {
deliveryMode: 'Push'
Expand Down
29 changes: 29 additions & 0 deletions eventgrid/templates/modules/eventgridinstance.bicep
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
param namespaces_name string
param location string
param routeTopicResourceId string = ''


resource namespace_resource 'Microsoft.EventGrid/namespaces@2023-12-15-preview' = {
name: namespaces_name
location: location
sku: {
name: 'Standard'
capacity: 1
}
identity: {
type: 'SystemAssigned'
}
properties: {
topicsConfiguration: {}
topicSpacesConfiguration: {
state: 'Enabled'
maximumSessionExpiryInHours: 2
maximumClientSessionsPerAuthenticationName: 2 // to allow for some disconnection test scenarios
routeTopicResourceId: routeTopicResourceId // resourceId('Microsoft.EventGrid/namespaces/topics', namespaces_name, custom_topic_name)
}
isZoneRedundant: true
publicNetworkAccess: 'Enabled'
}
}

output namespace_resource object = namespace_resource
1 change: 1 addition & 0 deletions eventgrid/templates/template.bicep
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ module eventhub 'eventhubs.bicep' = {
module eventhubintegration 'eventhubintegration.bicep' = {
name: 'eventhubintegration'
params: {
location: location
eventgrid_name: name_base
eventhub_namespace_name: name_base
eventhub_name: '${name_base}sink'
Expand Down

0 comments on commit 661af27

Please sign in to comment.