Skip to content

Commit e1b02f7

Browse files
Updated TS example (#1013)
1 parent 0819b0c commit e1b02f7

1 file changed

Lines changed: 66 additions & 49 deletions

File tree

docs/wiki/ModulesUsage.md

Lines changed: 66 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ param subnets array = [
155155
// =========== //
156156
157157
// Resource Group
158-
module rg 'br/modules:microsoft.resources.resourcegroups:0.0.12' = {
158+
module rg 'br/modules:microsoft.resources.resourcegroups:0.4.735' = {
159159
name: 'registry-rg'
160160
params: {
161161
name: resourceGroupName
@@ -164,7 +164,7 @@ module rg 'br/modules:microsoft.resources.resourcegroups:0.0.12' = {
164164
}
165165
166166
// Network Security Group
167-
module nsg 'br/modules:microsoft.network.networksecuritygroups:0.0.30' = {
167+
module nsg 'br/modules:microsoft.network.networksecuritygroups:0.4.735' = {
168168
name: 'registry-nsg'
169169
scope: resourceGroup(resourceGroupName)
170170
params: {
@@ -176,7 +176,7 @@ module nsg 'br/modules:microsoft.network.networksecuritygroups:0.0.30' = {
176176
}
177177
178178
// Virtual Network
179-
module vnet 'br/modules:/microsoft.network.virtualnetworks:0.0.26' = {
179+
module vnet 'br/modules:microsoft.network.virtualnetworks:0.4.735' = {
180180
name: 'registry-vnet'
181181
scope: resourceGroup(resourceGroupName)
182182
params: {
@@ -191,15 +191,40 @@ module vnet 'br/modules:/microsoft.network.virtualnetworks:0.0.26' = {
191191
}
192192
```
193193

194+
The example assumes you are using a [`bicepconfig.json`](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-config) configuration file like:
195+
196+
```json
197+
{
198+
"moduleAliases": {
199+
"br": {
200+
"modules": {
201+
"registry": "<registryName>.azurecr.io",
202+
"modulePath": "bicep/modules"
203+
}
204+
}
205+
}
206+
}
207+
```
208+
209+
194210
### ***Example with template-specs***
195211

196212
The following example shows how you could orchestrate a deployment of multiple resources using template specs. In this example we will deploy a NSG and use the same in a subsequent VNET deployment.
197213

198214
```bicep
215+
targetScope = 'subscription'
216+
199217
// ================ //
200218
// Input Parameters //
201219
// ================ //
202220
221+
// RG parameters
222+
@description('Optional. The name of the resource group to deploy')
223+
param resourceGroupName string = 'validation-rg'
224+
225+
@description('Optional. The location to deploy into')
226+
param location string = deployment().location
227+
203228
// Network Security Group parameters
204229
@description('Optional. The name of the vnet to deploy')
205230
param networkSecurityGroupName string = 'TemplateSpecDemoNsg'
@@ -227,66 +252,58 @@ param subnets array = [
227252
}
228253
]
229254
230-
// ========================= //
231-
// Template Specs References //
232-
// ========================= //
233-
var templateSpecSub = '<<subscriptionId>>'
234-
var templateSpecRg = 'artifacts-rg'
235-
236-
// Network Security Group
237-
resource nsgTemplate 'Microsoft.Resources/templateSpecs/versions@2021-05-01' existing = {
238-
scope: resourceGroup(templateSpecSub, templateSpecRg)
239-
name: 'networkSecurityGroups/1.0.21'
240-
}
241-
242-
// Virtual Network
243-
resource vnetTemplate 'Microsoft.Resources/templateSpecs/versions@2021-05-01' existing = {
244-
scope: resourceGroup(templateSpecSub, templateSpecRg)
245-
name: 'VirtualNetwork/1.0.12'
246-
}
247-
248255
// =========== //
249256
// Deployments //
250257
// =========== //
251258
259+
// Resource Group
260+
module rg 'ts/modules:microsoft.resources.resourcegroups:0.4.735' = {
261+
name: 'rgDeployment'
262+
params: {
263+
name: resourceGroupName
264+
location: location
265+
}
266+
}
267+
252268
// Network Security Group
253-
resource nsg 'Microsoft.Resources/deployments@2021-01-01' = {
269+
module nsg 'ts/modules:microsoft.network.networksecuritygroups:0.4.735' = {
254270
name: 'nsgDeployment'
255-
properties: {
256-
mode: 'Incremental'
257-
templateLink: {
258-
id: nsgTemplate.id
259-
}
260-
parameters: {
261-
name: {
262-
value: networkSecurityGroupName
263-
}
264-
}
271+
scope: resourceGroup(resourceGroupName)
272+
params: {
273+
name: networkSecurityGroupName
265274
}
275+
dependsOn: [
276+
rg
277+
]
266278
}
267279
268280
// Virtual Network
269-
resource vnet 'Microsoft.Resources/deployments@2021-01-01' = {
281+
module vnet 'ts/modules:microsoft.network.virtualnetworks:0.4.735' = {
270282
name: 'vnetDeployment'
271-
properties: {
272-
mode: 'Incremental'
273-
templateLink: {
274-
id: vnetTemplate.id
275-
}
276-
parameters: {
277-
name: {
278-
value: vnetName
279-
}
280-
addressPrefixes: {
281-
value: vNetAddressPrefixes
282-
}
283-
subnets: {
284-
value: subnets
285-
}
286-
}
283+
scope: resourceGroup(resourceGroupName)
284+
params: {
285+
name: vnetName
286+
addressPrefixes: vNetAddressPrefixes
287+
subnets : subnets
287288
}
288289
dependsOn: [
290+
rg
289291
nsg
290292
]
291293
}
292294
```
295+
296+
The example assumes you are using a [`bicepconfig.json`](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-config) configuration file like:
297+
298+
```json
299+
{
300+
"moduleAliases": {
301+
"ts": {
302+
"modules": {
303+
"subscription": "<<subscriptionId>>",
304+
"resourceGroup": "artifacts-rg"
305+
}
306+
}
307+
}
308+
}
309+
```

0 commit comments

Comments
 (0)