Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add tags parameter to connection monitors and flow logs #4135

Merged
merged 4 commits into from
Jan 9, 2025
Merged

feat: Add tags parameter to connection monitors and flow logs #4135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
768a7d1
feat: Add tags parameter to connection monitors and flow logs in netw…
segraef Jan 9, 2025
53789ec
fix: Simplify parameter handling in network watcher modules
segraef Jan 9, 2025
9c2b3ac
fix: Update API versions for network watcher resources to 2024-05-01
segraef Jan 9, 2025
b925c4e
fix: Update API versions for connection monitors and flow logs to 202…
segraef Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions avm/res/network/network-watcher/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ This module deploys a Network Watcher.
| :-- | :-- |
| `Microsoft.Authorization/locks` | [2020-05-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Authorization/2020-05-01/locks) |
| `Microsoft.Authorization/roleAssignments` | [2022-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Authorization/2022-04-01/roleAssignments) |
| `Microsoft.Network/networkWatchers` | [2023-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2023-04-01/networkWatchers) |
| `Microsoft.Network/networkWatchers/connectionMonitors` | [2023-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2023-04-01/networkWatchers/connectionMonitors) |
| `Microsoft.Network/networkWatchers/flowLogs` | [2023-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2023-04-01/networkWatchers/flowLogs) |
| `Microsoft.Network/networkWatchers` | [2024-05-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2024-05-01/networkWatchers) |
| `Microsoft.Network/networkWatchers/connectionMonitors` | [2024-05-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2024-05-01/networkWatchers/connectionMonitors) |
| `Microsoft.Network/networkWatchers/flowLogs` | [2024-05-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2024-05-01/networkWatchers/flowLogs) |

## Usage examples

Expand Down
2 changes: 1 addition & 1 deletion avm/res/network/network-watcher/connection-monitor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This module deploys a Network Watcher Connection Monitor.

| Resource Type | API Version |
| :-- | :-- |
| `Microsoft.Network/networkWatchers/connectionMonitors` | [2023-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2023-04-01/networkWatchers/connectionMonitors) |
| `Microsoft.Network/networkWatchers/connectionMonitors` | [2024-05-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2024-05-01/networkWatchers/connectionMonitors) |

## Parameters

Expand Down
4 changes: 2 additions & 2 deletions avm/res/network/network-watcher/connection-monitor/main.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ param testGroups array = []
@description('Optional. Specify the Log Analytics Workspace Resource ID.')
param workspaceResourceId string = ''

resource networkWatcher 'Microsoft.Network/networkWatchers@2023-04-01' existing = {
resource networkWatcher 'Microsoft.Network/networkWatchers@2024-05-01' existing = {
name: networkWatcherName
}

resource connectionMonitor 'Microsoft.Network/networkWatchers/connectionMonitors@2023-04-01' = {
resource connectionMonitor 'Microsoft.Network/networkWatchers/connectionMonitors@2024-05-01' = {
name: name
parent: networkWatcher
tags: tags
Expand Down
8 changes: 4 additions & 4 deletions avm/res/network/network-watcher/connection-monitor/main.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.32.4.45862",
"templateHash": "5171031514480063459"
"templateHash": "9690855596549132604"
},
"name": "Network Watchers Connection Monitors",
"description": "This module deploys a Network Watcher Connection Monitor.",
Expand Down Expand Up @@ -73,12 +73,12 @@
"networkWatcher": {
"existing": true,
"type": "Microsoft.Network/networkWatchers",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[parameters('networkWatcherName')]"
},
"connectionMonitor": {
"type": "Microsoft.Network/networkWatchers/connectionMonitors",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[format('{0}/{1}', parameters('networkWatcherName'), parameters('name'))]",
"tags": "[parameters('tags')]",
"location": "[parameters('location')]",
Expand Down Expand Up @@ -117,7 +117,7 @@
"metadata": {
"description": "The location the resource was deployed into."
},
"value": "[reference('connectionMonitor', '2023-04-01', 'full').location]"
"value": "[reference('connectionMonitor', '2024-05-01', 'full').location]"
}
}
}
2 changes: 1 addition & 1 deletion avm/res/network/network-watcher/flow-log/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module controls the Network Security Group Flow Logs and analytics settings

| Resource Type | API Version |
| :-- | :-- |
| `Microsoft.Network/networkWatchers/flowLogs` | [2023-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2023-04-01/networkWatchers/flowLogs) |
| `Microsoft.Network/networkWatchers/flowLogs` | [2024-05-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2024-05-01/networkWatchers/flowLogs) |

## Parameters

Expand Down
4 changes: 2 additions & 2 deletions avm/res/network/network-watcher/flow-log/main.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ var flowAnalyticsConfiguration = !empty(workspaceResourceId) && enabled == true
}
}

resource networkWatcher 'Microsoft.Network/networkWatchers@2023-04-01' existing = {
resource networkWatcher 'Microsoft.Network/networkWatchers@2024-05-01' existing = {
name: networkWatcherName
}

resource flowLog 'Microsoft.Network/networkWatchers/flowLogs@2023-04-01' = {
resource flowLog 'Microsoft.Network/networkWatchers/flowLogs@2024-05-01' = {
name: name
parent: networkWatcher
tags: tags
Expand Down
8 changes: 4 additions & 4 deletions avm/res/network/network-watcher/flow-log/main.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.32.4.45862",
"templateHash": "3458210252337234612"
"templateHash": "4346206104248688042"
},
"name": "NSG Flow Logs",
"description": "This module controls the Network Security Group Flow Logs and analytics settings.\n**Note: this module must be run on the Resource Group where Network Watcher is deployed**",
Expand Down Expand Up @@ -106,12 +106,12 @@
"networkWatcher": {
"existing": true,
"type": "Microsoft.Network/networkWatchers",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[parameters('networkWatcherName')]"
},
"flowLog": {
"type": "Microsoft.Network/networkWatchers/flowLogs",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[format('{0}/{1}', parameters('networkWatcherName'), parameters('name'))]",
"tags": "[parameters('tags')]",
"location": "[parameters('location')]",
Expand Down Expand Up @@ -158,7 +158,7 @@
"metadata": {
"description": "The location the resource was deployed into."
},
"value": "[reference('flowLog', '2023-04-01', 'full').location]"
"value": "[reference('flowLog', '2024-05-01', 'full').location]"
}
}
}
30 changes: 14 additions & 16 deletions avm/res/network/network-watcher/main.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ resource avmTelemetry 'Microsoft.Resources/deployments@2024-03-01' = if (enableT
}
}

resource networkWatcher 'Microsoft.Network/networkWatchers@2023-04-01' = {
resource networkWatcher 'Microsoft.Network/networkWatchers@2024-05-01' = {
name: name
location: location
tags: tags
Expand Down Expand Up @@ -113,15 +113,14 @@ module networkWatcher_connectionMonitors 'connection-monitor/main.bicep' = [
for (connectionMonitor, index) in connectionMonitors: {
name: '${uniqueString(deployment().name, location)}-NW-ConnectionMonitor-${index}'
params: {
endpoints: contains(connectionMonitor, 'endpoints') ? connectionMonitor.endpoints : []
tags: tags
endpoints: connectionMonitor.?endpoints ?? []
name: connectionMonitor.name
location: location
networkWatcherName: networkWatcher.name
testConfigurations: contains(connectionMonitor, 'testConfigurations') ? connectionMonitor.testConfigurations : []
testGroups: contains(connectionMonitor, 'testGroups') ? connectionMonitor.testGroups : []
workspaceResourceId: contains(connectionMonitor, 'workspaceResourceId')
? connectionMonitor.workspaceResourceId
: ''
testConfigurations: connectionMonitor.?testConfigurations ?? []
testGroups: connectionMonitor.?testGroups ?? []
workspaceResourceId: connectionMonitor.?workspaceResourceId ?? ''
}
}
]
Expand All @@ -130,18 +129,17 @@ module networkWatcher_flowLogs 'flow-log/main.bicep' = [
for (flowLog, index) in flowLogs: {
name: '${uniqueString(deployment().name, location)}-NW-FlowLog-${index}'
params: {
enabled: contains(flowLog, 'enabled') ? flowLog.enabled : true
formatVersion: contains(flowLog, 'formatVersion') ? flowLog.formatVersion : 2
location: contains(flowLog, 'location') ? flowLog.location : location
name: contains(flowLog, 'name')
? flowLog.name
: '${last(split(flowLog.targetResourceId, '/'))}-${split(flowLog.targetResourceId, '/')[4]}-flowlog'
tags: tags
enabled: flowLog.?enabled ?? true
formatVersion: flowLog.?formatVersion ?? 2
location: flowLog.?location ?? location
name: flowLog.?name ?? '${last(split(flowLog.targetResourceId, '/'))}-${split(flowLog.targetResourceId, '/')[4]}-flowlog'
networkWatcherName: networkWatcher.name
retentionInDays: contains(flowLog, 'retentionInDays') ? flowLog.retentionInDays : 365
retentionInDays: flowLog.?retentionInDays ?? 365
storageId: flowLog.storageId
targetResourceId: flowLog.targetResourceId
trafficAnalyticsInterval: contains(flowLog, 'trafficAnalyticsInterval') ? flowLog.trafficAnalyticsInterval : 60
workspaceResourceId: contains(flowLog, 'workspaceResourceId') ? flowLog.workspaceResourceId : ''
trafficAnalyticsInterval: flowLog.?trafficAnalyticsInterval ?? 60
workspaceResourceId: flowLog.?workspaceResourceId ?? ''
}
}
]
Expand Down
72 changes: 50 additions & 22 deletions avm/res/network/network-watcher/main.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.32.4.45862",
"templateHash": "6074776926159807675"
"templateHash": "10145081983832317728"
},
"name": "Network Watchers",
"description": "This module deploys a Network Watcher.",
Expand Down Expand Up @@ -209,7 +209,7 @@
},
"networkWatcher": {
"type": "Microsoft.Network/networkWatchers",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[parameters('name')]",
"location": "[parameters('location')]",
"tags": "[parameters('tags')]",
Expand Down Expand Up @@ -265,7 +265,12 @@
},
"mode": "Incremental",
"parameters": {
"endpoints": "[if(contains(parameters('connectionMonitors')[copyIndex()], 'endpoints'), createObject('value', parameters('connectionMonitors')[copyIndex()].endpoints), createObject('value', createArray()))]",
"tags": {
"value": "[parameters('tags')]"
},
"endpoints": {
"value": "[coalesce(tryGet(parameters('connectionMonitors')[copyIndex()], 'endpoints'), createArray())]"
},
"name": {
"value": "[parameters('connectionMonitors')[copyIndex()].name]"
},
Expand All @@ -275,9 +280,15 @@
"networkWatcherName": {
"value": "[parameters('name')]"
},
"testConfigurations": "[if(contains(parameters('connectionMonitors')[copyIndex()], 'testConfigurations'), createObject('value', parameters('connectionMonitors')[copyIndex()].testConfigurations), createObject('value', createArray()))]",
"testGroups": "[if(contains(parameters('connectionMonitors')[copyIndex()], 'testGroups'), createObject('value', parameters('connectionMonitors')[copyIndex()].testGroups), createObject('value', createArray()))]",
"workspaceResourceId": "[if(contains(parameters('connectionMonitors')[copyIndex()], 'workspaceResourceId'), createObject('value', parameters('connectionMonitors')[copyIndex()].workspaceResourceId), createObject('value', ''))]"
"testConfigurations": {
"value": "[coalesce(tryGet(parameters('connectionMonitors')[copyIndex()], 'testConfigurations'), createArray())]"
},
"testGroups": {
"value": "[coalesce(tryGet(parameters('connectionMonitors')[copyIndex()], 'testGroups'), createArray())]"
},
"workspaceResourceId": {
"value": "[coalesce(tryGet(parameters('connectionMonitors')[copyIndex()], 'workspaceResourceId'), '')]"
}
},
"template": {
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
Expand All @@ -287,7 +298,7 @@
"_generator": {
"name": "bicep",
"version": "0.32.4.45862",
"templateHash": "5171031514480063459"
"templateHash": "9690855596549132604"
},
"name": "Network Watchers Connection Monitors",
"description": "This module deploys a Network Watcher Connection Monitor.",
Expand Down Expand Up @@ -354,12 +365,12 @@
"networkWatcher": {
"existing": true,
"type": "Microsoft.Network/networkWatchers",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[parameters('networkWatcherName')]"
},
"connectionMonitor": {
"type": "Microsoft.Network/networkWatchers/connectionMonitors",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[format('{0}/{1}', parameters('networkWatcherName'), parameters('name'))]",
"tags": "[parameters('tags')]",
"location": "[parameters('location')]",
Expand Down Expand Up @@ -398,7 +409,7 @@
"metadata": {
"description": "The location the resource was deployed into."
},
"value": "[reference('connectionMonitor', '2023-04-01', 'full').location]"
"value": "[reference('connectionMonitor', '2024-05-01', 'full').location]"
}
}
}
Expand All @@ -421,22 +432,39 @@
},
"mode": "Incremental",
"parameters": {
"enabled": "[if(contains(parameters('flowLogs')[copyIndex()], 'enabled'), createObject('value', parameters('flowLogs')[copyIndex()].enabled), createObject('value', true()))]",
"formatVersion": "[if(contains(parameters('flowLogs')[copyIndex()], 'formatVersion'), createObject('value', parameters('flowLogs')[copyIndex()].formatVersion), createObject('value', 2))]",
"location": "[if(contains(parameters('flowLogs')[copyIndex()], 'location'), createObject('value', parameters('flowLogs')[copyIndex()].location), createObject('value', parameters('location')))]",
"name": "[if(contains(parameters('flowLogs')[copyIndex()], 'name'), createObject('value', parameters('flowLogs')[copyIndex()].name), createObject('value', format('{0}-{1}-flowlog', last(split(parameters('flowLogs')[copyIndex()].targetResourceId, '/')), split(parameters('flowLogs')[copyIndex()].targetResourceId, '/')[4])))]",
"tags": {
"value": "[parameters('tags')]"
},
"enabled": {
"value": "[coalesce(tryGet(parameters('flowLogs')[copyIndex()], 'enabled'), true())]"
},
"formatVersion": {
"value": "[coalesce(tryGet(parameters('flowLogs')[copyIndex()], 'formatVersion'), 2)]"
},
"location": {
"value": "[coalesce(tryGet(parameters('flowLogs')[copyIndex()], 'location'), parameters('location'))]"
},
"name": {
"value": "[coalesce(tryGet(parameters('flowLogs')[copyIndex()], 'name'), format('{0}-{1}-flowlog', last(split(parameters('flowLogs')[copyIndex()].targetResourceId, '/')), split(parameters('flowLogs')[copyIndex()].targetResourceId, '/')[4]))]"
},
"networkWatcherName": {
"value": "[parameters('name')]"
},
"retentionInDays": "[if(contains(parameters('flowLogs')[copyIndex()], 'retentionInDays'), createObject('value', parameters('flowLogs')[copyIndex()].retentionInDays), createObject('value', 365))]",
"retentionInDays": {
"value": "[coalesce(tryGet(parameters('flowLogs')[copyIndex()], 'retentionInDays'), 365)]"
},
"storageId": {
"value": "[parameters('flowLogs')[copyIndex()].storageId]"
},
"targetResourceId": {
"value": "[parameters('flowLogs')[copyIndex()].targetResourceId]"
},
"trafficAnalyticsInterval": "[if(contains(parameters('flowLogs')[copyIndex()], 'trafficAnalyticsInterval'), createObject('value', parameters('flowLogs')[copyIndex()].trafficAnalyticsInterval), createObject('value', 60))]",
"workspaceResourceId": "[if(contains(parameters('flowLogs')[copyIndex()], 'workspaceResourceId'), createObject('value', parameters('flowLogs')[copyIndex()].workspaceResourceId), createObject('value', ''))]"
"trafficAnalyticsInterval": {
"value": "[coalesce(tryGet(parameters('flowLogs')[copyIndex()], 'trafficAnalyticsInterval'), 60)]"
},
"workspaceResourceId": {
"value": "[coalesce(tryGet(parameters('flowLogs')[copyIndex()], 'workspaceResourceId'), '')]"
}
},
"template": {
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
Expand All @@ -446,7 +474,7 @@
"_generator": {
"name": "bicep",
"version": "0.32.4.45862",
"templateHash": "3458210252337234612"
"templateHash": "4346206104248688042"
},
"name": "NSG Flow Logs",
"description": "This module controls the Network Security Group Flow Logs and analytics settings.\n**Note: this module must be run on the Resource Group where Network Watcher is deployed**",
Expand Down Expand Up @@ -546,12 +574,12 @@
"networkWatcher": {
"existing": true,
"type": "Microsoft.Network/networkWatchers",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[parameters('networkWatcherName')]"
},
"flowLog": {
"type": "Microsoft.Network/networkWatchers/flowLogs",
"apiVersion": "2023-04-01",
"apiVersion": "2024-05-01",
"name": "[format('{0}/{1}', parameters('networkWatcherName'), parameters('name'))]",
"tags": "[parameters('tags')]",
"location": "[parameters('location')]",
Expand Down Expand Up @@ -598,7 +626,7 @@
"metadata": {
"description": "The location the resource was deployed into."
},
"value": "[reference('flowLog', '2023-04-01', 'full').location]"
"value": "[reference('flowLog', '2024-05-01', 'full').location]"
}
}
}
Expand Down Expand Up @@ -635,7 +663,7 @@
"metadata": {
"description": "The location the resource was deployed into."
},
"value": "[reference('networkWatcher', '2023-04-01', 'full').location]"
"value": "[reference('networkWatcher', '2024-05-01', 'full').location]"
}
}
}
4 changes: 2 additions & 2 deletions avm/res/network/network-watcher/version.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://aka.ms/bicep-registry-module-version-file-schema#",
"version": "0.3",
"version": "0.4",
"pathFilters": [
"./main.json"
]
}
}
Loading