diff --git a/modules/aad/domain-service/README.md b/modules/aad/domain-service/README.md index b93dc2af43..1330a6f5ec 100644 --- a/modules/aad/domain-service/README.md +++ b/modules/aad/domain-service/README.md @@ -41,7 +41,7 @@ This instance deploys the module with most of its features enabled. ```bicep module domainService 'br:bicep/modules/aad.domain-service:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-aaddscom' + name: '${uniqueString(deployment().name, location)}-test-aaddsmax' params: { // Required parameters domainName: 'onmicrosoft.com' @@ -63,7 +63,7 @@ module domainService 'br:bicep/modules/aad.domain-service:1.0.0' = { kind: 'CanNotDelete' name: 'myCustomLockName' } - name: 'aaddscom001' + name: 'aaddsmax001' pfxCertificate: '' pfxCertificatePassword: '' replicaSets: [ @@ -125,7 +125,7 @@ module domainService 'br:bicep/modules/aad.domain-service:1.0.0' = { } }, "name": { - "value": "aaddscom001" + "value": "aaddsmax001" }, "pfxCertificate": { "value": "" diff --git a/modules/analysis-services/server/README.md b/modules/analysis-services/server/README.md index 803b3e6e39..73d7a21652 100644 --- a/modules/analysis-services/server/README.md +++ b/modules/analysis-services/server/README.md @@ -27,10 +27,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/analysis-services.server:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module server 'br:bicep/modules/analysis-services.server:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-assmin' + params: { + // Required parameters + name: 'assmin' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "assmin" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -41,10 +89,10 @@ This instance deploys the module with most of its features enabled. ```bicep module server 'br:bicep/modules/analysis-services.server:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-asscom' + name: '${uniqueString(deployment().name, location)}-test-assmax' params: { // Required parameters - name: 'asscom' + name: 'assmax' // Non-required parameters diagnosticSettings: [ { @@ -115,7 +163,7 @@ module server 'br:bicep/modules/analysis-services.server:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "asscom" + "value": "assmax" }, // Non-required parameters "diagnosticSettings": { @@ -192,54 +240,6 @@ module server 'br:bicep/modules/analysis-services.server:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module server 'br:bicep/modules/analysis-services.server:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-assmin' - params: { - // Required parameters - name: 'assmin' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "assmin" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/api-management/service/README.md b/modules/api-management/service/README.md index 7a7e701100..49ae4a583a 100644 --- a/modules/api-management/service/README.md +++ b/modules/api-management/service/README.md @@ -42,10 +42,66 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/api-management.service:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module service 'br:bicep/modules/api-management.service:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-apismin' + params: { + // Required parameters + name: 'apismin001' + publisherEmail: 'apimgmt-noreply@mail.windowsazure.com' + publisherName: 'az-amorg-x-001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "apismin001" + }, + "publisherEmail": { + "value": "apimgmt-noreply@mail.windowsazure.com" + }, + "publisherName": { + "value": "az-amorg-x-001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -56,10 +112,10 @@ This instance deploys the module with most of its features enabled. ```bicep module service 'br:bicep/modules/api-management.service:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-apiscom' + name: '${uniqueString(deployment().name, location)}-test-apismax' params: { // Required parameters - name: 'apiscom001' + name: 'apismax001' publisherEmail: 'apimgmt-noreply@mail.windowsazure.com' publisherName: 'az-amorg-x-001' // Non-required parameters @@ -224,7 +280,7 @@ module service 'br:bicep/modules/api-management.service:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "apiscom001" + "value": "apismax001" }, "publisherEmail": { "value": "apimgmt-noreply@mail.windowsazure.com" @@ -415,62 +471,6 @@ module service 'br:bicep/modules/api-management.service:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module service 'br:bicep/modules/api-management.service:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-apismin' - params: { - // Required parameters - name: 'apismin001' - publisherEmail: 'apimgmt-noreply@mail.windowsazure.com' - publisherName: 'az-amorg-x-001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "apismin001" - }, - "publisherEmail": { - "value": "apimgmt-noreply@mail.windowsazure.com" - }, - "publisherName": { - "value": "az-amorg-x-001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/app-configuration/configuration-store/README.md b/modules/app-configuration/configuration-store/README.md index 46f091b2d9..e057fc4288 100644 --- a/modules/app-configuration/configuration-store/README.md +++ b/modules/app-configuration/configuration-store/README.md @@ -30,14 +30,14 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/app-configuration.configuration-store:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) - [Pe](#example-4-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -46,26 +46,62 @@ This instance deploys the module with most of its features enabled. ```bicep module configurationStore 'br:bicep/modules/app-configuration.configuration-store:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-acccom' + name: '${uniqueString(deployment().name, location)}-test-accmin' params: { // Required parameters - name: 'acccom001' + name: 'accmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "accmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module configurationStore 'br:bicep/modules/app-configuration.configuration-store:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-accencr' + params: { + // Required parameters + name: 'accencr001' // Non-required parameters createMode: 'Default' - diagnosticSettings: [ - { - eventHubAuthorizationRuleResourceId: '' - eventHubName: '' - metricCategories: [ - { - category: 'AllMetrics' - } - ] - name: 'customSetting' - storageAccountResourceId: '' - workspaceResourceId: '' - } - ] + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + userAssignedIdentityResourceId: '' + } disableLocalAuth: false enableDefaultTelemetry: '' enablePurgeProtection: false @@ -83,12 +119,7 @@ module configurationStore 'br:bicep/modules/app-configuration.configuration-stor value: 'valueName' } ] - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } managedIdentities: { - systemAssigned: true userAssignedResourcesIds: [ '' ] @@ -124,27 +155,18 @@ module configurationStore 'br:bicep/modules/app-configuration.configuration-stor "parameters": { // Required parameters "name": { - "value": "acccom001" + "value": "accencr001" }, // Non-required parameters "createMode": { "value": "Default" }, - "diagnosticSettings": { - "value": [ - { - "eventHubAuthorizationRuleResourceId": "", - "eventHubName": "", - "metricCategories": [ - { - "category": "AllMetrics" - } - ], - "name": "customSetting", - "storageAccountResourceId": "", - "workspaceResourceId": "" - } - ] + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" + } }, "disableLocalAuth": { "value": false @@ -171,15 +193,8 @@ module configurationStore 'br:bicep/modules/app-configuration.configuration-stor } ] }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, "managedIdentities": { "value": { - "systemAssigned": true, "userAssignedResourcesIds": [ "" ] @@ -211,55 +226,10 @@ module configurationStore 'br:bicep/modules/app-configuration.configuration-stor

-### Example 2: _Using only defaults_ +### Example 3: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module configurationStore 'br:bicep/modules/app-configuration.configuration-store:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-accmin' - params: { - // Required parameters - name: 'accmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "accmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

+This instance deploys the module with most of its features enabled. -### Example 3: _Encr_

@@ -267,17 +237,26 @@ module configurationStore 'br:bicep/modules/app-configuration.configuration-stor ```bicep module configurationStore 'br:bicep/modules/app-configuration.configuration-store:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-accencr' + name: '${uniqueString(deployment().name, location)}-test-accmax' params: { // Required parameters - name: 'accencr001' + name: 'accmax001' // Non-required parameters createMode: 'Default' - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } + diagnosticSettings: [ + { + eventHubAuthorizationRuleResourceId: '' + eventHubName: '' + metricCategories: [ + { + category: 'AllMetrics' + } + ] + name: 'customSetting' + storageAccountResourceId: '' + workspaceResourceId: '' + } + ] disableLocalAuth: false enableDefaultTelemetry: '' enablePurgeProtection: false @@ -295,7 +274,12 @@ module configurationStore 'br:bicep/modules/app-configuration.configuration-stor value: 'valueName' } ] + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } managedIdentities: { + systemAssigned: true userAssignedResourcesIds: [ '' ] @@ -331,18 +315,27 @@ module configurationStore 'br:bicep/modules/app-configuration.configuration-stor "parameters": { // Required parameters "name": { - "value": "accencr001" + "value": "accmax001" }, // Non-required parameters "createMode": { "value": "Default" }, - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } + "diagnosticSettings": { + "value": [ + { + "eventHubAuthorizationRuleResourceId": "", + "eventHubName": "", + "metricCategories": [ + { + "category": "AllMetrics" + } + ], + "name": "customSetting", + "storageAccountResourceId": "", + "workspaceResourceId": "" + } + ] }, "disableLocalAuth": { "value": false @@ -369,8 +362,15 @@ module configurationStore 'br:bicep/modules/app-configuration.configuration-stor } ] }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, "managedIdentities": { "value": { + "systemAssigned": true, "userAssignedResourcesIds": [ "" ] diff --git a/modules/app/container-app/README.md b/modules/app/container-app/README.md index e821376408..56ef31b6d4 100644 --- a/modules/app/container-app/README.md +++ b/modules/app/container-app/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/app.container-app:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -40,30 +40,13 @@ This instance deploys the module with most of its features enabled. ```bicep module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-mcappcom' + name: '${uniqueString(deployment().name, location)}-test-mcappmin' params: { // Required parameters containers: [ { image: 'mcr.microsoft.com/azuredocs/containerapps-helloworld:latest' name: 'simple-hello-world-container' - probes: [ - { - httpGet: { - httpHeaders: [ - { - name: 'Custom-Header' - value: 'Awesome' - } - ] - path: '/health' - port: 8080 - } - initialDelaySeconds: 3 - periodSeconds: 3 - type: 'Liveness' - } - ] resources: { cpu: '' memory: '0.5Gi' @@ -71,27 +54,10 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { } ] environmentId: '' - name: 'mcappcom001' + name: 'mcappmin001' // Non-required parameters enableDefaultTelemetry: '' location: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - managedIdentities: { - userAssignedResourcesIds: [ - '' - ] - } - secrets: { - secureList: [ - { - name: 'customtest' - value: '' - } - ] - } tags: { Env: 'test' 'hidden-title': 'This is visible in the resource name' @@ -118,23 +84,6 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { { "image": "mcr.microsoft.com/azuredocs/containerapps-helloworld:latest", "name": "simple-hello-world-container", - "probes": [ - { - "httpGet": { - "httpHeaders": [ - { - "name": "Custom-Header", - "value": "Awesome" - } - ], - "path": "/health", - "port": 8080 - }, - "initialDelaySeconds": 3, - "periodSeconds": 3, - "type": "Liveness" - } - ], "resources": { "cpu": "", "memory": "0.5Gi" @@ -146,7 +95,7 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { "value": "" }, "name": { - "value": "mcappcom001" + "value": "mcappmin001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -155,29 +104,6 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { "location": { "value": "" }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "managedIdentities": { - "value": { - "userAssignedResourcesIds": [ - "" - ] - } - }, - "secrets": { - "value": { - "secureList": [ - { - "name": "customtest", - "value": "" - } - ] - } - }, "tags": { "value": { "Env": "test", @@ -191,9 +117,9 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -202,13 +128,30 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-mcappmin' + name: '${uniqueString(deployment().name, location)}-test-mcappmax' params: { // Required parameters containers: [ { image: 'mcr.microsoft.com/azuredocs/containerapps-helloworld:latest' name: 'simple-hello-world-container' + probes: [ + { + httpGet: { + httpHeaders: [ + { + name: 'Custom-Header' + value: 'Awesome' + } + ] + path: '/health' + port: 8080 + } + initialDelaySeconds: 3 + periodSeconds: 3 + type: 'Liveness' + } + ] resources: { cpu: '' memory: '0.5Gi' @@ -216,10 +159,27 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { } ] environmentId: '' - name: 'mcappmin001' + name: 'mcappmax001' // Non-required parameters enableDefaultTelemetry: '' location: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + managedIdentities: { + userAssignedResourcesIds: [ + '' + ] + } + secrets: { + secureList: [ + { + name: 'customtest' + value: '' + } + ] + } tags: { Env: 'test' 'hidden-title': 'This is visible in the resource name' @@ -246,6 +206,23 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { { "image": "mcr.microsoft.com/azuredocs/containerapps-helloworld:latest", "name": "simple-hello-world-container", + "probes": [ + { + "httpGet": { + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ], + "path": "/health", + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3, + "type": "Liveness" + } + ], "resources": { "cpu": "", "memory": "0.5Gi" @@ -257,7 +234,7 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { "value": "" }, "name": { - "value": "mcappmin001" + "value": "mcappmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -266,6 +243,29 @@ module containerApp 'br:bicep/modules/app.container-app:1.0.0' = { "location": { "value": "" }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "managedIdentities": { + "value": { + "userAssignedResourcesIds": [ + "" + ] + } + }, + "secrets": { + "value": { + "secureList": [ + { + "name": "customtest", + "value": "" + } + ] + } + }, "tags": { "value": { "Env": "test", diff --git a/modules/app/job/README.md b/modules/app/job/README.md index 5575de3afb..c5d025fad6 100644 --- a/modules/app/job/README.md +++ b/modules/app/job/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/app.job:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -40,30 +40,13 @@ This instance deploys the module with most of its features enabled. ```bicep module job 'br:bicep/modules/app.job:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ajcom' + name: '${uniqueString(deployment().name, location)}-test-ajmin' params: { // Required parameters containers: [ { image: 'mcr.microsoft.com/azuredocs/containerapps-helloworld:latest' name: 'simple-hello-world-container' - probes: [ - { - httpGet: { - httpHeaders: [ - { - name: 'Custom-Header' - value: 'Awesome' - } - ] - path: '/health' - port: 8080 - } - initialDelaySeconds: 3 - periodSeconds: 3 - type: 'Liveness' - } - ] resources: { cpu: '' memory: '0.5Gi' @@ -71,45 +54,19 @@ module job 'br:bicep/modules/app.job:1.0.0' = { } ] environmentId: '' - name: 'ajcom001' + name: 'ajmin001' triggerType: 'Manual' // Non-required parameters enableDefaultTelemetry: '' location: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - managedIdentities: { - systemAssigned: true - userAssignedResourcesIds: [ - '' - ] - } manualTriggerConfig: { parallelism: 1 replicaCompletionCount: 1 } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'ContainerApp Reader' - } - ] - secrets: { - secureList: [ - { - name: 'customtest' - value: '' - } - ] - } tags: { Env: 'test' 'hidden-title': 'This is visible in the resource name' } - workloadProfileName: '' } } ``` @@ -132,23 +89,6 @@ module job 'br:bicep/modules/app.job:1.0.0' = { { "image": "mcr.microsoft.com/azuredocs/containerapps-helloworld:latest", "name": "simple-hello-world-container", - "probes": [ - { - "httpGet": { - "httpHeaders": [ - { - "name": "Custom-Header", - "value": "Awesome" - } - ], - "path": "/health", - "port": 8080 - }, - "initialDelaySeconds": 3, - "periodSeconds": 3, - "type": "Liveness" - } - ], "resources": { "cpu": "", "memory": "0.5Gi" @@ -160,7 +100,7 @@ module job 'br:bicep/modules/app.job:1.0.0' = { "value": "" }, "name": { - "value": "ajcom001" + "value": "ajmin001" }, "triggerType": { "value": "Manual" @@ -172,53 +112,17 @@ module job 'br:bicep/modules/app.job:1.0.0' = { "location": { "value": "" }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "managedIdentities": { - "value": { - "systemAssigned": true, - "userAssignedResourcesIds": [ - "" - ] - } - }, "manualTriggerConfig": { "value": { "parallelism": 1, "replicaCompletionCount": 1 } }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "ContainerApp Reader" - } - ] - }, - "secrets": { - "value": { - "secureList": [ - { - "name": "customtest", - "value": "" - } - ] - } - }, "tags": { "value": { "Env": "test", "hidden-title": "This is visible in the resource name" } - }, - "workloadProfileName": { - "value": "" } } } @@ -227,9 +131,9 @@ module job 'br:bicep/modules/app.job:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -238,13 +142,30 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module job 'br:bicep/modules/app.job:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ajmin' + name: '${uniqueString(deployment().name, location)}-test-ajmax' params: { // Required parameters containers: [ { image: 'mcr.microsoft.com/azuredocs/containerapps-helloworld:latest' name: 'simple-hello-world-container' + probes: [ + { + httpGet: { + httpHeaders: [ + { + name: 'Custom-Header' + value: 'Awesome' + } + ] + path: '/health' + port: 8080 + } + initialDelaySeconds: 3 + periodSeconds: 3 + type: 'Liveness' + } + ] resources: { cpu: '' memory: '0.5Gi' @@ -252,19 +173,45 @@ module job 'br:bicep/modules/app.job:1.0.0' = { } ] environmentId: '' - name: 'ajmin001' + name: 'ajmax001' triggerType: 'Manual' // Non-required parameters enableDefaultTelemetry: '' location: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + managedIdentities: { + systemAssigned: true + userAssignedResourcesIds: [ + '' + ] + } manualTriggerConfig: { parallelism: 1 replicaCompletionCount: 1 } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'ContainerApp Reader' + } + ] + secrets: { + secureList: [ + { + name: 'customtest' + value: '' + } + ] + } tags: { Env: 'test' 'hidden-title': 'This is visible in the resource name' } + workloadProfileName: '' } } ``` @@ -287,6 +234,23 @@ module job 'br:bicep/modules/app.job:1.0.0' = { { "image": "mcr.microsoft.com/azuredocs/containerapps-helloworld:latest", "name": "simple-hello-world-container", + "probes": [ + { + "httpGet": { + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ], + "path": "/health", + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3, + "type": "Liveness" + } + ], "resources": { "cpu": "", "memory": "0.5Gi" @@ -298,7 +262,7 @@ module job 'br:bicep/modules/app.job:1.0.0' = { "value": "" }, "name": { - "value": "ajmin001" + "value": "ajmax001" }, "triggerType": { "value": "Manual" @@ -310,17 +274,53 @@ module job 'br:bicep/modules/app.job:1.0.0' = { "location": { "value": "" }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "managedIdentities": { + "value": { + "systemAssigned": true, + "userAssignedResourcesIds": [ + "" + ] + } + }, "manualTriggerConfig": { "value": { "parallelism": 1, "replicaCompletionCount": 1 } }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "ContainerApp Reader" + } + ] + }, + "secrets": { + "value": { + "secureList": [ + { + "name": "customtest", + "value": "" + } + ] + } + }, "tags": { "value": { "Env": "test", "hidden-title": "This is visible in the resource name" } + }, + "workloadProfileName": { + "value": "" } } } diff --git a/modules/app/managed-environment/README.md b/modules/app/managed-environment/README.md index e1b11db691..40ec6dfd7e 100644 --- a/modules/app/managed-environment/README.md +++ b/modules/app/managed-environment/README.md @@ -26,10 +26,60 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/app.managed-environment:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module managedEnvironment 'br:bicep/modules/app.managed-environment:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-amemin' + params: { + // Required parameters + enableDefaultTelemetry: '' + logAnalyticsWorkspaceResourceId: '' + name: 'amemin001' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "logAnalyticsWorkspaceResourceId": { + "value": "" + }, + "name": { + "value": "amemin001" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,12 +90,12 @@ This instance deploys the module with most of its features enabled. ```bicep module managedEnvironment 'br:bicep/modules/app.managed-environment:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-amecom' + name: '${uniqueString(deployment().name, location)}-test-amemax' params: { // Required parameters enableDefaultTelemetry: '' logAnalyticsWorkspaceResourceId: '' - name: 'amecom001' + name: 'amemax001' // Non-required parameters dockerBridgeCidr: '172.16.0.1/28' infrastructureSubnetId: '' @@ -86,7 +136,7 @@ module managedEnvironment 'br:bicep/modules/app.managed-environment:1.0.0' = { "value": "" }, "name": { - "value": "amecom001" + "value": "amemax001" }, // Non-required parameters "dockerBridgeCidr": { @@ -129,56 +179,6 @@ module managedEnvironment 'br:bicep/modules/app.managed-environment:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module managedEnvironment 'br:bicep/modules/app.managed-environment:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-amemin' - params: { - // Required parameters - enableDefaultTelemetry: '' - logAnalyticsWorkspaceResourceId: '' - name: 'amemin001' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "logAnalyticsWorkspaceResourceId": { - "value": "" - }, - "name": { - "value": "amemin001" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/authorization/lock/README.md b/modules/authorization/lock/README.md index 2eb75ecad3..5d3f67c3e0 100644 --- a/modules/authorization/lock/README.md +++ b/modules/authorization/lock/README.md @@ -37,7 +37,7 @@ This instance deploys the module with most of its features enabled. ```bicep module lock 'br:bicep/modules/authorization.lock:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-alcom' + name: '${uniqueString(deployment().name, location)}-test-almax' params: { // Required parameters level: 'CanNotDelete' diff --git a/modules/automation/automation-account/README.md b/modules/automation/automation-account/README.md index b5b6e86e68..49340e030c 100644 --- a/modules/automation/automation-account/README.md +++ b/modules/automation/automation-account/README.md @@ -37,11 +37,128 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/automation.automation-account:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module automationAccount 'br:bicep/modules/automation.automation-account:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-aamin' + params: { + // Required parameters + name: 'aamin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "aamin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module automationAccount 'br:bicep/modules/automation.automation-account:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-aaencr' + params: { + // Required parameters + name: 'aaencr001' + // Non-required parameters + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + userAssignedIdentityResourceId: '' + } + enableDefaultTelemetry: '' + managedIdentities: { + userAssignedResourcesIds: [ + '' + ] + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "aaencr001" + }, + // Non-required parameters + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" + } + }, + "enableDefaultTelemetry": { + "value": "" + }, + "managedIdentities": { + "value": { + "userAssignedResourcesIds": [ + "" + ] + } + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -52,10 +169,10 @@ This instance deploys the module with most of its features enabled. ```bicep module automationAccount 'br:bicep/modules/automation.automation-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-aacom' + name: '${uniqueString(deployment().name, location)}-test-aamax' params: { // Required parameters - name: 'aacom001' + name: 'aamax001' // Non-required parameters diagnosticSettings: [ { @@ -265,7 +382,7 @@ module automationAccount 'br:bicep/modules/automation.automation-account:1.0.0' "parameters": { // Required parameters "name": { - "value": "aacom001" + "value": "aamax001" }, // Non-required parameters "diagnosticSettings": { @@ -497,123 +614,6 @@ module automationAccount 'br:bicep/modules/automation.automation-account:1.0.0'

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module automationAccount 'br:bicep/modules/automation.automation-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-aamin' - params: { - // Required parameters - name: 'aamin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "aamin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Encr_ - -

- -via Bicep module - -```bicep -module automationAccount 'br:bicep/modules/automation.automation-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-aaencr' - params: { - // Required parameters - name: 'aaencr001' - // Non-required parameters - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } - enableDefaultTelemetry: '' - managedIdentities: { - userAssignedResourcesIds: [ - '' - ] - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "aaencr001" - }, - // Non-required parameters - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } - }, - "enableDefaultTelemetry": { - "value": "" - }, - "managedIdentities": { - "value": { - "userAssignedResourcesIds": [ - "" - ] - } - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/batch/batch-account/README.md b/modules/batch/batch-account/README.md index 45497741ab..3a1c9b5e7f 100644 --- a/modules/batch/batch-account/README.md +++ b/modules/batch/batch-account/README.md @@ -31,13 +31,13 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/batch.batch-account:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -46,33 +46,68 @@ This instance deploys the module with most of its features enabled. ```bicep module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-bbacom' + name: '${uniqueString(deployment().name, location)}-test-bbamin' params: { // Required parameters - name: 'bbacom001' + name: 'bbamin001' storageAccountId: '' // Non-required parameters - diagnosticSettings: [ - { - eventHubAuthorizationRuleResourceId: '' - eventHubName: '' - metricCategories: [ - { - category: 'AllMetrics' - } - ] - name: 'customSetting' - storageAccountResourceId: '' - workspaceResourceId: '' - } - ] enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "bbamin001" + }, + "storageAccountId": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-bbaencr' + params: { + // Required parameters + name: 'bbaencr001' + storageAccountId: '' + // Non-required parameters + cMKKeyName: '' + cMKKeyVaultResourceId: '' + enableDefaultTelemetry: '' managedIdentities: { - systemAssigned: true + userAssignedResourcesIds: [ + '' + ] } poolAllocationMode: 'BatchService' privateEndpoints: [ @@ -80,13 +115,7 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { privateDnsZoneResourceIds: [ '' ] - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] + service: 'batchAccount' subnetResourceId: '' tags: { Environment: 'Non-Prod' @@ -95,13 +124,6 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { } } ] - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] storageAccessIdentity: '' storageAuthenticationMode: 'BatchAccountManagedIdentity' tags: { @@ -127,40 +149,26 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "bbacom001" + "value": "bbaencr001" }, "storageAccountId": { "value": "" }, // Non-required parameters - "diagnosticSettings": { - "value": [ - { - "eventHubAuthorizationRuleResourceId": "", - "eventHubName": "", - "metricCategories": [ - { - "category": "AllMetrics" - } - ], - "name": "customSetting", - "storageAccountResourceId": "", - "workspaceResourceId": "" - } - ] + "cMKKeyName": { + "value": "" + }, + "cMKKeyVaultResourceId": { + "value": "" }, "enableDefaultTelemetry": { "value": "" }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, "managedIdentities": { "value": { - "systemAssigned": true + "userAssignedResourcesIds": [ + "" + ] } }, "poolAllocationMode": { @@ -172,13 +180,7 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { "privateDnsZoneResourceIds": [ "" ], - "roleAssignments": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ], + "service": "batchAccount", "subnetResourceId": "", "tags": { "Environment": "Non-Prod", @@ -188,15 +190,6 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { } ] }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, "storageAccessIdentity": { "value": "" }, @@ -217,9 +210,9 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 3: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -228,68 +221,33 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-bbamin' + name: '${uniqueString(deployment().name, location)}-test-bbamax' params: { // Required parameters - name: 'bbamin001' + name: 'bbamax001' storageAccountId: '' // Non-required parameters + diagnosticSettings: [ + { + eventHubAuthorizationRuleResourceId: '' + eventHubName: '' + metricCategories: [ + { + category: 'AllMetrics' + } + ] + name: 'customSetting' + storageAccountResourceId: '' + workspaceResourceId: '' + } + ] enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "bbamin001" - }, - "storageAccountId": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' } - } -} -``` - -
-

- -### Example 3: _Encr_ - -

- -via Bicep module - -```bicep -module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-bbaencr' - params: { - // Required parameters - name: 'bbaencr001' - storageAccountId: '' - // Non-required parameters - cMKKeyName: '' - cMKKeyVaultResourceId: '' - enableDefaultTelemetry: '' managedIdentities: { - userAssignedResourcesIds: [ - '' - ] + systemAssigned: true } poolAllocationMode: 'BatchService' privateEndpoints: [ @@ -297,7 +255,13 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { privateDnsZoneResourceIds: [ '' ] - service: 'batchAccount' + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] subnetResourceId: '' tags: { Environment: 'Non-Prod' @@ -306,6 +270,13 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { } } ] + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] storageAccessIdentity: '' storageAuthenticationMode: 'BatchAccountManagedIdentity' tags: { @@ -331,26 +302,40 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "bbaencr001" + "value": "bbamax001" }, "storageAccountId": { "value": "" }, // Non-required parameters - "cMKKeyName": { - "value": "" - }, - "cMKKeyVaultResourceId": { - "value": "" + "diagnosticSettings": { + "value": [ + { + "eventHubAuthorizationRuleResourceId": "", + "eventHubName": "", + "metricCategories": [ + { + "category": "AllMetrics" + } + ], + "name": "customSetting", + "storageAccountResourceId": "", + "workspaceResourceId": "" + } + ] }, "enableDefaultTelemetry": { "value": "" }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, "managedIdentities": { "value": { - "userAssignedResourcesIds": [ - "" - ] + "systemAssigned": true } }, "poolAllocationMode": { @@ -362,7 +347,13 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { "privateDnsZoneResourceIds": [ "" ], - "service": "batchAccount", + "roleAssignments": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ], "subnetResourceId": "", "tags": { "Environment": "Non-Prod", @@ -372,6 +363,15 @@ module batchAccount 'br:bicep/modules/batch.batch-account:1.0.0' = { } ] }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, "storageAccessIdentity": { "value": "" }, diff --git a/modules/cache/redis-enterprise/README.md b/modules/cache/redis-enterprise/README.md index 9dd72d458e..50eaf4f856 100644 --- a/modules/cache/redis-enterprise/README.md +++ b/modules/cache/redis-enterprise/README.md @@ -30,11 +30,180 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/cache.redis-enterprise:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Geo](#example-3-geo) +- [Using only defaults](#example-1-using-only-defaults) +- [Geo](#example-2-geo) +- [Using large parameter set](#example-3-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module redisEnterprise 'br:bicep/modules/cache.redis-enterprise:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-cremin' + params: { + // Required parameters + name: 'cremin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "cremin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Geo_ + +

+ +via Bicep module + +```bicep +module redisEnterprise 'br:bicep/modules/cache.redis-enterprise:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-cregeo' + params: { + // Required parameters + name: '' + // Non-required parameters + capacity: 2 + databases: [ + { + clusteringPolicy: 'EnterpriseCluster' + evictionPolicy: 'NoEviction' + geoReplication: { + groupNickname: '' + linkedDatabases: [ + { + id: '' + } + { + id: '' + } + ] + } + modules: [ + { + name: 'RediSearch' + } + { + name: 'RedisJSON' + } + ] + persistenceAofEnabled: false + persistenceRdbEnabled: false + port: 10000 + } + ] + enableDefaultTelemetry: '' + tags: { + 'hidden-title': 'This is visible in the resource name' + resourceType: 'Redis Cache Enterprise' + } + zoneRedundant: true + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "" + }, + // Non-required parameters + "capacity": { + "value": 2 + }, + "databases": { + "value": [ + { + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "NoEviction", + "geoReplication": { + "groupNickname": "", + "linkedDatabases": [ + { + "id": "" + }, + { + "id": "" + } + ] + }, + "modules": [ + { + "name": "RediSearch" + }, + { + "name": "RedisJSON" + } + ], + "persistenceAofEnabled": false, + "persistenceRdbEnabled": false, + "port": 10000 + } + ] + }, + "enableDefaultTelemetry": { + "value": "" + }, + "tags": { + "value": { + "hidden-title": "This is visible in the resource name", + "resourceType": "Redis Cache Enterprise" + } + }, + "zoneRedundant": { + "value": true + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -45,10 +214,10 @@ This instance deploys the module with most of its features enabled. ```bicep module redisEnterprise 'br:bicep/modules/cache.redis-enterprise:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-crecom' + name: '${uniqueString(deployment().name, location)}-test-cremax' params: { // Required parameters - name: 'crecom001' + name: 'cremax001' // Non-required parameters capacity: 2 databases: [ @@ -133,7 +302,7 @@ module redisEnterprise 'br:bicep/modules/cache.redis-enterprise:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "crecom001" + "value": "cremax001" }, // Non-required parameters "capacity": { @@ -228,175 +397,6 @@ module redisEnterprise 'br:bicep/modules/cache.redis-enterprise:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module redisEnterprise 'br:bicep/modules/cache.redis-enterprise:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cremin' - params: { - // Required parameters - name: 'cremin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "cremin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Geo_ - -

- -via Bicep module - -```bicep -module redisEnterprise 'br:bicep/modules/cache.redis-enterprise:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cregeo' - params: { - // Required parameters - name: '' - // Non-required parameters - capacity: 2 - databases: [ - { - clusteringPolicy: 'EnterpriseCluster' - evictionPolicy: 'NoEviction' - geoReplication: { - groupNickname: '' - linkedDatabases: [ - { - id: '' - } - { - id: '' - } - ] - } - modules: [ - { - name: 'RediSearch' - } - { - name: 'RedisJSON' - } - ] - persistenceAofEnabled: false - persistenceRdbEnabled: false - port: 10000 - } - ] - enableDefaultTelemetry: '' - tags: { - 'hidden-title': 'This is visible in the resource name' - resourceType: 'Redis Cache Enterprise' - } - zoneRedundant: true - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "" - }, - // Non-required parameters - "capacity": { - "value": 2 - }, - "databases": { - "value": [ - { - "clusteringPolicy": "EnterpriseCluster", - "evictionPolicy": "NoEviction", - "geoReplication": { - "groupNickname": "", - "linkedDatabases": [ - { - "id": "" - }, - { - "id": "" - } - ] - }, - "modules": [ - { - "name": "RediSearch" - }, - { - "name": "RedisJSON" - } - ], - "persistenceAofEnabled": false, - "persistenceRdbEnabled": false, - "port": 10000 - } - ] - }, - "enableDefaultTelemetry": { - "value": "" - }, - "tags": { - "value": { - "hidden-title": "This is visible in the resource name", - "resourceType": "Redis Cache Enterprise" - } - }, - "zoneRedundant": { - "value": true - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/cache/redis/README.md b/modules/cache/redis/README.md index ec7076e7cc..6c833b7a8a 100644 --- a/modules/cache/redis/README.md +++ b/modules/cache/redis/README.md @@ -30,10 +30,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/cache.redis:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module redis 'br:bicep/modules/cache.redis:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-crmin' + params: { + // Required parameters + name: 'crmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "crmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -44,10 +92,10 @@ This instance deploys the module with most of its features enabled. ```bicep module redis 'br:bicep/modules/cache.redis:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-crcom' + name: '${uniqueString(deployment().name, location)}-test-crmax' params: { // Required parameters - name: 'crcom001' + name: 'crmax001' // Non-required parameters capacity: 2 diagnosticSettings: [ @@ -121,7 +169,7 @@ module redis 'br:bicep/modules/cache.redis:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "crcom001" + "value": "crmax001" }, // Non-required parameters "capacity": { @@ -215,54 +263,6 @@ module redis 'br:bicep/modules/cache.redis:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module redis 'br:bicep/modules/cache.redis:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-crmin' - params: { - // Required parameters - name: 'crmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "crmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/cdn/profile/README.md b/modules/cdn/profile/README.md index b6fb4eb69e..41fd0159bf 100644 --- a/modules/cdn/profile/README.md +++ b/modules/cdn/profile/README.md @@ -267,10 +267,10 @@ This instance deploys the module with most of its features enabled. ```bicep module profile 'br:bicep/modules/cdn.profile:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cdnpcom' + name: '${uniqueString(deployment().name, location)}-test-cdnpmax' params: { // Required parameters - name: 'dep-test-cdnpcom' + name: 'dep-test-cdnpmax' sku: 'Standard_Verizon' // Non-required parameters enableDefaultTelemetry: '' @@ -335,7 +335,7 @@ module profile 'br:bicep/modules/cdn.profile:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "dep-test-cdnpcom" + "value": "dep-test-cdnpmax" }, "sku": { "value": "Standard_Verizon" diff --git a/modules/cognitive-services/account/README.md b/modules/cognitive-services/account/README.md index 66a4163847..26626e96c2 100644 --- a/modules/cognitive-services/account/README.md +++ b/modules/cognitive-services/account/README.md @@ -32,12 +32,149 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/cognitive-services.account:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) - [Speech](#example-4-speech) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module account 'br:bicep/modules/cognitive-services.account:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-csamin' + params: { + // Required parameters + kind: 'SpeechServices' + name: 'csamin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "kind": { + "value": "SpeechServices" + }, + "name": { + "value": "csamin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module account 'br:bicep/modules/cognitive-services.account:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-csaencr' + params: { + // Required parameters + kind: 'SpeechServices' + name: 'csaencr001' + // Non-required parameters + cMKKeyName: '' + cMKKeyVaultResourceId: '' + cMKUserAssignedIdentityResourceId: '' + enableDefaultTelemetry: '' + managedIdentities: { + userAssignedResourcesIds: [ + '' + ] + } + publicNetworkAccess: 'Enabled' + restrictOutboundNetworkAccess: false + sku: 'S0' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "kind": { + "value": "SpeechServices" + }, + "name": { + "value": "csaencr001" + }, + // Non-required parameters + "cMKKeyName": { + "value": "" + }, + "cMKKeyVaultResourceId": { + "value": "" + }, + "cMKUserAssignedIdentityResourceId": { + "value": "" + }, + "enableDefaultTelemetry": { + "value": "" + }, + "managedIdentities": { + "value": { + "userAssignedResourcesIds": [ + "" + ] + } + }, + "publicNetworkAccess": { + "value": "Enabled" + }, + "restrictOutboundNetworkAccess": { + "value": false + }, + "sku": { + "value": "S0" + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -48,11 +185,11 @@ This instance deploys the module with most of its features enabled. ```bicep module account 'br:bicep/modules/cognitive-services.account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-csacom' + name: '${uniqueString(deployment().name, location)}-test-csamax' params: { // Required parameters kind: 'Face' - name: 'csacom001' + name: 'csamax001' // Non-required parameters customSubDomainName: 'xdomain' diagnosticSettings: [ @@ -141,7 +278,7 @@ module account 'br:bicep/modules/cognitive-services.account:1.0.0' = { "value": "Face" }, "name": { - "value": "csacom001" + "value": "csamax001" }, // Non-required parameters "customSubDomainName": { @@ -237,143 +374,6 @@ module account 'br:bicep/modules/cognitive-services.account:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module account 'br:bicep/modules/cognitive-services.account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-csamin' - params: { - // Required parameters - kind: 'SpeechServices' - name: 'csamin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "kind": { - "value": "SpeechServices" - }, - "name": { - "value": "csamin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Encr_ - -

- -via Bicep module - -```bicep -module account 'br:bicep/modules/cognitive-services.account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-csaencr' - params: { - // Required parameters - kind: 'SpeechServices' - name: 'csaencr001' - // Non-required parameters - cMKKeyName: '' - cMKKeyVaultResourceId: '' - cMKUserAssignedIdentityResourceId: '' - enableDefaultTelemetry: '' - managedIdentities: { - userAssignedResourcesIds: [ - '' - ] - } - publicNetworkAccess: 'Enabled' - restrictOutboundNetworkAccess: false - sku: 'S0' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "kind": { - "value": "SpeechServices" - }, - "name": { - "value": "csaencr001" - }, - // Non-required parameters - "cMKKeyName": { - "value": "" - }, - "cMKKeyVaultResourceId": { - "value": "" - }, - "cMKUserAssignedIdentityResourceId": { - "value": "" - }, - "enableDefaultTelemetry": { - "value": "" - }, - "managedIdentities": { - "value": { - "userAssignedResourcesIds": [ - "" - ] - } - }, - "publicNetworkAccess": { - "value": "Enabled" - }, - "restrictOutboundNetworkAccess": { - "value": false - }, - "sku": { - "value": "S0" - } - } -} -``` - -
-

- ### Example 4: _Speech_

diff --git a/modules/compute/availability-set/README.md b/modules/compute/availability-set/README.md index 3f66218b6c..e2d646e9bf 100644 --- a/modules/compute/availability-set/README.md +++ b/modules/compute/availability-set/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/compute.availability-set:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -40,29 +40,12 @@ This instance deploys the module with most of its features enabled. ```bicep module availabilitySet 'br:bicep/modules/compute.availability-set:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cascom' + name: '${uniqueString(deployment().name, location)}-test-casmin' params: { // Required parameters - name: 'cascom001' + name: 'casmin001' // Non-required parameters enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - proximityPlacementGroupResourceId: '' - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -81,36 +64,11 @@ module availabilitySet 'br:bicep/modules/compute.availability-set:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "cascom001" + "value": "casmin001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "proximityPlacementGroupResourceId": { - "value": "" - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -119,9 +77,9 @@ module availabilitySet 'br:bicep/modules/compute.availability-set:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -130,12 +88,29 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module availabilitySet 'br:bicep/modules/compute.availability-set:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-casmin' + name: '${uniqueString(deployment().name, location)}-test-casmax' params: { // Required parameters - name: 'casmin001' + name: 'casmax001' // Non-required parameters enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + proximityPlacementGroupResourceId: '' + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -154,11 +129,36 @@ module availabilitySet 'br:bicep/modules/compute.availability-set:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "casmin001" + "value": "casmax001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "proximityPlacementGroupResourceId": { + "value": "" + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } diff --git a/modules/compute/disk-encryption-set/README.md b/modules/compute/disk-encryption-set/README.md index 8352867f9e..c3d9e9d920 100644 --- a/modules/compute/disk-encryption-set/README.md +++ b/modules/compute/disk-encryption-set/README.md @@ -137,12 +137,12 @@ This instance deploys the module with most of its features enabled. ```bicep module diskEncryptionSet 'br:bicep/modules/compute.disk-encryption-set:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cdescom' + name: '${uniqueString(deployment().name, location)}-test-cdesmax' params: { // Required parameters keyName: '' keyVaultResourceId: '' - name: 'cdescom001' + name: 'cdesmax001' // Non-required parameters enableDefaultTelemetry: '' lock: { @@ -190,7 +190,7 @@ module diskEncryptionSet 'br:bicep/modules/compute.disk-encryption-set:1.0.0' = "value": "" }, "name": { - "value": "cdescom001" + "value": "cdesmax001" }, // Non-required parameters "enableDefaultTelemetry": { diff --git a/modules/compute/disk/README.md b/modules/compute/disk/README.md index 11eec29dec..53656e6a71 100644 --- a/modules/compute/disk/README.md +++ b/modules/compute/disk/README.md @@ -26,14 +26,14 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/compute.disk:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Image](#example-3-image) -- [Import](#example-4-import) +- [Using only defaults](#example-1-using-only-defaults) +- [Image](#example-2-image) +- [Import](#example-3-import) +- [Using large parameter set](#example-4-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -42,35 +42,14 @@ This instance deploys the module with most of its features enabled. ```bicep module disk 'br:bicep/modules/compute.disk:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cdcom' + name: '${uniqueString(deployment().name, location)}-test-cdmin' params: { // Required parameters - name: 'cdcom001' - sku: 'UltraSSD_LRS' + name: 'cdmin001' + sku: 'Standard_LRS' // Non-required parameters - diskIOPSReadWrite: 500 - diskMBpsReadWrite: 60 - diskSizeGB: 128 + diskSizeGB: 1 enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - logicalSectorSize: 512 - osType: 'Windows' - publicNetworkAccess: 'Enabled' - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -89,54 +68,17 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "cdcom001" + "value": "cdmin001" }, "sku": { - "value": "UltraSSD_LRS" + "value": "Standard_LRS" }, // Non-required parameters - "diskIOPSReadWrite": { - "value": 500 - }, - "diskMBpsReadWrite": { - "value": 60 - }, "diskSizeGB": { - "value": 128 + "value": 1 }, "enableDefaultTelemetry": { "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "logicalSectorSize": { - "value": 512 - }, - "osType": { - "value": "Windows" - }, - "publicNetworkAccess": { - "value": "Enabled" - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -145,10 +87,7 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - +### Example 2: _Image_

@@ -156,14 +95,27 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module disk 'br:bicep/modules/compute.disk:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cdmin' + name: '${uniqueString(deployment().name, location)}-test-cdimg' params: { // Required parameters - name: 'cdmin001' + name: 'cdimg001' sku: 'Standard_LRS' // Non-required parameters - diskSizeGB: 1 + createOption: 'FromImage' enableDefaultTelemetry: '' + imageReferenceId: '' + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -182,17 +134,36 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "cdmin001" + "value": "cdimg001" }, "sku": { "value": "Standard_LRS" }, // Non-required parameters - "diskSizeGB": { - "value": 1 + "createOption": { + "value": "FromImage" }, "enableDefaultTelemetry": { "value": "" + }, + "imageReferenceId": { + "value": "" + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } @@ -201,7 +172,7 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = {

-### Example 3: _Image_ +### Example 3: _Import_

@@ -209,15 +180,14 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { ```bicep module disk 'br:bicep/modules/compute.disk:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cdimg' + name: '${uniqueString(deployment().name, location)}-test-cdimp' params: { // Required parameters - name: 'cdimg001' + name: 'cdimp001' sku: 'Standard_LRS' // Non-required parameters - createOption: 'FromImage' + createOption: 'Import' enableDefaultTelemetry: '' - imageReferenceId: '' roleAssignments: [ { principalId: '' @@ -225,6 +195,8 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { roleDefinitionIdOrName: 'Reader' } ] + sourceUri: '' + storageAccountId: '' tags: { Environment: 'Non-Prod' 'hidden-title': 'This is visible in the resource name' @@ -248,21 +220,18 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "cdimg001" + "value": "cdimp001" }, "sku": { "value": "Standard_LRS" }, // Non-required parameters "createOption": { - "value": "FromImage" + "value": "Import" }, "enableDefaultTelemetry": { "value": "" }, - "imageReferenceId": { - "value": "" - }, "roleAssignments": { "value": [ { @@ -272,6 +241,12 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { } ] }, + "sourceUri": { + "value": "" + }, + "storageAccountId": { + "value": "" + }, "tags": { "value": { "Environment": "Non-Prod", @@ -286,7 +261,10 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = {

-### Example 4: _Import_ +### Example 4: _Using large parameter set_ + +This instance deploys the module with most of its features enabled. +

@@ -294,14 +272,23 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { ```bicep module disk 'br:bicep/modules/compute.disk:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cdimp' + name: '${uniqueString(deployment().name, location)}-test-cdmax' params: { // Required parameters - name: 'cdimp001' - sku: 'Standard_LRS' + name: 'cdmax001' + sku: 'UltraSSD_LRS' // Non-required parameters - createOption: 'Import' + diskIOPSReadWrite: 500 + diskMBpsReadWrite: 60 + diskSizeGB: 128 enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + logicalSectorSize: 512 + osType: 'Windows' + publicNetworkAccess: 'Enabled' roleAssignments: [ { principalId: '' @@ -309,8 +296,6 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { roleDefinitionIdOrName: 'Reader' } ] - sourceUri: '' - storageAccountId: '' tags: { Environment: 'Non-Prod' 'hidden-title': 'This is visible in the resource name' @@ -334,18 +319,39 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "cdimp001" + "value": "cdmax001" }, "sku": { - "value": "Standard_LRS" + "value": "UltraSSD_LRS" }, // Non-required parameters - "createOption": { - "value": "Import" + "diskIOPSReadWrite": { + "value": 500 + }, + "diskMBpsReadWrite": { + "value": 60 + }, + "diskSizeGB": { + "value": 128 }, "enableDefaultTelemetry": { "value": "" }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "logicalSectorSize": { + "value": 512 + }, + "osType": { + "value": "Windows" + }, + "publicNetworkAccess": { + "value": "Enabled" + }, "roleAssignments": { "value": [ { @@ -355,12 +361,6 @@ module disk 'br:bicep/modules/compute.disk:1.0.0' = { } ] }, - "sourceUri": { - "value": "" - }, - "storageAccountId": { - "value": "" - }, "tags": { "value": { "Environment": "Non-Prod", diff --git a/modules/compute/gallery/README.md b/modules/compute/gallery/README.md index 83e56b75e2..4f370dfd3b 100644 --- a/modules/compute/gallery/README.md +++ b/modules/compute/gallery/README.md @@ -28,10 +28,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/compute.gallery:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module gallery 'br:bicep/modules/compute.gallery:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-cgmin' + params: { + // Required parameters + name: 'cgmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "cgmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,17 +90,17 @@ This instance deploys the module with most of its features enabled. ```bicep module gallery 'br:bicep/modules/compute.gallery:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cgcom' + name: '${uniqueString(deployment().name, location)}-test-cgmax' params: { // Required parameters - name: 'cgcom001' + name: 'cgmax001' // Non-required parameters applications: [ { - name: 'cgcom-appd-001' + name: 'cgmax-appd-001' } { - name: 'cgcom-appd-002' + name: 'cgmax-appd-002' roleAssignments: [ { principalId: '' @@ -199,16 +247,16 @@ module gallery 'br:bicep/modules/compute.gallery:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "cgcom001" + "value": "cgmax001" }, // Non-required parameters "applications": { "value": [ { - "name": "cgcom-appd-001" + "name": "cgmax-appd-001" }, { - "name": "cgcom-appd-002", + "name": "cgmax-appd-002", "roleAssignments": [ { "principalId": "", @@ -355,54 +403,6 @@ module gallery 'br:bicep/modules/compute.gallery:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module gallery 'br:bicep/modules/compute.gallery:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cgmin' - params: { - // Required parameters - name: 'cgmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "cgmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/compute/image/README.md b/modules/compute/image/README.md index 4bbb50b4f4..6c22d0ff2d 100644 --- a/modules/compute/image/README.md +++ b/modules/compute/image/README.md @@ -38,10 +38,10 @@ This instance deploys the module with most of its features enabled. ```bicep module image 'br:bicep/modules/compute.image:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cicom' + name: '${uniqueString(deployment().name, location)}-test-cimax' params: { // Required parameters - name: 'cicom001' + name: 'cimax001' osAccountType: 'Premium_LRS' osDiskBlobUri: '' osDiskCaching: 'ReadWrite' @@ -83,7 +83,7 @@ module image 'br:bicep/modules/compute.image:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "cicom001" + "value": "cimax001" }, "osAccountType": { "value": "Premium_LRS" diff --git a/modules/compute/proximity-placement-group/README.md b/modules/compute/proximity-placement-group/README.md index dbc8c0751f..821a6a502e 100644 --- a/modules/compute/proximity-placement-group/README.md +++ b/modules/compute/proximity-placement-group/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/compute.proximity-placement-group:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-group:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-cppgmin' + params: { + // Required parameters + name: 'cppgmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "cppgmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cppgcom' + name: '${uniqueString(deployment().name, location)}-test-cppgmax' params: { // Required parameters - name: 'cppgcom001' + name: 'cppgmax001' // Non-required parameters colocationStatus: { code: 'ColocationStatus/Aligned' @@ -96,7 +144,7 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro "parameters": { // Required parameters "name": { - "value": "cppgcom001" + "value": "cppgmax001" }, // Non-required parameters "colocationStatus": { @@ -155,54 +203,6 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cppgmin' - params: { - // Required parameters - name: 'cppgmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "cppgmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/compute/ssh-public-key/README.md b/modules/compute/ssh-public-key/README.md index 054808608c..fcc48b1abe 100644 --- a/modules/compute/ssh-public-key/README.md +++ b/modules/compute/ssh-public-key/README.md @@ -30,12 +30,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/compute.ssh-public-key:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -44,13 +44,12 @@ This instance deploys the module with most of its features enabled. ```bicep module sshPublicKey 'br:bicep/modules/compute.ssh-public-key:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cspkcom' + name: '${uniqueString(deployment().name, location)}-test-cspkmin' params: { // Required parameters - name: 'sshkey-cspkcom001' + name: 'cspkmin001' // Non-required parameters enableDefaultTelemetry: '' - publicKey: '' } } ``` @@ -69,14 +68,11 @@ module sshPublicKey 'br:bicep/modules/compute.ssh-public-key:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "sshkey-cspkcom001" + "value": "cspkmin001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "publicKey": { - "value": "" } } } @@ -85,9 +81,9 @@ module sshPublicKey 'br:bicep/modules/compute.ssh-public-key:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -96,12 +92,13 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module sshPublicKey 'br:bicep/modules/compute.ssh-public-key:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cspkmin' + name: '${uniqueString(deployment().name, location)}-test-cspkmax' params: { // Required parameters - name: 'cspkmin001' + name: 'sshkey-cspkmax001' // Non-required parameters enableDefaultTelemetry: '' + publicKey: '' } } ``` @@ -120,11 +117,14 @@ module sshPublicKey 'br:bicep/modules/compute.ssh-public-key:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "cspkmin001" + "value": "sshkey-cspkmax001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "publicKey": { + "value": "" } } } diff --git a/modules/consumption/budget/README.md b/modules/consumption/budget/README.md index fe87cf897b..44cad18b76 100644 --- a/modules/consumption/budget/README.md +++ b/modules/consumption/budget/README.md @@ -24,12 +24,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/consumption.budget:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -38,23 +38,16 @@ This instance deploys the module with most of its features enabled. ```bicep module budget 'br:bicep/modules/consumption.budget:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-cbcom' + name: '${uniqueString(deployment().name)}-test-cbmin' params: { // Required parameters amount: 500 - name: 'cbcom001' + name: 'cbmin001' // Non-required parameters contactEmails: [ 'dummy@contoso.com' ] enableDefaultTelemetry: '' - thresholds: [ - 50 - 75 - 90 - 100 - 110 - ] } } ``` @@ -76,7 +69,7 @@ module budget 'br:bicep/modules/consumption.budget:1.0.0' = { "value": 500 }, "name": { - "value": "cbcom001" + "value": "cbmin001" }, // Non-required parameters "contactEmails": { @@ -86,15 +79,6 @@ module budget 'br:bicep/modules/consumption.budget:1.0.0' = { }, "enableDefaultTelemetry": { "value": "" - }, - "thresholds": { - "value": [ - 50, - 75, - 90, - 100, - 110 - ] } } } @@ -103,9 +87,9 @@ module budget 'br:bicep/modules/consumption.budget:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -114,16 +98,23 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module budget 'br:bicep/modules/consumption.budget:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-cbmin' + name: '${uniqueString(deployment().name)}-test-cbmax' params: { // Required parameters amount: 500 - name: 'cbmin001' + name: 'cbmax001' // Non-required parameters contactEmails: [ 'dummy@contoso.com' ] enableDefaultTelemetry: '' + thresholds: [ + 50 + 75 + 90 + 100 + 110 + ] } } ``` @@ -145,7 +136,7 @@ module budget 'br:bicep/modules/consumption.budget:1.0.0' = { "value": 500 }, "name": { - "value": "cbmin001" + "value": "cbmax001" }, // Non-required parameters "contactEmails": { @@ -155,6 +146,15 @@ module budget 'br:bicep/modules/consumption.budget:1.0.0' = { }, "enableDefaultTelemetry": { "value": "" + }, + "thresholds": { + "value": [ + 50, + 75, + 90, + 100, + 110 + ] } } } diff --git a/modules/container-instance/container-group/README.md b/modules/container-instance/container-group/README.md index 124aa25f20..7918b1c8a2 100644 --- a/modules/container-instance/container-group/README.md +++ b/modules/container-instance/container-group/README.md @@ -26,14 +26,14 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/container-instance.container-group:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) - [Private](#example-4-private) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -42,7 +42,108 @@ This instance deploys the module with most of its features enabled. ```bicep module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cicgcom' + name: '${uniqueString(deployment().name, location)}-test-cicgmin' + params: { + // Required parameters + containers: [ + { + name: 'az-aci-x-001' + properties: { + image: 'mcr.microsoft.com/azuredocs/aci-helloworld' + ports: [ + { + port: '443' + protocol: 'Tcp' + } + ] + resources: { + requests: { + cpu: 2 + memoryInGB: 2 + } + } + } + } + ] + name: 'cicgmin001' + // Non-required parameters + enableDefaultTelemetry: '' + ipAddressPorts: [ + { + port: 443 + protocol: 'Tcp' + } + ] + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "containers": { + "value": [ + { + "name": "az-aci-x-001", + "properties": { + "image": "mcr.microsoft.com/azuredocs/aci-helloworld", + "ports": [ + { + "port": "443", + "protocol": "Tcp" + } + ], + "resources": { + "requests": { + "cpu": 2, + "memoryInGB": 2 + } + } + } + } + ] + }, + "name": { + "value": "cicgmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "ipAddressPorts": { + "value": [ + { + "port": 443, + "protocol": "Tcp" + } + ] + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-cicgenc' params: { // Required parameters containers: [ @@ -91,8 +192,13 @@ module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0 } } ] - name: 'cicgcom001' + name: 'cicgenc001' // Non-required parameters + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + userAssignedIdentityResourceId: '' + } enableDefaultTelemetry: '' ipAddressPorts: [ { @@ -185,9 +291,16 @@ module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0 ] }, "name": { - "value": "cicgcom001" + "value": "cicgenc001" }, // Non-required parameters + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" + } + }, "enableDefaultTelemetry": { "value": "" }, @@ -231,111 +344,10 @@ module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0

-### Example 2: _Using only defaults_ +### Example 3: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cicgmin' - params: { - // Required parameters - containers: [ - { - name: 'az-aci-x-001' - properties: { - image: 'mcr.microsoft.com/azuredocs/aci-helloworld' - ports: [ - { - port: '443' - protocol: 'Tcp' - } - ] - resources: { - requests: { - cpu: 2 - memoryInGB: 2 - } - } - } - } - ] - name: 'cicgmin001' - // Non-required parameters - enableDefaultTelemetry: '' - ipAddressPorts: [ - { - port: 443 - protocol: 'Tcp' - } - ] - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "containers": { - "value": [ - { - "name": "az-aci-x-001", - "properties": { - "image": "mcr.microsoft.com/azuredocs/aci-helloworld", - "ports": [ - { - "port": "443", - "protocol": "Tcp" - } - ], - "resources": { - "requests": { - "cpu": 2, - "memoryInGB": 2 - } - } - } - } - ] - }, - "name": { - "value": "cicgmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "ipAddressPorts": { - "value": [ - { - "port": 443, - "protocol": "Tcp" - } - ] - } - } -} -``` - -
-

+This instance deploys the module with most of its features enabled. -### Example 3: _Encr_

@@ -343,7 +355,7 @@ module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0 ```bicep module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-cicgenc' + name: '${uniqueString(deployment().name, location)}-test-cicgmax' params: { // Required parameters containers: [ @@ -392,13 +404,8 @@ module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0 } } ] - name: 'cicgenc001' + name: 'cicgmax001' // Non-required parameters - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } enableDefaultTelemetry: '' ipAddressPorts: [ { @@ -491,16 +498,9 @@ module containerGroup 'br:bicep/modules/container-instance.container-group:1.0.0 ] }, "name": { - "value": "cicgenc001" + "value": "cicgmax001" }, // Non-required parameters - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } - }, "enableDefaultTelemetry": { "value": "" }, diff --git a/modules/container-registry/registry/README.md b/modules/container-registry/registry/README.md index 4568b1acee..940cac8fae 100644 --- a/modules/container-registry/registry/README.md +++ b/modules/container-registry/registry/README.md @@ -32,12 +32,149 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/container-registry.registry:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) - [Pe](#example-4-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module registry 'br:bicep/modules/container-registry.registry:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-crrmin' + params: { + // Required parameters + name: 'crrmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "crrmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module registry 'br:bicep/modules/container-registry.registry:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-crrencr' + params: { + // Required parameters + name: 'crrencr001' + // Non-required parameters + acrSku: 'Premium' + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + userAssignedIdentityResourceId: '' + } + enableDefaultTelemetry: '' + managedIdentities: { + userAssignedResourcesIds: [ + '' + ] + } + publicNetworkAccess: 'Disabled' + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "crrencr001" + }, + // Non-required parameters + "acrSku": { + "value": "Premium" + }, + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" + } + }, + "enableDefaultTelemetry": { + "value": "" + }, + "managedIdentities": { + "value": { + "userAssignedResourcesIds": [ + "" + ] + } + }, + "publicNetworkAccess": { + "value": "Disabled" + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -48,10 +185,10 @@ This instance deploys the module with most of its features enabled. ```bicep module registry 'br:bicep/modules/container-registry.registry:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-crrcom' + name: '${uniqueString(deployment().name, location)}-test-crrmax' params: { // Required parameters - name: 'crrcom001' + name: 'crrmax001' // Non-required parameters acrAdminUserEnabled: false acrSku: 'Premium' @@ -158,7 +295,7 @@ module registry 'br:bicep/modules/container-registry.registry:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "crrcom001" + "value": "crrmax001" }, // Non-required parameters "acrAdminUserEnabled": { @@ -293,143 +430,6 @@ module registry 'br:bicep/modules/container-registry.registry:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module registry 'br:bicep/modules/container-registry.registry:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-crrmin' - params: { - // Required parameters - name: 'crrmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "crrmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Encr_ - -

- -via Bicep module - -```bicep -module registry 'br:bicep/modules/container-registry.registry:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-crrencr' - params: { - // Required parameters - name: 'crrencr001' - // Non-required parameters - acrSku: 'Premium' - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } - enableDefaultTelemetry: '' - managedIdentities: { - userAssignedResourcesIds: [ - '' - ] - } - publicNetworkAccess: 'Disabled' - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "crrencr001" - }, - // Non-required parameters - "acrSku": { - "value": "Premium" - }, - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } - }, - "enableDefaultTelemetry": { - "value": "" - }, - "managedIdentities": { - "value": { - "userAssignedResourcesIds": [ - "" - ] - } - }, - "publicNetworkAccess": { - "value": "Disabled" - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - } -} -``` - -
-

- ### Example 4: _Pe_

diff --git a/modules/data-factory/factory/README.md b/modules/data-factory/factory/README.md index b01bb04610..4df25ff5d9 100644 --- a/modules/data-factory/factory/README.md +++ b/modules/data-factory/factory/README.md @@ -33,10 +33,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/data-factory.factory:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module factory 'br:bicep/modules/data-factory.factory:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dffmin' + params: { + // Required parameters + name: 'dffmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dffmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -47,10 +95,10 @@ This instance deploys the module with most of its features enabled. ```bicep module factory 'br:bicep/modules/data-factory.factory:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dffcom' + name: '${uniqueString(deployment().name, location)}-test-dffmax' params: { // Required parameters - name: 'dffcom001' + name: 'dffmax001' // Non-required parameters customerManagedKey: { keyName: '' @@ -158,7 +206,7 @@ module factory 'br:bicep/modules/data-factory.factory:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "dffcom001" + "value": "dffmax001" }, // Non-required parameters "customerManagedKey": { @@ -282,54 +330,6 @@ module factory 'br:bicep/modules/data-factory.factory:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module factory 'br:bicep/modules/data-factory.factory:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dffmin' - params: { - // Required parameters - name: 'dffmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dffmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/data-protection/backup-vault/README.md b/modules/data-protection/backup-vault/README.md index 8784320e19..200b51d6bc 100644 --- a/modules/data-protection/backup-vault/README.md +++ b/modules/data-protection/backup-vault/README.md @@ -28,10 +28,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/data-protection.backup-vault:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module backupVault 'br:bicep/modules/data-protection.backup-vault:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dpbvmin' + params: { + // Required parameters + name: 'dpbvmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dpbvmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,10 +90,10 @@ This instance deploys the module with most of its features enabled. ```bicep module backupVault 'br:bicep/modules/data-protection.backup-vault:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dpbvcom' + name: '${uniqueString(deployment().name, location)}-test-dpbvmax' params: { // Required parameters - name: 'dpbvcom001' + name: 'dpbvmax001' // Non-required parameters azureMonitorAlertSettingsAlertsForAllJobFailures: 'Disabled' backupPolicies: [ @@ -148,7 +196,7 @@ module backupVault 'br:bicep/modules/data-protection.backup-vault:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "dpbvcom001" + "value": "dpbvmax001" }, // Non-required parameters "azureMonitorAlertSettingsAlertsForAllJobFailures": { @@ -255,54 +303,6 @@ module backupVault 'br:bicep/modules/data-protection.backup-vault:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module backupVault 'br:bicep/modules/data-protection.backup-vault:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dpbvmin' - params: { - // Required parameters - name: 'dpbvmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dpbvmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/databricks/access-connector/README.md b/modules/databricks/access-connector/README.md index 91fdd3ebdd..ad53643158 100644 --- a/modules/databricks/access-connector/README.md +++ b/modules/databricks/access-connector/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/databricks.access-connector:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module accessConnector 'br:bicep/modules/databricks.access-connector:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dacmin' + params: { + // Required parameters + name: 'dacmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dacmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module accessConnector 'br:bicep/modules/databricks.access-connector:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-daccom' + name: '${uniqueString(deployment().name, location)}-test-dacmax' params: { // Required parameters - name: 'daccom001' + name: 'dacmax001' // Non-required parameters enableDefaultTelemetry: '' location: '' @@ -87,7 +135,7 @@ module accessConnector 'br:bicep/modules/databricks.access-connector:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "daccom001" + "value": "dacmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -133,54 +181,6 @@ module accessConnector 'br:bicep/modules/databricks.access-connector:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module accessConnector 'br:bicep/modules/databricks.access-connector:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dacmin' - params: { - // Required parameters - name: 'dacmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dacmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/databricks/workspace/README.md b/modules/databricks/workspace/README.md index 3fed69efc9..512cd9bc26 100644 --- a/modules/databricks/workspace/README.md +++ b/modules/databricks/workspace/README.md @@ -30,10 +30,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/databricks.workspace:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module workspace 'br:bicep/modules/databricks.workspace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dwmin' + params: { + // Required parameters + name: 'dwmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dwmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -44,10 +92,10 @@ This instance deploys the module with most of its features enabled. ```bicep module workspace 'br:bicep/modules/databricks.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dwcom' + name: '${uniqueString(deployment().name, location)}-test-dwmax' params: { // Required parameters - name: 'dwcom001' + name: 'dwmax001' // Non-required parameters amlWorkspaceResourceId: '' customerManagedKey: { @@ -115,7 +163,7 @@ module workspace 'br:bicep/modules/databricks.workspace:1.0.0' = { } ] skuName: 'premium' - storageAccountName: 'sadwcom001' + storageAccountName: 'sadwmax001' storageAccountSkuName: 'Standard_ZRS' tags: { Environment: 'Non-Prod' @@ -141,7 +189,7 @@ module workspace 'br:bicep/modules/databricks.workspace:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "dwcom001" + "value": "dwmax001" }, // Non-required parameters "amlWorkspaceResourceId": { @@ -257,7 +305,7 @@ module workspace 'br:bicep/modules/databricks.workspace:1.0.0' = { "value": "premium" }, "storageAccountName": { - "value": "sadwcom001" + "value": "sadwmax001" }, "storageAccountSkuName": { "value": "Standard_ZRS" @@ -279,54 +327,6 @@ module workspace 'br:bicep/modules/databricks.workspace:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module workspace 'br:bicep/modules/databricks.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dwmin' - params: { - // Required parameters - name: 'dwmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dwmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/desktop-virtualization/application-group/README.md b/modules/desktop-virtualization/application-group/README.md index 7e86196f3e..83aa677d85 100644 --- a/modules/desktop-virtualization/application-group/README.md +++ b/modules/desktop-virtualization/application-group/README.md @@ -28,10 +28,66 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/desktop-virtualization.application-group:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module applicationGroup 'br:bicep/modules/desktop-virtualization.application-group:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dvagmin' + params: { + // Required parameters + applicationGroupType: 'RemoteApp' + hostpoolName: '' + name: 'dvagmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "applicationGroupType": { + "value": "RemoteApp" + }, + "hostpoolName": { + "value": "" + }, + "name": { + "value": "dvagmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,12 +98,12 @@ This instance deploys the module with most of its features enabled. ```bicep module applicationGroup 'br:bicep/modules/desktop-virtualization.application-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dvagcom' + name: '${uniqueString(deployment().name, location)}-test-dvagmax' params: { // Required parameters applicationGroupType: 'RemoteApp' hostpoolName: '' - name: 'dvagcom001' + name: 'dvagmax001' // Non-required parameters applications: [ { @@ -120,7 +176,7 @@ module applicationGroup 'br:bicep/modules/desktop-virtualization.application-gro "value": "" }, "name": { - "value": "dvagcom001" + "value": "dvagmax001" }, // Non-required parameters "applications": { @@ -195,62 +251,6 @@ module applicationGroup 'br:bicep/modules/desktop-virtualization.application-gro

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module applicationGroup 'br:bicep/modules/desktop-virtualization.application-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dvagmin' - params: { - // Required parameters - applicationGroupType: 'RemoteApp' - hostpoolName: '' - name: 'dvagmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "applicationGroupType": { - "value": "RemoteApp" - }, - "hostpoolName": { - "value": "" - }, - "name": { - "value": "dvagmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/desktop-virtualization/host-pool/README.md b/modules/desktop-virtualization/host-pool/README.md index 03ed873f95..cc5703c6ab 100644 --- a/modules/desktop-virtualization/host-pool/README.md +++ b/modules/desktop-virtualization/host-pool/README.md @@ -27,10 +27,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/desktop-virtualization.host-pool:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module hostPool 'br:bicep/modules/desktop-virtualization.host-pool:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dvhpmin' + params: { + // Required parameters + name: 'dvhpmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dvhpmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -41,10 +89,10 @@ This instance deploys the module with most of its features enabled. ```bicep module hostPool 'br:bicep/modules/desktop-virtualization.host-pool:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dvhpcom' + name: '${uniqueString(deployment().name, location)}-test-dvhpmax' params: { // Required parameters - name: 'dvhpcom001' + name: 'dvhpmax001' // Non-required parameters agentUpdate: { maintenanceWindows: [ @@ -130,7 +178,7 @@ module hostPool 'br:bicep/modules/desktop-virtualization.host-pool:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "dvhpcom001" + "value": "dvhpmax001" }, // Non-required parameters "agentUpdate": { @@ -236,54 +284,6 @@ module hostPool 'br:bicep/modules/desktop-virtualization.host-pool:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module hostPool 'br:bicep/modules/desktop-virtualization.host-pool:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dvhpmin' - params: { - // Required parameters - name: 'dvhpmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dvhpmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/desktop-virtualization/scaling-plan/README.md b/modules/desktop-virtualization/scaling-plan/README.md index 032df11696..0983c6dbbc 100644 --- a/modules/desktop-virtualization/scaling-plan/README.md +++ b/modules/desktop-virtualization/scaling-plan/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/desktop-virtualization.scaling-plan:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module scalingPlan 'br:bicep/modules/desktop-virtualization.scaling-plan:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dvspmin' + params: { + // Required parameters + name: 'dvspmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dvspmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module scalingPlan 'br:bicep/modules/desktop-virtualization.scaling-plan:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dvspcom' + name: '${uniqueString(deployment().name, location)}-test-dvspmax' params: { // Required parameters - name: 'dvspcom001' + name: 'dvspmax001' // Non-required parameters description: 'My Scaling Plan Description' diagnosticSettings: [ @@ -128,7 +176,7 @@ module scalingPlan 'br:bicep/modules/desktop-virtualization.scaling-plan:1.0.0' "parameters": { // Required parameters "name": { - "value": "dvspcom001" + "value": "dvspmax001" }, // Non-required parameters "description": { @@ -219,54 +267,6 @@ module scalingPlan 'br:bicep/modules/desktop-virtualization.scaling-plan:1.0.0'

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module scalingPlan 'br:bicep/modules/desktop-virtualization.scaling-plan:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dvspmin' - params: { - // Required parameters - name: 'dvspmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dvspmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/desktop-virtualization/workspace/README.md b/modules/desktop-virtualization/workspace/README.md index 35f5ec4422..2fab487621 100644 --- a/modules/desktop-virtualization/workspace/README.md +++ b/modules/desktop-virtualization/workspace/README.md @@ -27,10 +27,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/desktop-virtualization.workspace:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module workspace 'br:bicep/modules/desktop-virtualization.workspace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dvwmin' + params: { + // Required parameters + name: 'dvwmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dvwmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -41,10 +89,10 @@ This instance deploys the module with most of its features enabled. ```bicep module workspace 'br:bicep/modules/desktop-virtualization.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dvwcom' + name: '${uniqueString(deployment().name, location)}-test-dvwmax' params: { // Required parameters - name: 'dvwcom001' + name: 'dvwmax001' // Non-required parameters appGroupResourceIds: [ '' @@ -96,7 +144,7 @@ module workspace 'br:bicep/modules/desktop-virtualization.workspace:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "dvwcom001" + "value": "dvwmax001" }, // Non-required parameters "appGroupResourceIds": { @@ -156,54 +204,6 @@ module workspace 'br:bicep/modules/desktop-virtualization.workspace:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module workspace 'br:bicep/modules/desktop-virtualization.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dvwmin' - params: { - // Required parameters - name: 'dvwmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dvwmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/dev-test-lab/lab/README.md b/modules/dev-test-lab/lab/README.md index be1f1cc67e..b7b777f88b 100644 --- a/modules/dev-test-lab/lab/README.md +++ b/modules/dev-test-lab/lab/README.md @@ -32,10 +32,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/dev-test-lab.lab:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module lab 'br:bicep/modules/dev-test-lab.lab:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dtllmin' + params: { + // Required parameters + name: 'dtllmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dtllmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -46,10 +94,10 @@ This instance deploys the module with most of its features enabled. ```bicep module lab 'br:bicep/modules/dev-test-lab.lab:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dtllcom' + name: '${uniqueString(deployment().name, location)}-test-dtllmax' params: { // Required parameters - name: 'dtllcom001' + name: 'dtllmax001' // Non-required parameters announcement: { enabled: 'Enabled' @@ -236,7 +284,7 @@ module lab 'br:bicep/modules/dev-test-lab.lab:1.0.0' = { } tags: { 'hidden-title': 'This is visible in the resource name' - labName: 'dtllcom001' + labName: 'dtllmax001' resourceType: 'DevTest Lab' } virtualnetworks: [ @@ -292,7 +340,7 @@ module lab 'br:bicep/modules/dev-test-lab.lab:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "dtllcom001" + "value": "dtllmax001" }, // Non-required parameters "announcement": { @@ -527,7 +575,7 @@ module lab 'br:bicep/modules/dev-test-lab.lab:1.0.0' = { "tags": { "value": { "hidden-title": "This is visible in the resource name", - "labName": "dtllcom001", + "labName": "dtllmax001", "resourceType": "DevTest Lab" } }, @@ -577,54 +625,6 @@ module lab 'br:bicep/modules/dev-test-lab.lab:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module lab 'br:bicep/modules/dev-test-lab.lab:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dtllmin' - params: { - // Required parameters - name: 'dtllmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dtllmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/digital-twins/digital-twins-instance/README.md b/modules/digital-twins/digital-twins-instance/README.md index 7f256381d1..bed016932f 100644 --- a/modules/digital-twins/digital-twins-instance/README.md +++ b/modules/digital-twins/digital-twins-instance/README.md @@ -30,10 +30,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/digital-twins.digital-twins-instance:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module digitalTwinsInstance 'br:bicep/modules/digital-twins.digital-twins-instance:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-dtdtimin' + params: { + // Required parameters + name: 'dtdtimin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "dtdtimin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -44,10 +92,10 @@ This instance deploys the module with most of its features enabled. ```bicep module digitalTwinsInstance 'br:bicep/modules/digital-twins.digital-twins-instance:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dtdticom' + name: '${uniqueString(deployment().name, location)}-test-dtdtimax' params: { // Required parameters - name: 'dtdticom001' + name: 'dtdtimax001' // Non-required parameters diagnosticSettings: [ { @@ -125,7 +173,7 @@ module digitalTwinsInstance 'br:bicep/modules/digital-twins.digital-twins-instan "parameters": { // Required parameters "name": { - "value": "dtdticom001" + "value": "dtdtimax001" }, // Non-required parameters "diagnosticSettings": { @@ -213,54 +261,6 @@ module digitalTwinsInstance 'br:bicep/modules/digital-twins.digital-twins-instan

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module digitalTwinsInstance 'br:bicep/modules/digital-twins.digital-twins-instance:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-dtdtimin' - params: { - // Required parameters - name: 'dtdtimin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "dtdtimin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/event-grid/domain/README.md b/modules/event-grid/domain/README.md index bf1d4cbf98..be9e32e179 100644 --- a/modules/event-grid/domain/README.md +++ b/modules/event-grid/domain/README.md @@ -30,11 +30,59 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/event-grid.domain:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) - [Pe](#example-3-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module domain 'br:bicep/modules/event-grid.domain:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-egdmin' + params: { + // Required parameters + name: 'egdmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "egdmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -45,10 +93,10 @@ This instance deploys the module with most of its features enabled. ```bicep module domain 'br:bicep/modules/event-grid.domain:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-egdcom' + name: '${uniqueString(deployment().name, location)}-test-egdmax' params: { // Required parameters - name: 'egdcom001' + name: 'egdmax001' // Non-required parameters diagnosticSettings: [ { @@ -102,7 +150,7 @@ module domain 'br:bicep/modules/event-grid.domain:1.0.0' = { Role: 'DeploymentValidation' } topics: [ - 'topic-egdcom001' + 'topic-egdmax001' ] } } @@ -122,7 +170,7 @@ module domain 'br:bicep/modules/event-grid.domain:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "egdcom001" + "value": "egdmax001" }, // Non-required parameters "diagnosticSettings": { @@ -192,7 +240,7 @@ module domain 'br:bicep/modules/event-grid.domain:1.0.0' = { }, "topics": { "value": [ - "topic-egdcom001" + "topic-egdmax001" ] } } @@ -202,54 +250,6 @@ module domain 'br:bicep/modules/event-grid.domain:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module domain 'br:bicep/modules/event-grid.domain:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-egdmin' - params: { - // Required parameters - name: 'egdmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "egdmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ### Example 3: _Pe_

diff --git a/modules/event-grid/system-topic/README.md b/modules/event-grid/system-topic/README.md index 5b20bf5b6f..526c04d4a7 100644 --- a/modules/event-grid/system-topic/README.md +++ b/modules/event-grid/system-topic/README.md @@ -28,10 +28,66 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/event-grid.system-topic:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module systemTopic 'br:bicep/modules/event-grid.system-topic:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-egstmin' + params: { + // Required parameters + name: 'egstmin001' + source: '' + topicType: 'Microsoft.Storage.StorageAccounts' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "egstmin001" + }, + "source": { + "value": "" + }, + "topicType": { + "value": "Microsoft.Storage.StorageAccounts" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,10 +98,10 @@ This instance deploys the module with most of its features enabled. ```bicep module systemTopic 'br:bicep/modules/event-grid.system-topic:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-egstcom' + name: '${uniqueString(deployment().name, location)}-test-egstmax' params: { // Required parameters - name: 'egstcom001' + name: 'egstmax001' source: '' topicType: 'Microsoft.Storage.StorageAccounts' // Non-required parameters @@ -81,7 +137,7 @@ module systemTopic 'br:bicep/modules/event-grid.system-topic:1.0.0' = { enableAdvancedFilteringOnArrays: true isSubjectCaseSensitive: false } - name: 'egstcom001' + name: 'egstmax001' retryPolicy: { eventTimeToLive: '120' maxDeliveryAttempts: 10 @@ -125,7 +181,7 @@ module systemTopic 'br:bicep/modules/event-grid.system-topic:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "egstcom001" + "value": "egstmax001" }, "source": { "value": "" @@ -171,7 +227,7 @@ module systemTopic 'br:bicep/modules/event-grid.system-topic:1.0.0' = { "enableAdvancedFilteringOnArrays": true, "isSubjectCaseSensitive": false }, - "name": "egstcom001", + "name": "egstmax001", "retryPolicy": { "eventTimeToLive": "120", "maxDeliveryAttempts": 10 @@ -213,62 +269,6 @@ module systemTopic 'br:bicep/modules/event-grid.system-topic:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module systemTopic 'br:bicep/modules/event-grid.system-topic:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-egstmin' - params: { - // Required parameters - name: 'egstmin001' - source: '' - topicType: 'Microsoft.Storage.StorageAccounts' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "egstmin001" - }, - "source": { - "value": "" - }, - "topicType": { - "value": "Microsoft.Storage.StorageAccounts" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/event-grid/topic/README.md b/modules/event-grid/topic/README.md index b030a3e3fb..8ae1c9ebdf 100644 --- a/modules/event-grid/topic/README.md +++ b/modules/event-grid/topic/README.md @@ -30,11 +30,59 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/event-grid.topic:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) - [Pe](#example-3-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module topic 'br:bicep/modules/event-grid.topic:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-egtmin' + params: { + // Required parameters + name: 'egtmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "egtmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -45,10 +93,10 @@ This instance deploys the module with most of its features enabled. ```bicep module topic 'br:bicep/modules/event-grid.topic:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-egtcom' + name: '${uniqueString(deployment().name, location)}-test-egtmax' params: { // Required parameters - name: 'egtcom001' + name: 'egtmax001' // Non-required parameters diagnosticSettings: [ { @@ -82,7 +130,7 @@ module topic 'br:bicep/modules/event-grid.topic:1.0.0' = { enableAdvancedFilteringOnArrays: true isSubjectCaseSensitive: false } - name: 'egtcom001' + name: 'egtmax001' retryPolicy: { eventTimeToLive: '120' maxDeliveryAttempts: 10 @@ -143,7 +191,7 @@ module topic 'br:bicep/modules/event-grid.topic:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "egtcom001" + "value": "egtmax001" }, // Non-required parameters "diagnosticSettings": { @@ -183,7 +231,7 @@ module topic 'br:bicep/modules/event-grid.topic:1.0.0' = { "enableAdvancedFilteringOnArrays": true, "isSubjectCaseSensitive": false }, - "name": "egtcom001", + "name": "egtmax001", "retryPolicy": { "eventTimeToLive": "120", "maxDeliveryAttempts": 10 @@ -244,54 +292,6 @@ module topic 'br:bicep/modules/event-grid.topic:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module topic 'br:bicep/modules/event-grid.topic:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-egtmin' - params: { - // Required parameters - name: 'egtmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "egtmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ### Example 3: _Pe_

diff --git a/modules/event-hub/namespace/README.md b/modules/event-hub/namespace/README.md index 6db9b87e84..11384fca9e 100644 --- a/modules/event-hub/namespace/README.md +++ b/modules/event-hub/namespace/README.md @@ -35,12 +35,155 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/event-hub.namespace:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) - [Pe](#example-4-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module namespace 'br:bicep/modules/event-hub.namespace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-ehnmin' + params: { + // Required parameters + name: 'ehnmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "ehnmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module namespace 'br:bicep/modules/event-hub.namespace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-ehnenc' + params: { + // Required parameters + name: 'ehnenc001' + // Non-required parameters + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + userAssignedIdentityResourceId: '' + } + enableDefaultTelemetry: '' + managedIdentities: { + systemAssigned: false + userAssignedResourcesIds: [ + '' + ] + } + publicNetworkAccess: 'SecuredByPerimeter' + requireInfrastructureEncryption: true + skuName: 'Premium' + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "ehnenc001" + }, + // Non-required parameters + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" + } + }, + "enableDefaultTelemetry": { + "value": "" + }, + "managedIdentities": { + "value": { + "systemAssigned": false, + "userAssignedResourcesIds": [ + "" + ] + } + }, + "publicNetworkAccess": { + "value": "SecuredByPerimeter" + }, + "requireInfrastructureEncryption": { + "value": true + }, + "skuName": { + "value": "Premium" + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -51,10 +194,10 @@ This instance deploys the module with most of its features enabled. ```bicep module namespace 'br:bicep/modules/event-hub.namespace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ehncom' + name: '${uniqueString(deployment().name, location)}-test-ehnmax' params: { // Required parameters - name: 'ehncom001' + name: 'ehnmax001' // Non-required parameters authorizationRules: [ { @@ -231,7 +374,7 @@ module namespace 'br:bicep/modules/event-hub.namespace:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "ehncom001" + "value": "ehnmax001" }, // Non-required parameters "authorizationRules": { @@ -436,149 +579,6 @@ module namespace 'br:bicep/modules/event-hub.namespace:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module namespace 'br:bicep/modules/event-hub.namespace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ehnmin' - params: { - // Required parameters - name: 'ehnmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "ehnmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Encr_ - -

- -via Bicep module - -```bicep -module namespace 'br:bicep/modules/event-hub.namespace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ehnenc' - params: { - // Required parameters - name: 'ehnenc001' - // Non-required parameters - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } - enableDefaultTelemetry: '' - managedIdentities: { - systemAssigned: false - userAssignedResourcesIds: [ - '' - ] - } - publicNetworkAccess: 'SecuredByPerimeter' - requireInfrastructureEncryption: true - skuName: 'Premium' - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "ehnenc001" - }, - // Non-required parameters - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } - }, - "enableDefaultTelemetry": { - "value": "" - }, - "managedIdentities": { - "value": { - "systemAssigned": false, - "userAssignedResourcesIds": [ - "" - ] - } - }, - "publicNetworkAccess": { - "value": "SecuredByPerimeter" - }, - "requireInfrastructureEncryption": { - "value": true - }, - "skuName": { - "value": "Premium" - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - } -} -``` - -
-

- ### Example 4: _Pe_

diff --git a/modules/health-bot/health-bot/README.md b/modules/health-bot/health-bot/README.md index 3ba7ed1140..794c1f2f31 100644 --- a/modules/health-bot/health-bot/README.md +++ b/modules/health-bot/health-bot/README.md @@ -26,10 +26,62 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/health-bot.health-bot:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module healthBot 'br:bicep/modules/health-bot.health-bot:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-hbhbmin' + params: { + // Required parameters + name: 'hbhbmin001' + sku: 'F0' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "hbhbmin001" + }, + "sku": { + "value": "F0" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +92,10 @@ This instance deploys the module with most of its features enabled. ```bicep module healthBot 'br:bicep/modules/health-bot.health-bot:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-hbhbcom' + name: '${uniqueString(deployment().name, location)}-test-hbhbmax' params: { // Required parameters - name: 'hbhbcom001' + name: 'hbhbmax001' sku: 'F0' // Non-required parameters enableDefaultTelemetry: '' @@ -86,7 +138,7 @@ module healthBot 'br:bicep/modules/health-bot.health-bot:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "hbhbcom001" + "value": "hbhbmax001" }, "sku": { "value": "F0" @@ -131,58 +183,6 @@ module healthBot 'br:bicep/modules/health-bot.health-bot:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module healthBot 'br:bicep/modules/health-bot.health-bot:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-hbhbmin' - params: { - // Required parameters - name: 'hbhbmin001' - sku: 'F0' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "hbhbmin001" - }, - "sku": { - "value": "F0" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/healthcare-apis/workspace/README.md b/modules/healthcare-apis/workspace/README.md index 3c1d11f2db..75580c51f9 100644 --- a/modules/healthcare-apis/workspace/README.md +++ b/modules/healthcare-apis/workspace/README.md @@ -32,10 +32,66 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/healthcare-apis.workspace:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = { + name: '${uniqueString(deployment().name)}-test-hawmin' + params: { + // Required parameters + name: 'hawmin001' + // Non-required parameters + enableDefaultTelemetry: '' + location: '' + publicNetworkAccess: 'Enabled' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "hawmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "location": { + "value": "" + }, + "publicNetworkAccess": { + "value": "Enabled" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -46,10 +102,10 @@ This instance deploys the module with most of its features enabled. ```bicep module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-hawcom' + name: '${uniqueString(deployment().name)}-test-hawmax' params: { // Required parameters - name: 'hawcom001' + name: 'hawmax001' // Non-required parameters dicomservices: [ { @@ -88,7 +144,7 @@ module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = { } name: 'az-dicom-x-001' publicNetworkAccess: 'Enabled' - workspaceName: 'hawcom001' + workspaceName: 'hawmax001' } ] enableDefaultTelemetry: '' @@ -141,7 +197,7 @@ module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = { } ] smartProxyEnabled: false - workspaceName: 'hawcom001' + workspaceName: 'hawmax001' } ] location: '' @@ -180,7 +236,7 @@ module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "hawcom001" + "value": "hawmax001" }, // Non-required parameters "dicomservices": { @@ -221,7 +277,7 @@ module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = { }, "name": "az-dicom-x-001", "publicNetworkAccess": "Enabled", - "workspaceName": "hawcom001" + "workspaceName": "hawmax001" } ] }, @@ -278,7 +334,7 @@ module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = { } ], "smartProxyEnabled": false, - "workspaceName": "hawcom001" + "workspaceName": "hawmax001" } ] }, @@ -317,62 +373,6 @@ module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module workspace 'br:bicep/modules/healthcare-apis.workspace:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-hawmin' - params: { - // Required parameters - name: 'hawmin001' - // Non-required parameters - enableDefaultTelemetry: '' - location: '' - publicNetworkAccess: 'Enabled' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "hawmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "location": { - "value": "" - }, - "publicNetworkAccess": { - "value": "Enabled" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/insights/action-group/README.md b/modules/insights/action-group/README.md index d54f25254b..d0edf08b29 100644 --- a/modules/insights/action-group/README.md +++ b/modules/insights/action-group/README.md @@ -28,10 +28,62 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/insights.action-group:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module actionGroup 'br:bicep/modules/insights.action-group:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-iagmin' + params: { + // Required parameters + groupShortName: 'agiagmin001' + name: 'iagmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "groupShortName": { + "value": "agiagmin001" + }, + "name": { + "value": "iagmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,11 +94,11 @@ This instance deploys the module with most of its features enabled. ```bicep module actionGroup 'br:bicep/modules/insights.action-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-iagcom' + name: '${uniqueString(deployment().name, location)}-test-iagmax' params: { // Required parameters - groupShortName: 'agiagcom001' - name: 'iagcom001' + groupShortName: 'agiagmax001' + name: 'iagmax001' // Non-required parameters emailReceivers: [ { @@ -98,10 +150,10 @@ module actionGroup 'br:bicep/modules/insights.action-group:1.0.0' = { "parameters": { // Required parameters "groupShortName": { - "value": "agiagcom001" + "value": "agiagmax001" }, "name": { - "value": "iagcom001" + "value": "iagmax001" }, // Non-required parameters "emailReceivers": { @@ -153,58 +205,6 @@ module actionGroup 'br:bicep/modules/insights.action-group:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module actionGroup 'br:bicep/modules/insights.action-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-iagmin' - params: { - // Required parameters - groupShortName: 'agiagmin001' - name: 'iagmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "groupShortName": { - "value": "agiagmin001" - }, - "name": { - "value": "iagmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/insights/activity-log-alert/README.md b/modules/insights/activity-log-alert/README.md index 7ea6985434..5af0e285e5 100644 --- a/modules/insights/activity-log-alert/README.md +++ b/modules/insights/activity-log-alert/README.md @@ -38,7 +38,7 @@ This instance deploys the module with most of its features enabled. ```bicep module activityLogAlert 'br:bicep/modules/insights.activity-log-alert:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ialacom' + name: '${uniqueString(deployment().name, location)}-test-ialamax' params: { // Required parameters conditions: [ @@ -73,7 +73,7 @@ module activityLogAlert 'br:bicep/modules/insights.activity-log-alert:1.0.0' = { field: 'properties.impactedServices[*].ImpactedRegions[*].RegionName' } ] - name: 'ialacom001' + name: 'ialamax001' // Non-required parameters actions: [ { @@ -148,7 +148,7 @@ module activityLogAlert 'br:bicep/modules/insights.activity-log-alert:1.0.0' = { ] }, "name": { - "value": "ialacom001" + "value": "ialamax001" }, // Non-required parameters "actions": { diff --git a/modules/insights/component/README.md b/modules/insights/component/README.md index e0aa1d9ff6..7bbf106053 100644 --- a/modules/insights/component/README.md +++ b/modules/insights/component/README.md @@ -26,10 +26,62 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/insights.component:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module component 'br:bicep/modules/insights.component:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-icmin' + params: { + // Required parameters + name: 'icmin001' + workspaceResourceId: '' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "icmin001" + }, + "workspaceResourceId": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +92,10 @@ This instance deploys the module with most of its features enabled. ```bicep module component 'br:bicep/modules/insights.component:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-iccom' + name: '${uniqueString(deployment().name, location)}-test-icmax' params: { // Required parameters - name: 'iccom001' + name: 'icmax001' workspaceResourceId: '' // Non-required parameters diagnosticSettings: [ @@ -91,7 +143,7 @@ module component 'br:bicep/modules/insights.component:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "iccom001" + "value": "icmax001" }, "workspaceResourceId": { "value": "" @@ -139,58 +191,6 @@ module component 'br:bicep/modules/insights.component:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module component 'br:bicep/modules/insights.component:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-icmin' - params: { - // Required parameters - name: 'icmin001' - workspaceResourceId: '' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "icmin001" - }, - "workspaceResourceId": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/insights/data-collection-endpoint/README.md b/modules/insights/data-collection-endpoint/README.md index d7c991c56c..9713158d2b 100644 --- a/modules/insights/data-collection-endpoint/README.md +++ b/modules/insights/data-collection-endpoint/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/insights.data-collection-endpoint:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module dataCollectionEndpoint 'br:bicep/modules/insights.data-collection-endpoint:1.0.0' = { + name: '${uniqueString(deployment().name)}-test-idcemin' + params: { + // Required parameters + name: 'idcemin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "idcemin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module dataCollectionEndpoint 'br:bicep/modules/insights.data-collection-endpoint:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-idcecom' + name: '${uniqueString(deployment().name)}-test-idcemax' params: { // Required parameters - name: 'idcecom001' + name: 'idcemax001' // Non-required parameters enableDefaultTelemetry: '' kind: 'Windows' @@ -82,7 +130,7 @@ module dataCollectionEndpoint 'br:bicep/modules/insights.data-collection-endpoin "parameters": { // Required parameters "name": { - "value": "idcecom001" + "value": "idcemax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -123,54 +171,6 @@ module dataCollectionEndpoint 'br:bicep/modules/insights.data-collection-endpoin

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module dataCollectionEndpoint 'br:bicep/modules/insights.data-collection-endpoint:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-idcemin' - params: { - // Required parameters - name: 'idcemin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "idcemin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/insights/diagnostic-setting/README.md b/modules/insights/diagnostic-setting/README.md index 7ef93aebbb..a0353d69b1 100644 --- a/modules/insights/diagnostic-setting/README.md +++ b/modules/insights/diagnostic-setting/README.md @@ -37,7 +37,7 @@ This instance deploys the module with most of its features enabled. ```bicep module diagnosticSetting 'br:bicep/modules/insights.diagnostic-setting:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-idscom' + name: '${uniqueString(deployment().name, location)}-test-idsmax' params: { enableDefaultTelemetry: '' eventHubAuthorizationRuleResourceId: '' @@ -47,7 +47,7 @@ module diagnosticSetting 'br:bicep/modules/insights.diagnostic-setting:1.0.0' = category: 'AllMetrics' } ] - name: 'idscom001' + name: 'idsmax001' storageAccountResourceId: '' workspaceResourceId: '' } @@ -83,7 +83,7 @@ module diagnosticSetting 'br:bicep/modules/insights.diagnostic-setting:1.0.0' = ] }, "name": { - "value": "idscom001" + "value": "idsmax001" }, "storageAccountResourceId": { "value": "" diff --git a/modules/insights/metric-alert/README.md b/modules/insights/metric-alert/README.md index 3ad1b77aac..a213c126aa 100644 --- a/modules/insights/metric-alert/README.md +++ b/modules/insights/metric-alert/README.md @@ -38,7 +38,7 @@ This instance deploys the module with most of its features enabled. ```bicep module metricAlert 'br:bicep/modules/insights.metric-alert:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-imacom' + name: '${uniqueString(deployment().name, location)}-test-imamax' params: { // Required parameters criterias: [ @@ -52,7 +52,7 @@ module metricAlert 'br:bicep/modules/insights.metric-alert:1.0.0' = { timeAggregation: 'Average' } ] - name: 'imacom001' + name: 'imamax001' // Non-required parameters actions: [ '' @@ -105,7 +105,7 @@ module metricAlert 'br:bicep/modules/insights.metric-alert:1.0.0' = { ] }, "name": { - "value": "imacom001" + "value": "imamax001" }, // Non-required parameters "actions": { diff --git a/modules/insights/private-link-scope/README.md b/modules/insights/private-link-scope/README.md index 1b6bf1ad3b..57e6b05caa 100644 --- a/modules/insights/private-link-scope/README.md +++ b/modules/insights/private-link-scope/README.md @@ -29,10 +29,57 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/insights.private-link-scope:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep + name: '${uniqueString(deployment().name, location)}-test-iplsmin' + params: { + // Required parameters + name: 'iplsmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "iplsmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,10 +89,10 @@ This instance deploys the module with most of its features enabled.

via Bicep module ```bicep - name: '${uniqueString(deployment().name, location)}-test-iplscom' + name: '${uniqueString(deployment().name, location)}-test-iplsmax' params: { // Required parameters - name: 'iplscom001' + name: 'iplsmax001' // Non-required parameters enableDefaultTelemetry: '' privateEndpoints: [ @@ -97,7 +144,7 @@ This instance deploys the module with most of its features enabled. "parameters": { // Required parameters "name": { - "value": "iplscom001" + "value": "iplsmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -149,53 +196,6 @@ This instance deploys the module with most of its features enabled.

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep - name: '${uniqueString(deployment().name, location)}-test-iplsmin' - params: { - // Required parameters - name: 'iplsmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "iplsmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/insights/scheduled-query-rule/README.md b/modules/insights/scheduled-query-rule/README.md index f81174bdb5..b84ede93c0 100644 --- a/modules/insights/scheduled-query-rule/README.md +++ b/modules/insights/scheduled-query-rule/README.md @@ -38,7 +38,7 @@ This instance deploys the module with most of its features enabled. ```bicep module scheduledQueryRule 'br:bicep/modules/insights.scheduled-query-rule:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-isqrcom' + name: '${uniqueString(deployment().name, location)}-test-isqrmax' params: { // Required parameters criterias: { @@ -68,7 +68,7 @@ module scheduledQueryRule 'br:bicep/modules/insights.scheduled-query-rule:1.0.0' } ] } - name: 'isqrcom001' + name: 'isqrmax001' scopes: [ '' ] @@ -139,7 +139,7 @@ module scheduledQueryRule 'br:bicep/modules/insights.scheduled-query-rule:1.0.0' } }, "name": { - "value": "isqrcom001" + "value": "isqrmax001" }, "scopes": { "value": [ diff --git a/modules/insights/webtest/README.md b/modules/insights/webtest/README.md index 9c53d80ad2..9d2e805c8a 100644 --- a/modules/insights/webtest/README.md +++ b/modules/insights/webtest/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/insights.webtest:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -40,10 +40,10 @@ This instance deploys the module with most of its features enabled. ```bicep module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-iwtcom' + name: '${uniqueString(deployment().name, location)}-test-iwtmin' params: { // Required parameters - name: 'iwtcom001' + name: 'iwtmin001' request: { HttpVerb: 'GET' RequestUrl: 'https://learn.microsoft.com/en-us/' @@ -52,19 +52,9 @@ module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { 'hidden-link:${nestedDependencies.outputs.appInsightResourceId}': 'Resource' 'hidden-title': 'This is visible in the resource name' } - webTestName: 'wt$iwtcom001' + webTestName: 'wt$iwtmin001' // Non-required parameters enableDefaultTelemetry: '' - locations: [ - { - Id: 'emea-nl-ams-azr' - } - ] - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - syntheticMonitorId: 'iwtcom001' } } ``` @@ -83,7 +73,7 @@ module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "iwtcom001" + "value": "iwtmin001" }, "request": { "value": { @@ -98,27 +88,11 @@ module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { } }, "webTestName": { - "value": "wt$iwtcom001" + "value": "wt$iwtmin001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "locations": { - "value": [ - { - "Id": "emea-nl-ams-azr" - } - ] - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "syntheticMonitorId": { - "value": "iwtcom001" } } } @@ -127,9 +101,9 @@ module webtest 'br:bicep/modules/insights.webtest:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -138,10 +112,10 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-iwtmin' + name: '${uniqueString(deployment().name, location)}-test-iwtmax' params: { // Required parameters - name: 'iwtmin001' + name: 'iwtmax001' request: { HttpVerb: 'GET' RequestUrl: 'https://learn.microsoft.com/en-us/' @@ -150,9 +124,19 @@ module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { 'hidden-link:${nestedDependencies.outputs.appInsightResourceId}': 'Resource' 'hidden-title': 'This is visible in the resource name' } - webTestName: 'wt$iwtmin001' + webTestName: 'wt$iwtmax001' // Non-required parameters enableDefaultTelemetry: '' + locations: [ + { + Id: 'emea-nl-ams-azr' + } + ] + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + syntheticMonitorId: 'iwtmax001' } } ``` @@ -171,7 +155,7 @@ module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "iwtmin001" + "value": "iwtmax001" }, "request": { "value": { @@ -186,11 +170,27 @@ module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { } }, "webTestName": { - "value": "wt$iwtmin001" + "value": "wt$iwtmax001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "locations": { + "value": [ + { + "Id": "emea-nl-ams-azr" + } + ] + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "syntheticMonitorId": { + "value": "iwtmax001" } } } diff --git a/modules/key-vault/vault/README.md b/modules/key-vault/vault/README.md index 86286a9daa..2072456778 100644 --- a/modules/key-vault/vault/README.md +++ b/modules/key-vault/vault/README.md @@ -35,8 +35,8 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/key-vault.vault:1.0.0`. - [Accesspolicies](#example-1-accesspolicies) -- [Using large parameter set](#example-2-using-large-parameter-set) -- [Using only defaults](#example-3-using-only-defaults) +- [Using only defaults](#example-2-using-only-defaults) +- [Using large parameter set](#example-3-using-large-parameter-set) - [Pe](#example-4-pe) ### Example 1: _Accesspolicies_ @@ -226,7 +226,59 @@ module vault 'br:bicep/modules/key-vault.vault:1.0.0' = {

-### Example 2: _Using large parameter set_ +### Example 2: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module vault 'br:bicep/modules/key-vault.vault:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-kvvmin' + params: { + // Required parameters + name: 'kvvmin002' + // Non-required parameters + enableDefaultTelemetry: '' + enablePurgeProtection: false + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "kvvmin002" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "enablePurgeProtection": { + "value": false + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -237,10 +289,10 @@ This instance deploys the module with most of its features enabled. ```bicep module vault 'br:bicep/modules/key-vault.vault:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-kvvcom' + name: '${uniqueString(deployment().name, location)}-test-kvvmax' params: { // Required parameters - name: 'kvvcom002' + name: 'kvvmax002' // Non-required parameters diagnosticSettings: [ { @@ -377,7 +429,7 @@ module vault 'br:bicep/modules/key-vault.vault:1.0.0' = { "contentVersion": "1.0.0.0", "parameters": { "name": { - "value": "kvvcom002" + "value": "kvvmax002" }, "diagnosticSettings": { "value": [ @@ -528,58 +580,6 @@ module vault 'br:bicep/modules/key-vault.vault:1.0.0' = {

-### Example 3: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module vault 'br:bicep/modules/key-vault.vault:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-kvvmin' - params: { - // Required parameters - name: 'kvvmin002' - // Non-required parameters - enableDefaultTelemetry: '' - enablePurgeProtection: false - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "kvvmin002" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "enablePurgeProtection": { - "value": false - } - } -} -``` - -
-

- ### Example 4: _Pe_

diff --git a/modules/kubernetes-configuration/extension/README.md b/modules/kubernetes-configuration/extension/README.md index 31bd67803a..34c51d8bc7 100644 --- a/modules/kubernetes-configuration/extension/README.md +++ b/modules/kubernetes-configuration/extension/README.md @@ -27,12 +27,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/kubernetes-configuration.extension:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -41,38 +41,16 @@ This instance deploys the module with most of its features enabled. ```bicep module extension 'br:bicep/modules/kubernetes-configuration.extension:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-kcecom' + name: '${uniqueString(deployment().name, location)}-test-kcemin' params: { // Required parameters clusterName: '' extensionType: 'microsoft.flux' - name: 'kcecom001' + name: 'kcemin001' // Non-required parameters - configurationSettings: { - 'image-automation-controller.enabled': 'false' - 'image-reflector-controller.enabled': 'false' - 'kustomize-controller.enabled': 'true' - 'notification-controller.enabled': 'false' - 'source-controller.enabled': 'true' - } enableDefaultTelemetry: '' - fluxConfigurations: [ - { - gitRepository: { - repositoryRef: { - branch: 'main' - } - sshKnownHosts: '' - syncIntervalInSeconds: 300 - timeoutInSeconds: 180 - url: 'https://github.com/mspnp/aks-baseline' - } - namespace: 'flux-system' - } - ] releaseNamespace: 'flux-system' releaseTrain: 'Stable' - version: '0.5.2' } } ``` @@ -97,45 +75,17 @@ module extension 'br:bicep/modules/kubernetes-configuration.extension:1.0.0' = { "value": "microsoft.flux" }, "name": { - "value": "kcecom001" + "value": "kcemin001" }, // Non-required parameters - "configurationSettings": { - "value": { - "image-automation-controller.enabled": "false", - "image-reflector-controller.enabled": "false", - "kustomize-controller.enabled": "true", - "notification-controller.enabled": "false", - "source-controller.enabled": "true" - } - }, "enableDefaultTelemetry": { "value": "" }, - "fluxConfigurations": { - "value": [ - { - "gitRepository": { - "repositoryRef": { - "branch": "main" - }, - "sshKnownHosts": "", - "syncIntervalInSeconds": 300, - "timeoutInSeconds": 180, - "url": "https://github.com/mspnp/aks-baseline" - }, - "namespace": "flux-system" - } - ] - }, "releaseNamespace": { "value": "flux-system" }, "releaseTrain": { "value": "Stable" - }, - "version": { - "value": "0.5.2" } } } @@ -144,9 +94,9 @@ module extension 'br:bicep/modules/kubernetes-configuration.extension:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -155,16 +105,38 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module extension 'br:bicep/modules/kubernetes-configuration.extension:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-kcemin' + name: '${uniqueString(deployment().name, location)}-test-kcemax' params: { // Required parameters clusterName: '' extensionType: 'microsoft.flux' - name: 'kcemin001' + name: 'kcemax001' // Non-required parameters + configurationSettings: { + 'image-automation-controller.enabled': 'false' + 'image-reflector-controller.enabled': 'false' + 'kustomize-controller.enabled': 'true' + 'notification-controller.enabled': 'false' + 'source-controller.enabled': 'true' + } enableDefaultTelemetry: '' + fluxConfigurations: [ + { + gitRepository: { + repositoryRef: { + branch: 'main' + } + sshKnownHosts: '' + syncIntervalInSeconds: 300 + timeoutInSeconds: 180 + url: 'https://github.com/mspnp/aks-baseline' + } + namespace: 'flux-system' + } + ] releaseNamespace: 'flux-system' releaseTrain: 'Stable' + version: '0.5.2' } } ``` @@ -189,17 +161,45 @@ module extension 'br:bicep/modules/kubernetes-configuration.extension:1.0.0' = { "value": "microsoft.flux" }, "name": { - "value": "kcemin001" + "value": "kcemax001" }, // Non-required parameters + "configurationSettings": { + "value": { + "image-automation-controller.enabled": "false", + "image-reflector-controller.enabled": "false", + "kustomize-controller.enabled": "true", + "notification-controller.enabled": "false", + "source-controller.enabled": "true" + } + }, "enableDefaultTelemetry": { "value": "" }, + "fluxConfigurations": { + "value": [ + { + "gitRepository": { + "repositoryRef": { + "branch": "main" + }, + "sshKnownHosts": "", + "syncIntervalInSeconds": 300, + "timeoutInSeconds": 180, + "url": "https://github.com/mspnp/aks-baseline" + }, + "namespace": "flux-system" + } + ] + }, "releaseNamespace": { "value": "flux-system" }, "releaseTrain": { "value": "Stable" + }, + "version": { + "value": "0.5.2" } } } diff --git a/modules/kubernetes-configuration/flux-configuration/README.md b/modules/kubernetes-configuration/flux-configuration/README.md index ac523aecce..22030b57cc 100644 --- a/modules/kubernetes-configuration/flux-configuration/README.md +++ b/modules/kubernetes-configuration/flux-configuration/README.md @@ -27,12 +27,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/kubernetes-configuration.flux-configuration:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -41,11 +41,11 @@ This instance deploys the module with most of its features enabled. ```bicep module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configuration:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-kcfccom' + name: '${uniqueString(deployment().name, location)}-test-kcfcmin' params: { // Required parameters clusterName: '' - name: 'kcfccom001' + name: 'kcfcmin001' namespace: 'flux-system' sourceKind: 'GitRepository' // Non-required parameters @@ -59,16 +59,6 @@ module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configu timeoutInSeconds: 180 url: 'https://github.com/mspnp/aks-baseline' } - kustomizations: { - unified: { - dependsOn: [] - force: false - path: './cluster-manifests' - prune: true - syncIntervalInSeconds: 300 - timeoutInSeconds: 300 - } - } } } ``` @@ -90,7 +80,7 @@ module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configu "value": "" }, "name": { - "value": "kcfccom001" + "value": "kcfcmin001" }, "namespace": { "value": "flux-system" @@ -112,18 +102,6 @@ module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configu "timeoutInSeconds": 180, "url": "https://github.com/mspnp/aks-baseline" } - }, - "kustomizations": { - "value": { - "unified": { - "dependsOn": [], - "force": false, - "path": "./cluster-manifests", - "prune": true, - "syncIntervalInSeconds": 300, - "timeoutInSeconds": 300 - } - } } } } @@ -132,9 +110,9 @@ module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configu

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -143,11 +121,11 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configuration:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-kcfcmin' + name: '${uniqueString(deployment().name, location)}-test-kcfcmax' params: { // Required parameters clusterName: '' - name: 'kcfcmin001' + name: 'kcfcmax001' namespace: 'flux-system' sourceKind: 'GitRepository' // Non-required parameters @@ -161,6 +139,16 @@ module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configu timeoutInSeconds: 180 url: 'https://github.com/mspnp/aks-baseline' } + kustomizations: { + unified: { + dependsOn: [] + force: false + path: './cluster-manifests' + prune: true + syncIntervalInSeconds: 300 + timeoutInSeconds: 300 + } + } } } ``` @@ -182,7 +170,7 @@ module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configu "value": "" }, "name": { - "value": "kcfcmin001" + "value": "kcfcmax001" }, "namespace": { "value": "flux-system" @@ -204,6 +192,18 @@ module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configu "timeoutInSeconds": 180, "url": "https://github.com/mspnp/aks-baseline" } + }, + "kustomizations": { + "value": { + "unified": { + "dependsOn": [], + "force": false, + "path": "./cluster-manifests", + "prune": true, + "syncIntervalInSeconds": 300, + "timeoutInSeconds": 300 + } + } } } } diff --git a/modules/logic/workflow/README.md b/modules/logic/workflow/README.md index b60f3509e9..ab3cbde145 100644 --- a/modules/logic/workflow/README.md +++ b/modules/logic/workflow/README.md @@ -41,10 +41,10 @@ This instance deploys the module with most of its features enabled. ```bicep module workflow 'br:bicep/modules/logic.workflow:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-lwcom' + name: '${uniqueString(deployment().name, location)}-test-lwmax' params: { // Required parameters - name: 'lwcom001' + name: 'lwmax001' // Non-required parameters diagnosticSettings: [ { @@ -131,7 +131,7 @@ module workflow 'br:bicep/modules/logic.workflow:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "lwcom001" + "value": "lwmax001" }, // Non-required parameters "diagnosticSettings": { diff --git a/modules/machine-learning-services/workspace/README.md b/modules/machine-learning-services/workspace/README.md index 614646f1ef..e40a7da849 100644 --- a/modules/machine-learning-services/workspace/README.md +++ b/modules/machine-learning-services/workspace/README.md @@ -31,11 +31,216 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/machine-learning-services.workspace:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module workspace 'br:bicep/modules/machine-learning-services.workspace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-mlswmin' + params: { + // Required parameters + associatedApplicationInsightsResourceId: '' + associatedKeyVaultResourceId: '' + associatedStorageAccountResourceId: '' + name: 'mlswmin001' + sku: 'Basic' + // Non-required parameters + enableDefaultTelemetry: '' + managedIdentities: { + systemAssigned: true + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "associatedApplicationInsightsResourceId": { + "value": "" + }, + "associatedKeyVaultResourceId": { + "value": "" + }, + "associatedStorageAccountResourceId": { + "value": "" + }, + "name": { + "value": "mlswmin001" + }, + "sku": { + "value": "Basic" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "managedIdentities": { + "value": { + "systemAssigned": true + } + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module workspace 'br:bicep/modules/machine-learning-services.workspace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-mlswecr' + params: { + // Required parameters + associatedApplicationInsightsResourceId: '' + associatedKeyVaultResourceId: '' + associatedStorageAccountResourceId: '' + name: 'mlswecr001' + sku: 'Basic' + // Non-required parameters + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + userAssignedIdentityResourceId: '' + } + enableDefaultTelemetry: '' + managedIdentities: { + systemAssigned: false + userAssignedResourcesIds: [ + '' + ] + } + primaryUserAssignedIdentity: '' + privateEndpoints: [ + { + privateDnsZoneResourceIds: [ + '' + ] + service: 'amlworkspace' + subnetResourceId: '' + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "associatedApplicationInsightsResourceId": { + "value": "" + }, + "associatedKeyVaultResourceId": { + "value": "" + }, + "associatedStorageAccountResourceId": { + "value": "" + }, + "name": { + "value": "mlswecr001" + }, + "sku": { + "value": "Basic" + }, + // Non-required parameters + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" + } + }, + "enableDefaultTelemetry": { + "value": "" + }, + "managedIdentities": { + "value": { + "systemAssigned": false, + "userAssignedResourcesIds": [ + "" + ] + } + }, + "primaryUserAssignedIdentity": { + "value": "" + }, + "privateEndpoints": { + "value": [ + { + "privateDnsZoneResourceIds": [ + "" + ], + "service": "amlworkspace", + "subnetResourceId": "", + "tags": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -46,13 +251,13 @@ This instance deploys the module with most of its features enabled. ```bicep module workspace 'br:bicep/modules/machine-learning-services.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-mlswcom' + name: '${uniqueString(deployment().name, location)}-test-mlswmax' params: { // Required parameters associatedApplicationInsightsResourceId: '' associatedKeyVaultResourceId: '' associatedStorageAccountResourceId: '' - name: 'mlswcom001' + name: 'mlswmax001' sku: 'Premium' // Non-required parameters computes: [ @@ -166,7 +371,7 @@ module workspace 'br:bicep/modules/machine-learning-services.workspace:1.0.0' = "value": "" }, "name": { - "value": "mlswcom001" + "value": "mlswmax001" }, "sku": { "value": "Premium" @@ -287,211 +492,6 @@ module workspace 'br:bicep/modules/machine-learning-services.workspace:1.0.0' =

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module workspace 'br:bicep/modules/machine-learning-services.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-mlswmin' - params: { - // Required parameters - associatedApplicationInsightsResourceId: '' - associatedKeyVaultResourceId: '' - associatedStorageAccountResourceId: '' - name: 'mlswmin001' - sku: 'Basic' - // Non-required parameters - enableDefaultTelemetry: '' - managedIdentities: { - systemAssigned: true - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "associatedApplicationInsightsResourceId": { - "value": "" - }, - "associatedKeyVaultResourceId": { - "value": "" - }, - "associatedStorageAccountResourceId": { - "value": "" - }, - "name": { - "value": "mlswmin001" - }, - "sku": { - "value": "Basic" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "managedIdentities": { - "value": { - "systemAssigned": true - } - } - } -} -``` - -
-

- -### Example 3: _Encr_ - -

- -via Bicep module - -```bicep -module workspace 'br:bicep/modules/machine-learning-services.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-mlswecr' - params: { - // Required parameters - associatedApplicationInsightsResourceId: '' - associatedKeyVaultResourceId: '' - associatedStorageAccountResourceId: '' - name: 'mlswecr001' - sku: 'Basic' - // Non-required parameters - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } - enableDefaultTelemetry: '' - managedIdentities: { - systemAssigned: false - userAssignedResourcesIds: [ - '' - ] - } - primaryUserAssignedIdentity: '' - privateEndpoints: [ - { - privateDnsZoneResourceIds: [ - '' - ] - service: 'amlworkspace' - subnetResourceId: '' - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "associatedApplicationInsightsResourceId": { - "value": "" - }, - "associatedKeyVaultResourceId": { - "value": "" - }, - "associatedStorageAccountResourceId": { - "value": "" - }, - "name": { - "value": "mlswecr001" - }, - "sku": { - "value": "Basic" - }, - // Non-required parameters - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } - }, - "enableDefaultTelemetry": { - "value": "" - }, - "managedIdentities": { - "value": { - "systemAssigned": false, - "userAssignedResourcesIds": [ - "" - ] - } - }, - "primaryUserAssignedIdentity": { - "value": "" - }, - "privateEndpoints": { - "value": [ - { - "privateDnsZoneResourceIds": [ - "" - ], - "service": "amlworkspace", - "subnetResourceId": "", - "tags": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/maintenance/maintenance-configuration/README.md b/modules/maintenance/maintenance-configuration/README.md index ddce26921e..187dac5dc9 100644 --- a/modules/maintenance/maintenance-configuration/README.md +++ b/modules/maintenance/maintenance-configuration/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/maintenance.maintenance-configuration:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module maintenanceConfiguration 'br:bicep/modules/maintenance.maintenance-configuration:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-mmcmin' + params: { + // Required parameters + name: 'mmcmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "mmcmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module maintenanceConfiguration 'br:bicep/modules/maintenance.maintenance-configuration:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-mmccom' + name: '${uniqueString(deployment().name, location)}-test-mmcmax' params: { // Required parameters - name: 'mmccom001' + name: 'mmcmax001' // Non-required parameters enableDefaultTelemetry: '' extensionProperties: { @@ -76,7 +124,7 @@ module maintenanceConfiguration 'br:bicep/modules/maintenance.maintenance-config startDateTime: '2022-12-31 13:00' timeZone: 'W. Europe Standard Time' } - namespace: 'mmccomns' + namespace: 'mmcmaxns' roleAssignments: [ { principalId: '' @@ -108,7 +156,7 @@ module maintenanceConfiguration 'br:bicep/modules/maintenance.maintenance-config "parameters": { // Required parameters "name": { - "value": "mmccom001" + "value": "mmcmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -153,7 +201,7 @@ module maintenanceConfiguration 'br:bicep/modules/maintenance.maintenance-config } }, "namespace": { - "value": "mmccomns" + "value": "mmcmaxns" }, "roleAssignments": { "value": [ @@ -181,54 +229,6 @@ module maintenanceConfiguration 'br:bicep/modules/maintenance.maintenance-config

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module maintenanceConfiguration 'br:bicep/modules/maintenance.maintenance-configuration:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-mmcmin' - params: { - // Required parameters - name: 'mmcmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "mmcmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/managed-identity/user-assigned-identity/README.md b/modules/managed-identity/user-assigned-identity/README.md index c2fdf977aa..d76e767ebe 100644 --- a/modules/managed-identity/user-assigned-identity/README.md +++ b/modules/managed-identity/user-assigned-identity/README.md @@ -27,10 +27,50 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/managed-identity.user-assigned-identity:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module userAssignedIdentity 'br:bicep/modules/managed-identity.user-assigned-identity:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-miuaimin' + params: { + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -41,7 +81,7 @@ This instance deploys the module with most of its features enabled. ```bicep module userAssignedIdentity 'br:bicep/modules/managed-identity.user-assigned-identity:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-miuaicom' + name: '${uniqueString(deployment().name, location)}-test-miuaimax' params: { enableDefaultTelemetry: '' federatedIdentityCredentials: [ @@ -50,7 +90,7 @@ module userAssignedIdentity 'br:bicep/modules/managed-identity.user-assigned-ide 'api://AzureADTokenExchange' ] issuer: '' - name: 'test-fed-cred-miuaicom-001' + name: 'test-fed-cred-miuaimax-001' subject: 'system:serviceaccount:default:workload-identity-sa' } ] @@ -58,7 +98,7 @@ module userAssignedIdentity 'br:bicep/modules/managed-identity.user-assigned-ide kind: 'CanNotDelete' name: 'myCustomLockName' } - name: 'miuaicom001' + name: 'miuaimax001' roleAssignments: [ { principalId: '' @@ -97,7 +137,7 @@ module userAssignedIdentity 'br:bicep/modules/managed-identity.user-assigned-ide "api://AzureADTokenExchange" ], "issuer": "", - "name": "test-fed-cred-miuaicom-001", + "name": "test-fed-cred-miuaimax-001", "subject": "system:serviceaccount:default:workload-identity-sa" } ] @@ -109,7 +149,7 @@ module userAssignedIdentity 'br:bicep/modules/managed-identity.user-assigned-ide } }, "name": { - "value": "miuaicom001" + "value": "miuaimax001" }, "roleAssignments": { "value": [ @@ -134,46 +174,6 @@ module userAssignedIdentity 'br:bicep/modules/managed-identity.user-assigned-ide

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module userAssignedIdentity 'br:bicep/modules/managed-identity.user-assigned-identity:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-miuaimin' - params: { - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/managed-services/registration-definition/README.md b/modules/managed-services/registration-definition/README.md index 23aac725b0..472774ac03 100644 --- a/modules/managed-services/registration-definition/README.md +++ b/modules/managed-services/registration-definition/README.md @@ -44,7 +44,7 @@ This instance deploys the module with most of its features enabled. ```bicep module registrationDefinition 'br:bicep/modules/managed-services.registration-definition:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-msrdcom' + name: '${uniqueString(deployment().name)}-test-msrdmax' params: { // Required parameters authorizations: [ @@ -65,7 +65,7 @@ module registrationDefinition 'br:bicep/modules/managed-services.registration-de } ] managedByTenantId: '<< SET YOUR TENANT ID HERE >>' - name: 'Component Validation - msrdcom Subscription assignment' + name: 'Component Validation - msrdmax Subscription assignment' registrationDescription: 'Managed by Lighthouse' // Non-required parameters enableDefaultTelemetry: '' @@ -109,7 +109,7 @@ module registrationDefinition 'br:bicep/modules/managed-services.registration-de "value": "<< SET YOUR TENANT ID HERE >>" }, "name": { - "value": "Component Validation - msrdcom Subscription assignment" + "value": "Component Validation - msrdmax Subscription assignment" }, "registrationDescription": { "value": "Managed by Lighthouse" diff --git a/modules/management/management-group/README.md b/modules/management/management-group/README.md index cba016ed6e..38c1b4d408 100644 --- a/modules/management/management-group/README.md +++ b/modules/management/management-group/README.md @@ -29,12 +29,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/management.management-group:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -43,14 +43,12 @@ This instance deploys the module with most of its features enabled. ```bicep module managementGroup 'br:bicep/modules/management.management-group:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-mmgcom' + name: '${uniqueString(deployment().name)}-test-mmgmin' params: { // Required parameters - name: 'mmgcom001' + name: 'mmgmin001' // Non-required parameters - displayName: 'Test MG' enableDefaultTelemetry: '' - parentId: '' } } ``` @@ -69,17 +67,11 @@ module managementGroup 'br:bicep/modules/management.management-group:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "mmgcom001" + "value": "mmgmin001" }, // Non-required parameters - "displayName": { - "value": "Test MG" - }, "enableDefaultTelemetry": { "value": "" - }, - "parentId": { - "value": "" } } } @@ -88,9 +80,9 @@ module managementGroup 'br:bicep/modules/management.management-group:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -99,12 +91,14 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module managementGroup 'br:bicep/modules/management.management-group:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-mmgmin' + name: '${uniqueString(deployment().name)}-test-mmgmax' params: { // Required parameters - name: 'mmgmin001' + name: 'mmgmax001' // Non-required parameters + displayName: 'Test MG' enableDefaultTelemetry: '' + parentId: '' } } ``` @@ -123,11 +117,17 @@ module managementGroup 'br:bicep/modules/management.management-group:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "mmgmin001" + "value": "mmgmax001" }, // Non-required parameters + "displayName": { + "value": "Test MG" + }, "enableDefaultTelemetry": { "value": "" + }, + "parentId": { + "value": "" } } } diff --git a/modules/network/application-gateway-web-application-firewall-policy/README.md b/modules/network/application-gateway-web-application-firewall-policy/README.md index 5aedf8a85a..feb78de452 100644 --- a/modules/network/application-gateway-web-application-firewall-policy/README.md +++ b/modules/network/application-gateway-web-application-firewall-policy/README.md @@ -37,10 +37,10 @@ This instance deploys the module with most of its features enabled. ```bicep module applicationGatewayWebApplicationFirewallPolicy 'br:bicep/modules/network.application-gateway-web-application-firewall-policy:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nagwafpcom' + name: '${uniqueString(deployment().name, location)}-test-nagwafpmax' params: { // Required parameters - name: 'nagwafpcom001' + name: 'nagwafpmax001' // Non-required parameters enableDefaultTelemetry: '' managedRules: { @@ -85,7 +85,7 @@ module applicationGatewayWebApplicationFirewallPolicy 'br:bicep/modules/network. "parameters": { // Required parameters "name": { - "value": "nagwafpcom001" + "value": "nagwafpmax001" }, // Non-required parameters "enableDefaultTelemetry": { diff --git a/modules/network/application-gateway/README.md b/modules/network/application-gateway/README.md index 537f6059d0..853769d2f6 100644 --- a/modules/network/application-gateway/README.md +++ b/modules/network/application-gateway/README.md @@ -42,7 +42,7 @@ This instance deploys the module with most of its features enabled. ```bicep module applicationGateway 'br:bicep/modules/network.application-gateway:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nagcom' + name: '${uniqueString(deployment().name, location)}-test-nagmax' params: { // Required parameters name: '' diff --git a/modules/network/application-security-group/README.md b/modules/network/application-security-group/README.md index ad28b030eb..37e573fa66 100644 --- a/modules/network/application-security-group/README.md +++ b/modules/network/application-security-group/README.md @@ -39,10 +39,10 @@ This instance deploys the module with most of its features enabled. ```bicep module applicationSecurityGroup 'br:bicep/modules/network.application-security-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nasgcom' + name: '${uniqueString(deployment().name, location)}-test-nasgmax' params: { // Required parameters - name: 'nasgcom001' + name: 'nasgmax001' // Non-required parameters enableDefaultTelemetry: '' lock: { @@ -79,7 +79,7 @@ module applicationSecurityGroup 'br:bicep/modules/network.application-security-g "parameters": { // Required parameters "name": { - "value": "nasgcom001" + "value": "nasgmax001" }, // Non-required parameters "enableDefaultTelemetry": { diff --git a/modules/network/azure-firewall/README.md b/modules/network/azure-firewall/README.md index f5d0409b80..2f41e39161 100644 --- a/modules/network/azure-firewall/README.md +++ b/modules/network/azure-firewall/README.md @@ -29,11 +29,11 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.azure-firewall:1.0.0`. - [Addpip](#example-1-addpip) -- [Using large parameter set](#example-2-using-large-parameter-set) -- [Custompip](#example-3-custompip) -- [Using only defaults](#example-4-using-only-defaults) -- [Hubcommon](#example-5-hubcommon) -- [Hubmin](#example-6-hubmin) +- [Custompip](#example-2-custompip) +- [Using only defaults](#example-3-using-only-defaults) +- [Hubcommon](#example-4-hubcommon) +- [Hubmin](#example-5-hubmin) +- [Using large parameter set](#example-6-using-large-parameter-set) ### Example 1: _Addpip_ @@ -136,10 +136,7 @@ module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = {

-### Example 2: _Using large parameter set_ - -This instance deploys the module with most of its features enabled. - +### Example 2: _Custompip_

@@ -147,130 +144,46 @@ This instance deploys the module with most of its features enabled. ```bicep module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nafcom' + name: '${uniqueString(deployment().name, location)}-test-nafcstpip' params: { // Required parameters - name: 'nafcom001' + name: 'nafcstpip001' // Non-required parameters - applicationRuleCollections: [ - { - name: 'allow-app-rules' - properties: { - action: { - type: 'allow' - } - priority: 100 - rules: [ - { - fqdnTags: [ - 'AppServiceEnvironment' - 'WindowsUpdate' - ] - name: 'allow-ase-tags' - protocols: [ - { - port: '80' - protocolType: 'HTTP' - } - { - port: '443' - protocolType: 'HTTPS' - } - ] - sourceAddresses: [ - '*' - ] - } - { - name: 'allow-ase-management' - protocols: [ - { - port: '80' - protocolType: 'HTTP' - } - { - port: '443' - protocolType: 'HTTPS' - } - ] - sourceAddresses: [ - '*' - ] - targetFqdns: [ - 'bing.com' - ] - } - ] - } - } - ] - diagnosticSettings: [ - { - eventHubAuthorizationRuleResourceId: '' - eventHubName: '' - metricCategories: [ - { - category: 'AllMetrics' - } - ] - name: 'customSetting' - storageAccountResourceId: '' - workspaceResourceId: '' - } - ] enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - networkRuleCollections: [ - { - name: 'allow-network-rules' - properties: { - action: { - type: 'allow' - } - priority: 100 - rules: [ + publicIPAddressObject: { + diagnosticSettings: [ + { + eventHubAuthorizationRuleResourceId: '' + eventHubName: '' + metricCategories: [ { - destinationAddresses: [ - '*' - ] - destinationPorts: [ - '12000' - '123' - ] - name: 'allow-ntp' - protocols: [ - 'Any' - ] - sourceAddresses: [ - '*' - ] + category: 'AllMetrics' } ] + name: 'customSetting' + storageAccountResourceId: '' + workspaceResourceId: '' } - } - ] - publicIPResourceID: '' - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] + ] + name: 'new-pip-nafcstpip' + publicIPAllocationMethod: 'Static' + publicIPPrefixResourceId: '' + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + skuName: 'Standard' + skuTier: 'Regional' + } tags: { Environment: 'Non-Prod' 'hidden-title': 'This is visible in the resource name' Role: 'DeploymentValidation' } vNetId: '' - zones: [ - '1' - '2' - '3' - ] } } ``` @@ -289,241 +202,26 @@ module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "nafcom001" + "value": "nafcstpip001" }, // Non-required parameters - "applicationRuleCollections": { - "value": [ - { - "name": "allow-app-rules", - "properties": { - "action": { - "type": "allow" - }, - "priority": 100, - "rules": [ - { - "fqdnTags": [ - "AppServiceEnvironment", - "WindowsUpdate" - ], - "name": "allow-ase-tags", - "protocols": [ - { - "port": "80", - "protocolType": "HTTP" - }, - { - "port": "443", - "protocolType": "HTTPS" - } - ], - "sourceAddresses": [ - "*" - ] - }, - { - "name": "allow-ase-management", - "protocols": [ - { - "port": "80", - "protocolType": "HTTP" - }, - { - "port": "443", - "protocolType": "HTTPS" - } - ], - "sourceAddresses": [ - "*" - ], - "targetFqdns": [ - "bing.com" - ] - } - ] - } - } - ] - }, - "diagnosticSettings": { - "value": [ - { - "eventHubAuthorizationRuleResourceId": "", - "eventHubName": "", - "metricCategories": [ - { - "category": "AllMetrics" - } - ], - "name": "customSetting", - "storageAccountResourceId": "", - "workspaceResourceId": "" - } - ] - }, "enableDefaultTelemetry": { "value": "" }, - "lock": { + "publicIPAddressObject": { "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "networkRuleCollections": { - "value": [ - { - "name": "allow-network-rules", - "properties": { - "action": { - "type": "allow" - }, - "priority": 100, - "rules": [ + "diagnosticSettings": [ + { + "eventHubAuthorizationRuleResourceId": "", + "eventHubName": "", + "metricCategories": [ { - "destinationAddresses": [ - "*" - ], - "destinationPorts": [ - "12000", - "123" - ], - "name": "allow-ntp", - "protocols": [ - "Any" - ], - "sourceAddresses": [ - "*" - ] + "category": "AllMetrics" } - ] - } - } - ] - }, - "publicIPResourceID": { - "value": "" - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - }, - "vNetId": { - "value": "" - }, - "zones": { - "value": [ - "1", - "2", - "3" - ] - } - } -} -``` - -
-

- -### Example 3: _Custompip_ - -

- -via Bicep module - -```bicep -module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nafcstpip' - params: { - // Required parameters - name: 'nafcstpip001' - // Non-required parameters - enableDefaultTelemetry: '' - publicIPAddressObject: { - diagnosticSettings: [ - { - eventHubAuthorizationRuleResourceId: '' - eventHubName: '' - metricCategories: [ - { - category: 'AllMetrics' - } - ] - name: 'customSetting' - storageAccountResourceId: '' - workspaceResourceId: '' - } - ] - name: 'new-pip-nafcstpip' - publicIPAllocationMethod: 'Static' - publicIPPrefixResourceId: '' - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - skuName: 'Standard' - skuTier: 'Regional' - } - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - vNetId: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nafcstpip001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "publicIPAddressObject": { - "value": { - "diagnosticSettings": [ - { - "eventHubAuthorizationRuleResourceId": "", - "eventHubName": "", - "metricCategories": [ - { - "category": "AllMetrics" - } - ], - "name": "customSetting", - "storageAccountResourceId": "", - "workspaceResourceId": "" + ], + "name": "customSetting", + "storageAccountResourceId": "", + "workspaceResourceId": "" } ], "name": "new-pip-nafcstpip", @@ -557,7 +255,7 @@ module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = {

-### Example 4: _Using only defaults_ +### Example 3: _Using only defaults_ This instance deploys the module with the minimum set of required parameters. @@ -609,7 +307,7 @@ module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = {

-### Example 5: _Hubcommon_ +### Example 4: _Hubcommon_

@@ -686,7 +384,7 @@ module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = {

-### Example 6: _Hubmin_ +### Example 5: _Hubmin_

@@ -747,6 +445,308 @@ module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = {

+### Example 6: _Using large parameter set_ + +This instance deploys the module with most of its features enabled. + + +

+ +via Bicep module + +```bicep +module azureFirewall 'br:bicep/modules/network.azure-firewall:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nafmax' + params: { + // Required parameters + name: 'nafmax001' + // Non-required parameters + applicationRuleCollections: [ + { + name: 'allow-app-rules' + properties: { + action: { + type: 'allow' + } + priority: 100 + rules: [ + { + fqdnTags: [ + 'AppServiceEnvironment' + 'WindowsUpdate' + ] + name: 'allow-ase-tags' + protocols: [ + { + port: '80' + protocolType: 'HTTP' + } + { + port: '443' + protocolType: 'HTTPS' + } + ] + sourceAddresses: [ + '*' + ] + } + { + name: 'allow-ase-management' + protocols: [ + { + port: '80' + protocolType: 'HTTP' + } + { + port: '443' + protocolType: 'HTTPS' + } + ] + sourceAddresses: [ + '*' + ] + targetFqdns: [ + 'bing.com' + ] + } + ] + } + } + ] + diagnosticSettings: [ + { + eventHubAuthorizationRuleResourceId: '' + eventHubName: '' + metricCategories: [ + { + category: 'AllMetrics' + } + ] + name: 'customSetting' + storageAccountResourceId: '' + workspaceResourceId: '' + } + ] + enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + networkRuleCollections: [ + { + name: 'allow-network-rules' + properties: { + action: { + type: 'allow' + } + priority: 100 + rules: [ + { + destinationAddresses: [ + '*' + ] + destinationPorts: [ + '12000' + '123' + ] + name: 'allow-ntp' + protocols: [ + 'Any' + ] + sourceAddresses: [ + '*' + ] + } + ] + } + } + ] + publicIPResourceID: '' + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + vNetId: '' + zones: [ + '1' + '2' + '3' + ] + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nafmax001" + }, + // Non-required parameters + "applicationRuleCollections": { + "value": [ + { + "name": "allow-app-rules", + "properties": { + "action": { + "type": "allow" + }, + "priority": 100, + "rules": [ + { + "fqdnTags": [ + "AppServiceEnvironment", + "WindowsUpdate" + ], + "name": "allow-ase-tags", + "protocols": [ + { + "port": "80", + "protocolType": "HTTP" + }, + { + "port": "443", + "protocolType": "HTTPS" + } + ], + "sourceAddresses": [ + "*" + ] + }, + { + "name": "allow-ase-management", + "protocols": [ + { + "port": "80", + "protocolType": "HTTP" + }, + { + "port": "443", + "protocolType": "HTTPS" + } + ], + "sourceAddresses": [ + "*" + ], + "targetFqdns": [ + "bing.com" + ] + } + ] + } + } + ] + }, + "diagnosticSettings": { + "value": [ + { + "eventHubAuthorizationRuleResourceId": "", + "eventHubName": "", + "metricCategories": [ + { + "category": "AllMetrics" + } + ], + "name": "customSetting", + "storageAccountResourceId": "", + "workspaceResourceId": "" + } + ] + }, + "enableDefaultTelemetry": { + "value": "" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "networkRuleCollections": { + "value": [ + { + "name": "allow-network-rules", + "properties": { + "action": { + "type": "allow" + }, + "priority": 100, + "rules": [ + { + "destinationAddresses": [ + "*" + ], + "destinationPorts": [ + "12000", + "123" + ], + "name": "allow-ntp", + "protocols": [ + "Any" + ], + "sourceAddresses": [ + "*" + ] + } + ] + } + } + ] + }, + "publicIPResourceID": { + "value": "" + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + }, + "vNetId": { + "value": "" + }, + "zones": { + "value": [ + "1", + "2", + "3" + ] + } + } +} +``` + +
+

+ ## Parameters diff --git a/modules/network/bastion-host/README.md b/modules/network/bastion-host/README.md index 625f27b070..06e8704806 100644 --- a/modules/network/bastion-host/README.md +++ b/modules/network/bastion-host/README.md @@ -28,149 +28,11 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.bastion-host:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Custompip](#example-2-custompip) -- [Using only defaults](#example-3-using-only-defaults) +- [Custompip](#example-1-custompip) +- [Using only defaults](#example-2-using-only-defaults) +- [Using large parameter set](#example-3-using-large-parameter-set) -### Example 1: _Using large parameter set_ - -This instance deploys the module with most of its features enabled. - - -

- -via Bicep module - -```bicep -module bastionHost 'br:bicep/modules/network.bastion-host:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nbhcom' - params: { - // Required parameters - name: 'nbhcom001' - vNetId: '' - // Non-required parameters - bastionSubnetPublicIpResourceId: '' - diagnosticSettings: [ - { - eventHubAuthorizationRuleResourceId: '' - eventHubName: '' - name: 'customSetting' - storageAccountResourceId: '' - workspaceResourceId: '' - } - ] - disableCopyPaste: true - enableDefaultTelemetry: '' - enableFileCopy: false - enableIpConnect: false - enableShareableLink: false - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - scaleUnits: 4 - skuName: 'Standard' - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nbhcom001" - }, - "vNetId": { - "value": "" - }, - // Non-required parameters - "bastionSubnetPublicIpResourceId": { - "value": "" - }, - "diagnosticSettings": { - "value": [ - { - "eventHubAuthorizationRuleResourceId": "", - "eventHubName": "", - "name": "customSetting", - "storageAccountResourceId": "", - "workspaceResourceId": "" - } - ] - }, - "disableCopyPaste": { - "value": true - }, - "enableDefaultTelemetry": { - "value": "" - }, - "enableFileCopy": { - "value": false - }, - "enableIpConnect": { - "value": false - }, - "enableShareableLink": { - "value": false - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "scaleUnits": { - "value": 4 - }, - "skuName": { - "value": "Standard" - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - } -} -``` - -
-

- -### Example 2: _Custompip_ +### Example 1: _Custompip_

@@ -299,7 +161,7 @@ module bastionHost 'br:bicep/modules/network.bastion-host:1.0.0' = {

-### Example 3: _Using only defaults_ +### Example 2: _Using only defaults_ This instance deploys the module with the minimum set of required parameters. @@ -351,6 +213,144 @@ module bastionHost 'br:bicep/modules/network.bastion-host:1.0.0' = {

+### Example 3: _Using large parameter set_ + +This instance deploys the module with most of its features enabled. + + +

+ +via Bicep module + +```bicep +module bastionHost 'br:bicep/modules/network.bastion-host:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nbhmax' + params: { + // Required parameters + name: 'nbhmax001' + vNetId: '' + // Non-required parameters + bastionSubnetPublicIpResourceId: '' + diagnosticSettings: [ + { + eventHubAuthorizationRuleResourceId: '' + eventHubName: '' + name: 'customSetting' + storageAccountResourceId: '' + workspaceResourceId: '' + } + ] + disableCopyPaste: true + enableDefaultTelemetry: '' + enableFileCopy: false + enableIpConnect: false + enableShareableLink: false + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + scaleUnits: 4 + skuName: 'Standard' + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nbhmax001" + }, + "vNetId": { + "value": "" + }, + // Non-required parameters + "bastionSubnetPublicIpResourceId": { + "value": "" + }, + "diagnosticSettings": { + "value": [ + { + "eventHubAuthorizationRuleResourceId": "", + "eventHubName": "", + "name": "customSetting", + "storageAccountResourceId": "", + "workspaceResourceId": "" + } + ] + }, + "disableCopyPaste": { + "value": true + }, + "enableDefaultTelemetry": { + "value": "" + }, + "enableFileCopy": { + "value": false + }, + "enableIpConnect": { + "value": false + }, + "enableShareableLink": { + "value": false + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "scaleUnits": { + "value": 4 + }, + "skuName": { + "value": "Standard" + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + } +} +``` + +
+

+ ## Parameters diff --git a/modules/network/ddos-protection-plan/README.md b/modules/network/ddos-protection-plan/README.md index c8ba05f4e5..1ccac70c5a 100644 --- a/modules/network/ddos-protection-plan/README.md +++ b/modules/network/ddos-protection-plan/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.ddos-protection-plan:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -40,28 +40,12 @@ This instance deploys the module with most of its features enabled. ```bicep module ddosProtectionPlan 'br:bicep/modules/network.ddos-protection-plan:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ndppcom' + name: '${uniqueString(deployment().name, location)}-test-ndppmin' params: { // Required parameters - name: 'ndppcom001' + name: 'ndppmin001' // Non-required parameters enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -80,33 +64,11 @@ module ddosProtectionPlan 'br:bicep/modules/network.ddos-protection-plan:1.0.0' "parameters": { // Required parameters "name": { - "value": "ndppcom001" + "value": "ndppmin001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -115,9 +77,9 @@ module ddosProtectionPlan 'br:bicep/modules/network.ddos-protection-plan:1.0.0'

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -126,12 +88,28 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module ddosProtectionPlan 'br:bicep/modules/network.ddos-protection-plan:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ndppmin' + name: '${uniqueString(deployment().name, location)}-test-ndppmax' params: { // Required parameters - name: 'ndppmin001' + name: 'ndppmax001' // Non-required parameters enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -150,11 +128,33 @@ module ddosProtectionPlan 'br:bicep/modules/network.ddos-protection-plan:1.0.0' "parameters": { // Required parameters "name": { - "value": "ndppmin001" + "value": "ndppmax001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } diff --git a/modules/network/dns-forwarding-ruleset/README.md b/modules/network/dns-forwarding-ruleset/README.md index 1010b3a887..43d21c8605 100644 --- a/modules/network/dns-forwarding-ruleset/README.md +++ b/modules/network/dns-forwarding-ruleset/README.md @@ -30,10 +30,66 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.dns-forwarding-ruleset:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module dnsForwardingRuleset 'br:bicep/modules/network.dns-forwarding-ruleset:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-ndfrsmin' + params: { + // Required parameters + dnsResolverOutboundEndpointResourceIds: [ + '' + ] + name: 'ndfrsmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "dnsResolverOutboundEndpointResourceIds": { + "value": [ + "" + ] + }, + "name": { + "value": "ndfrsmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -44,13 +100,13 @@ This instance deploys the module with most of its features enabled. ```bicep module dnsForwardingRuleset 'br:bicep/modules/network.dns-forwarding-ruleset:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ndfrscom' + name: '${uniqueString(deployment().name, location)}-test-ndfrsmax' params: { // Required parameters dnsResolverOutboundEndpointResourceIds: [ '' ] - name: 'ndfrscom001' + name: 'ndfrsmax001' // Non-required parameters enableDefaultTelemetry: '' forwardingRules: [ @@ -108,7 +164,7 @@ module dnsForwardingRuleset 'br:bicep/modules/network.dns-forwarding-ruleset:1.0 ] }, "name": { - "value": "ndfrscom001" + "value": "ndfrsmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -163,62 +219,6 @@ module dnsForwardingRuleset 'br:bicep/modules/network.dns-forwarding-ruleset:1.0

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module dnsForwardingRuleset 'br:bicep/modules/network.dns-forwarding-ruleset:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ndfrsmin' - params: { - // Required parameters - dnsResolverOutboundEndpointResourceIds: [ - '' - ] - name: 'ndfrsmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "dnsResolverOutboundEndpointResourceIds": { - "value": [ - "" - ] - }, - "name": { - "value": "ndfrsmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/dns-resolver/README.md b/modules/network/dns-resolver/README.md index 1b22bfc083..99f030c8b2 100644 --- a/modules/network/dns-resolver/README.md +++ b/modules/network/dns-resolver/README.md @@ -43,10 +43,10 @@ This instance deploys the module with most of its features enabled. ```bicep module dnsResolver 'br:bicep/modules/network.dns-resolver:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ndrcom' + name: '${uniqueString(deployment().name, location)}-test-ndrmax' params: { // Required parameters - name: 'ndrcom001' + name: 'ndrmax001' virtualNetworkId: '' // Non-required parameters enableDefaultTelemetry: '' @@ -85,7 +85,7 @@ module dnsResolver 'br:bicep/modules/network.dns-resolver:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "ndrcom001" + "value": "ndrmax001" }, "virtualNetworkId": { "value": "" diff --git a/modules/network/dns-zone/README.md b/modules/network/dns-zone/README.md index 425088daa7..23651a2aa3 100644 --- a/modules/network/dns-zone/README.md +++ b/modules/network/dns-zone/README.md @@ -38,10 +38,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.dns-zone:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module dnsZone 'br:bicep/modules/network.dns-zone:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-ndzmin' + params: { + // Required parameters + name: 'ndzmin001.com' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "ndzmin001.com" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -52,10 +100,10 @@ This instance deploys the module with most of its features enabled. ```bicep module dnsZone 'br:bicep/modules/network.dns-zone:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ndzcom' + name: '${uniqueString(deployment().name, location)}-test-ndzmax' params: { // Required parameters - name: 'ndzcom001.com' + name: 'ndzmax001.com' // Non-required parameters a: [ { @@ -241,7 +289,7 @@ module dnsZone 'br:bicep/modules/network.dns-zone:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "ndzcom001.com" + "value": "ndzmax001.com" }, // Non-required parameters "a": { @@ -441,54 +489,6 @@ module dnsZone 'br:bicep/modules/network.dns-zone:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module dnsZone 'br:bicep/modules/network.dns-zone:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ndzmin' - params: { - // Required parameters - name: 'ndzmin001.com' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "ndzmin001.com" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/express-route-circuit/README.md b/modules/network/express-route-circuit/README.md index 3372a9e824..125ba3bbb9 100644 --- a/modules/network/express-route-circuit/README.md +++ b/modules/network/express-route-circuit/README.md @@ -27,10 +27,70 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.express-route-circuit:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module expressRouteCircuit 'br:bicep/modules/network.express-route-circuit:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nercmin' + params: { + // Required parameters + bandwidthInMbps: 50 + name: 'nercmin001' + peeringLocation: 'Amsterdam' + serviceProviderName: 'Equinix' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "bandwidthInMbps": { + "value": 50 + }, + "name": { + "value": "nercmin001" + }, + "peeringLocation": { + "value": "Amsterdam" + }, + "serviceProviderName": { + "value": "Equinix" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -41,11 +101,11 @@ This instance deploys the module with most of its features enabled. ```bicep module expressRouteCircuit 'br:bicep/modules/network.express-route-circuit:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nerccom' + name: '${uniqueString(deployment().name, location)}-test-nercmax' params: { // Required parameters bandwidthInMbps: 50 - name: 'nerccom001' + name: 'nercmax001' peeringLocation: 'Amsterdam' serviceProviderName: 'Equinix' // Non-required parameters @@ -104,7 +164,7 @@ module expressRouteCircuit 'br:bicep/modules/network.express-route-circuit:1.0.0 "value": 50 }, "name": { - "value": "nerccom001" + "value": "nercmax001" }, "peeringLocation": { "value": "Amsterdam" @@ -170,66 +230,6 @@ module expressRouteCircuit 'br:bicep/modules/network.express-route-circuit:1.0.0

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module expressRouteCircuit 'br:bicep/modules/network.express-route-circuit:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nercmin' - params: { - // Required parameters - bandwidthInMbps: 50 - name: 'nercmin001' - peeringLocation: 'Amsterdam' - serviceProviderName: 'Equinix' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "bandwidthInMbps": { - "value": 50 - }, - "name": { - "value": "nercmin001" - }, - "peeringLocation": { - "value": "Amsterdam" - }, - "serviceProviderName": { - "value": "Equinix" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/express-route-gateway/README.md b/modules/network/express-route-gateway/README.md index 60d5d55775..f396c96058 100644 --- a/modules/network/express-route-gateway/README.md +++ b/modules/network/express-route-gateway/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.express-route-gateway:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -40,30 +40,13 @@ This instance deploys the module with most of its features enabled. ```bicep module expressRouteGateway 'br:bicep/modules/network.express-route-gateway:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nergcom' + name: '${uniqueString(deployment().name, location)}-test-nergmin' params: { // Required parameters - name: 'nergcom001' + name: 'nergmin001' virtualHubId: '' // Non-required parameters - autoScaleConfigurationBoundsMax: 3 - autoScaleConfigurationBoundsMin: 2 enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - hello: 'world' - 'hidden-title': 'This is visible in the resource name' - } } } ``` @@ -82,41 +65,14 @@ module expressRouteGateway 'br:bicep/modules/network.express-route-gateway:1.0.0 "parameters": { // Required parameters "name": { - "value": "nergcom001" + "value": "nergmin001" }, "virtualHubId": { "value": "" }, // Non-required parameters - "autoScaleConfigurationBoundsMax": { - "value": 3 - }, - "autoScaleConfigurationBoundsMin": { - "value": 2 - }, "enableDefaultTelemetry": { "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "hello": "world", - "hidden-title": "This is visible in the resource name" - } } } } @@ -125,9 +81,9 @@ module expressRouteGateway 'br:bicep/modules/network.express-route-gateway:1.0.0

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -136,13 +92,30 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module expressRouteGateway 'br:bicep/modules/network.express-route-gateway:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nergmin' + name: '${uniqueString(deployment().name, location)}-test-nergmax' params: { // Required parameters - name: 'nergmin001' + name: 'nergmax001' virtualHubId: '' // Non-required parameters + autoScaleConfigurationBoundsMax: 3 + autoScaleConfigurationBoundsMin: 2 enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + hello: 'world' + 'hidden-title': 'This is visible in the resource name' + } } } ``` @@ -161,14 +134,41 @@ module expressRouteGateway 'br:bicep/modules/network.express-route-gateway:1.0.0 "parameters": { // Required parameters "name": { - "value": "nergmin001" + "value": "nergmax001" }, "virtualHubId": { "value": "" }, // Non-required parameters + "autoScaleConfigurationBoundsMax": { + "value": 3 + }, + "autoScaleConfigurationBoundsMin": { + "value": 2 + }, "enableDefaultTelemetry": { "value": "" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "hello": "world", + "hidden-title": "This is visible in the resource name" + } } } } diff --git a/modules/network/firewall-policy/README.md b/modules/network/firewall-policy/README.md index 8c99b839b8..1cf5307503 100644 --- a/modules/network/firewall-policy/README.md +++ b/modules/network/firewall-policy/README.md @@ -25,10 +25,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.firewall-policy:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module firewallPolicy 'br:bicep/modules/network.firewall-policy:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nfpmin' + params: { + // Required parameters + name: 'nfpmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nfpmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -39,10 +87,10 @@ This instance deploys the module with most of its features enabled. ```bicep module firewallPolicy 'br:bicep/modules/network.firewall-policy:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nfpcom' + name: '${uniqueString(deployment().name, location)}-test-nfpmax' params: { // Required parameters - name: 'nfpcom001' + name: 'nfpmax001' // Non-required parameters allowSqlRedirect: true autoLearnPrivateRanges: 'Enabled' @@ -108,7 +156,7 @@ module firewallPolicy 'br:bicep/modules/network.firewall-policy:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "nfpcom001" + "value": "nfpmax001" }, // Non-required parameters "allowSqlRedirect": { @@ -174,54 +222,6 @@ module firewallPolicy 'br:bicep/modules/network.firewall-policy:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module firewallPolicy 'br:bicep/modules/network.firewall-policy:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nfpmin' - params: { - // Required parameters - name: 'nfpmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nfpmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/front-door-web-application-firewall-policy/README.md b/modules/network/front-door-web-application-firewall-policy/README.md index 09ab8eda51..c12d09f3bf 100644 --- a/modules/network/front-door-web-application-firewall-policy/README.md +++ b/modules/network/front-door-web-application-firewall-policy/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.front-door-web-application-firewall-policy:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module frontDoorWebApplicationFirewallPolicy 'br:bicep/modules/network.front-door-web-application-firewall-policy:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nagwafpmin' + params: { + // Required parameters + name: 'nagwafpmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nagwafpmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module frontDoorWebApplicationFirewallPolicy 'br:bicep/modules/network.front-door-web-application-firewall-policy:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nagwafpcom' + name: '${uniqueString(deployment().name, location)}-test-nagwafpmax' params: { // Required parameters - name: 'nagwafpcom001' + name: 'nagwafpmax001' // Non-required parameters customRules: { rules: [ @@ -143,7 +191,7 @@ module frontDoorWebApplicationFirewallPolicy 'br:bicep/modules/network.front-doo "parameters": { // Required parameters "name": { - "value": "nagwafpcom001" + "value": "nagwafpmax001" }, // Non-required parameters "customRules": { @@ -249,54 +297,6 @@ module frontDoorWebApplicationFirewallPolicy 'br:bicep/modules/network.front-doo

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module frontDoorWebApplicationFirewallPolicy 'br:bicep/modules/network.front-door-web-application-firewall-policy:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nagwafpmin' - params: { - // Required parameters - name: 'nagwafpmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nagwafpmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/front-door/README.md b/modules/network/front-door/README.md index 4513ff0e12..02f47b80bd 100644 --- a/modules/network/front-door/README.md +++ b/modules/network/front-door/README.md @@ -27,12 +27,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.front-door:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -41,7 +41,7 @@ This instance deploys the module with most of its features enabled. ```bicep module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nfdcom' + name: '${uniqueString(deployment().name, location)}-test-nfdmin' params: { // Required parameters backendPools: [ @@ -56,10 +56,6 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { httpPort: 80 httpsPort: 443 priority: 1 - privateLinkAlias: '' - privateLinkApprovalMessage: '' - privateLinkLocation: '' - privateLinkResourceId: '' weight: 50 } ] @@ -86,8 +82,6 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { { name: 'heathProbe' properties: { - enabledState: '' - healthProbeMethod: '' intervalInSeconds: 60 path: '/' protocol: 'Https' @@ -110,7 +104,6 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { name: 'routingRule' properties: { acceptedProtocols: [ - 'Http' 'Https' ] enabledState: 'Enabled' @@ -127,31 +120,12 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { backendPool: { id: '' } - forwardingProtocol: 'MatchRequest' } } } ] // Non-required parameters enableDefaultTelemetry: '' - enforceCertificateNameCheck: 'Disabled' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - sendRecvTimeoutSeconds: 10 - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -182,10 +156,6 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { "httpPort": 80, "httpsPort": 443, "priority": 1, - "privateLinkAlias": "", - "privateLinkApprovalMessage": "", - "privateLinkLocation": "", - "privateLinkResourceId": "", "weight": 50 } ], @@ -216,8 +186,6 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { { "name": "heathProbe", "properties": { - "enabledState": "", - "healthProbeMethod": "", "intervalInSeconds": 60, "path": "/", "protocol": "Https" @@ -246,7 +214,6 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { "name": "routingRule", "properties": { "acceptedProtocols": [ - "Http", "Https" ], "enabledState": "Enabled", @@ -262,8 +229,7 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", "backendPool": { "id": "" - }, - "forwardingProtocol": "MatchRequest" + } } } } @@ -272,34 +238,6 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "enforceCertificateNameCheck": { - "value": "Disabled" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "sendRecvTimeoutSeconds": { - "value": 10 - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -308,9 +246,9 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -319,7 +257,7 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nfdmin' + name: '${uniqueString(deployment().name, location)}-test-nfdmax' params: { // Required parameters backendPools: [ @@ -334,6 +272,10 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { httpPort: 80 httpsPort: 443 priority: 1 + privateLinkAlias: '' + privateLinkApprovalMessage: '' + privateLinkLocation: '' + privateLinkResourceId: '' weight: 50 } ] @@ -360,6 +302,8 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { { name: 'heathProbe' properties: { + enabledState: '' + healthProbeMethod: '' intervalInSeconds: 60 path: '/' protocol: 'Https' @@ -382,6 +326,7 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { name: 'routingRule' properties: { acceptedProtocols: [ + 'Http' 'Https' ] enabledState: 'Enabled' @@ -398,12 +343,31 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { backendPool: { id: '' } + forwardingProtocol: 'MatchRequest' } } } ] // Non-required parameters enableDefaultTelemetry: '' + enforceCertificateNameCheck: 'Disabled' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + sendRecvTimeoutSeconds: 10 + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -434,6 +398,10 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { "httpPort": 80, "httpsPort": 443, "priority": 1, + "privateLinkAlias": "", + "privateLinkApprovalMessage": "", + "privateLinkLocation": "", + "privateLinkResourceId": "", "weight": 50 } ], @@ -464,6 +432,8 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { { "name": "heathProbe", "properties": { + "enabledState": "", + "healthProbeMethod": "", "intervalInSeconds": 60, "path": "/", "protocol": "Https" @@ -492,6 +462,7 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { "name": "routingRule", "properties": { "acceptedProtocols": [ + "Http", "Https" ], "enabledState": "Enabled", @@ -507,7 +478,8 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", "backendPool": { "id": "" - } + }, + "forwardingProtocol": "MatchRequest" } } } @@ -516,6 +488,34 @@ module frontDoor 'br:bicep/modules/network.front-door:1.0.0' = { // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "enforceCertificateNameCheck": { + "value": "Disabled" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "sendRecvTimeoutSeconds": { + "value": 10 + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } diff --git a/modules/network/ip-group/README.md b/modules/network/ip-group/README.md index 343b00bb29..36b3fe51fa 100644 --- a/modules/network/ip-group/README.md +++ b/modules/network/ip-group/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.ip-group:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module ipGroup 'br:bicep/modules/network.ip-group:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nigmin' + params: { + // Required parameters + name: 'nigmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nigmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module ipGroup 'br:bicep/modules/network.ip-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nigcom' + name: '${uniqueString(deployment().name, location)}-test-nigmax' params: { // Required parameters - name: 'nigcom001' + name: 'nigmax001' // Non-required parameters enableDefaultTelemetry: '' ipAddresses: [ @@ -84,7 +132,7 @@ module ipGroup 'br:bicep/modules/network.ip-group:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "nigcom001" + "value": "nigmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -125,54 +173,6 @@ module ipGroup 'br:bicep/modules/network.ip-group:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module ipGroup 'br:bicep/modules/network.ip-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nigmin' - params: { - // Required parameters - name: 'nigmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nigmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/load-balancer/README.md b/modules/network/load-balancer/README.md index 21fc7daf46..b747882d68 100644 --- a/modules/network/load-balancer/README.md +++ b/modules/network/load-balancer/README.md @@ -30,13 +30,13 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.load-balancer:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Internal](#example-3-internal) +- [Using only defaults](#example-1-using-only-defaults) +- [Internal](#example-2-internal) +- [Using large parameter set](#example-3-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -45,7 +45,7 @@ This instance deploys the module with most of its features enabled. ```bicep module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nlbcom' + name: '${uniqueString(deployment().name, location)}-test-nlbmin' params: { // Required parameters frontendIPConfigurations: [ @@ -54,14 +54,70 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { publicIPAddressId: '' } ] - name: 'nlbcom001' + name: 'nlbmin001' // Non-required parameters - backendAddressPools: [ + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "frontendIPConfigurations": { + "value": [ + { + "name": "publicIPConfig1", + "publicIPAddressId": "" + } + ] + }, + "name": { + "value": "nlbmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Internal_ + +

+ +via Bicep module + +```bicep +module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nlbint' + params: { + // Required parameters + frontendIPConfigurations: [ { - name: 'backendAddressPool1' + name: 'privateIPConfig1' + subnetId: '' } + ] + name: 'nlbint001' + // Non-required parameters + backendAddressPools: [ { - name: 'backendAddressPool2' + name: 'servers' } ] diagnosticSettings: [ @@ -84,7 +140,7 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { backendPort: 443 enableFloatingIP: false enableTcpReset: false - frontendIPConfigurationName: 'publicIPConfig1' + frontendIPConfigurationName: 'privateIPConfig1' frontendPort: 443 idleTimeoutInMinutes: 4 name: 'inboundNatRule1' @@ -92,62 +148,35 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { } { backendPort: 3389 - frontendIPConfigurationName: 'publicIPConfig1' + frontendIPConfigurationName: 'privateIPConfig1' frontendPort: 3389 name: 'inboundNatRule2' } ] loadBalancingRules: [ { - backendAddressPoolName: 'backendAddressPool1' - backendPort: 80 + backendAddressPoolName: 'servers' + backendPort: 0 disableOutboundSnat: true - enableFloatingIP: false + enableFloatingIP: true enableTcpReset: false - frontendIPConfigurationName: 'publicIPConfig1' - frontendPort: 80 - idleTimeoutInMinutes: 5 + frontendIPConfigurationName: 'privateIPConfig1' + frontendPort: 0 + idleTimeoutInMinutes: 4 loadDistribution: 'Default' - name: 'publicIPLBRule1' + name: 'privateIPLBRule1' probeName: 'probe1' - protocol: 'Tcp' - } - { - backendAddressPoolName: 'backendAddressPool2' - backendPort: 8080 - frontendIPConfigurationName: 'publicIPConfig1' - frontendPort: 8080 - loadDistribution: 'Default' - name: 'publicIPLBRule2' - probeName: 'probe2' - } - ] - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - outboundRules: [ - { - allocatedOutboundPorts: 63984 - backendAddressPoolName: 'backendAddressPool1' - frontendIPConfigurationName: 'publicIPConfig1' - name: 'outboundRule1' + protocol: 'All' } ] probes: [ { - intervalInSeconds: 10 + intervalInSeconds: 5 name: 'probe1' - numberOfProbes: 5 - port: 80 + numberOfProbes: 2 + port: '62000' protocol: 'Tcp' } - { - name: 'probe2' - port: 443 - protocol: 'Https' - requestPath: '/' - } ] roleAssignments: [ { @@ -156,6 +185,7 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { roleDefinitionIdOrName: 'Reader' } ] + skuName: 'Standard' tags: { Environment: 'Non-Prod' 'hidden-title': 'This is visible in the resource name' @@ -181,22 +211,19 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { "frontendIPConfigurations": { "value": [ { - "name": "publicIPConfig1", - "publicIPAddressId": "" + "name": "privateIPConfig1", + "subnetId": "" } ] }, "name": { - "value": "nlbcom001" + "value": "nlbint001" }, // Non-required parameters "backendAddressPools": { "value": [ { - "name": "backendAddressPool1" - }, - { - "name": "backendAddressPool2" + "name": "servers" } ] }, @@ -225,7 +252,7 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { "backendPort": 443, "enableFloatingIP": false, "enableTcpReset": false, - "frontendIPConfigurationName": "publicIPConfig1", + "frontendIPConfigurationName": "privateIPConfig1", "frontendPort": 443, "idleTimeoutInMinutes": 4, "name": "inboundNatRule1", @@ -233,7 +260,7 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { }, { "backendPort": 3389, - "frontendIPConfigurationName": "publicIPConfig1", + "frontendIPConfigurationName": "privateIPConfig1", "frontendPort": 3389, "name": "inboundNatRule2" } @@ -242,60 +269,29 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { "loadBalancingRules": { "value": [ { - "backendAddressPoolName": "backendAddressPool1", - "backendPort": 80, + "backendAddressPoolName": "servers", + "backendPort": 0, "disableOutboundSnat": true, - "enableFloatingIP": false, + "enableFloatingIP": true, "enableTcpReset": false, - "frontendIPConfigurationName": "publicIPConfig1", - "frontendPort": 80, - "idleTimeoutInMinutes": 5, + "frontendIPConfigurationName": "privateIPConfig1", + "frontendPort": 0, + "idleTimeoutInMinutes": 4, "loadDistribution": "Default", - "name": "publicIPLBRule1", + "name": "privateIPLBRule1", "probeName": "probe1", - "protocol": "Tcp" - }, - { - "backendAddressPoolName": "backendAddressPool2", - "backendPort": 8080, - "frontendIPConfigurationName": "publicIPConfig1", - "frontendPort": 8080, - "loadDistribution": "Default", - "name": "publicIPLBRule2", - "probeName": "probe2" - } - ] - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "outboundRules": { - "value": [ - { - "allocatedOutboundPorts": 63984, - "backendAddressPoolName": "backendAddressPool1", - "frontendIPConfigurationName": "publicIPConfig1", - "name": "outboundRule1" + "protocol": "All" } ] }, "probes": { "value": [ { - "intervalInSeconds": 10, + "intervalInSeconds": 5, "name": "probe1", - "numberOfProbes": 5, - "port": 80, + "numberOfProbes": 2, + "port": "62000", "protocol": "Tcp" - }, - { - "name": "probe2", - "port": 443, - "protocol": "Https", - "requestPath": "/" } ] }, @@ -308,6 +304,9 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { } ] }, + "skuName": { + "value": "Standard" + }, "tags": { "value": { "Environment": "Non-Prod", @@ -322,9 +321,9 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 3: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -333,7 +332,7 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nlbmin' + name: '${uniqueString(deployment().name, location)}-test-nlbmax' params: { // Required parameters frontendIPConfigurations: [ @@ -342,70 +341,14 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { publicIPAddressId: '' } ] - name: 'nlbmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "frontendIPConfigurations": { - "value": [ - { - "name": "publicIPConfig1", - "publicIPAddressId": "" - } - ] - }, - "name": { - "value": "nlbmin001" - }, + name: 'nlbmax001' // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Internal_ - -

- -via Bicep module - -```bicep -module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nlbint' - params: { - // Required parameters - frontendIPConfigurations: [ + backendAddressPools: [ { - name: 'privateIPConfig1' - subnetId: '' + name: 'backendAddressPool1' } - ] - name: 'nlbint001' - // Non-required parameters - backendAddressPools: [ { - name: 'servers' + name: 'backendAddressPool2' } ] diagnosticSettings: [ @@ -428,7 +371,7 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { backendPort: 443 enableFloatingIP: false enableTcpReset: false - frontendIPConfigurationName: 'privateIPConfig1' + frontendIPConfigurationName: 'publicIPConfig1' frontendPort: 443 idleTimeoutInMinutes: 4 name: 'inboundNatRule1' @@ -436,35 +379,62 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { } { backendPort: 3389 - frontendIPConfigurationName: 'privateIPConfig1' + frontendIPConfigurationName: 'publicIPConfig1' frontendPort: 3389 name: 'inboundNatRule2' } ] loadBalancingRules: [ { - backendAddressPoolName: 'servers' - backendPort: 0 + backendAddressPoolName: 'backendAddressPool1' + backendPort: 80 disableOutboundSnat: true - enableFloatingIP: true + enableFloatingIP: false enableTcpReset: false - frontendIPConfigurationName: 'privateIPConfig1' - frontendPort: 0 - idleTimeoutInMinutes: 4 + frontendIPConfigurationName: 'publicIPConfig1' + frontendPort: 80 + idleTimeoutInMinutes: 5 loadDistribution: 'Default' - name: 'privateIPLBRule1' + name: 'publicIPLBRule1' probeName: 'probe1' - protocol: 'All' + protocol: 'Tcp' + } + { + backendAddressPoolName: 'backendAddressPool2' + backendPort: 8080 + frontendIPConfigurationName: 'publicIPConfig1' + frontendPort: 8080 + loadDistribution: 'Default' + name: 'publicIPLBRule2' + probeName: 'probe2' + } + ] + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + outboundRules: [ + { + allocatedOutboundPorts: 63984 + backendAddressPoolName: 'backendAddressPool1' + frontendIPConfigurationName: 'publicIPConfig1' + name: 'outboundRule1' } ] probes: [ { - intervalInSeconds: 5 + intervalInSeconds: 10 name: 'probe1' - numberOfProbes: 2 - port: '62000' + numberOfProbes: 5 + port: 80 protocol: 'Tcp' } + { + name: 'probe2' + port: 443 + protocol: 'Https' + requestPath: '/' + } ] roleAssignments: [ { @@ -473,7 +443,6 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { roleDefinitionIdOrName: 'Reader' } ] - skuName: 'Standard' tags: { Environment: 'Non-Prod' 'hidden-title': 'This is visible in the resource name' @@ -499,19 +468,22 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { "frontendIPConfigurations": { "value": [ { - "name": "privateIPConfig1", - "subnetId": "" + "name": "publicIPConfig1", + "publicIPAddressId": "" } ] }, "name": { - "value": "nlbint001" + "value": "nlbmax001" }, // Non-required parameters "backendAddressPools": { "value": [ { - "name": "servers" + "name": "backendAddressPool1" + }, + { + "name": "backendAddressPool2" } ] }, @@ -540,7 +512,7 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { "backendPort": 443, "enableFloatingIP": false, "enableTcpReset": false, - "frontendIPConfigurationName": "privateIPConfig1", + "frontendIPConfigurationName": "publicIPConfig1", "frontendPort": 443, "idleTimeoutInMinutes": 4, "name": "inboundNatRule1", @@ -548,7 +520,7 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { }, { "backendPort": 3389, - "frontendIPConfigurationName": "privateIPConfig1", + "frontendIPConfigurationName": "publicIPConfig1", "frontendPort": 3389, "name": "inboundNatRule2" } @@ -557,29 +529,60 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { "loadBalancingRules": { "value": [ { - "backendAddressPoolName": "servers", - "backendPort": 0, + "backendAddressPoolName": "backendAddressPool1", + "backendPort": 80, "disableOutboundSnat": true, - "enableFloatingIP": true, + "enableFloatingIP": false, "enableTcpReset": false, - "frontendIPConfigurationName": "privateIPConfig1", - "frontendPort": 0, - "idleTimeoutInMinutes": 4, + "frontendIPConfigurationName": "publicIPConfig1", + "frontendPort": 80, + "idleTimeoutInMinutes": 5, "loadDistribution": "Default", - "name": "privateIPLBRule1", + "name": "publicIPLBRule1", "probeName": "probe1", - "protocol": "All" + "protocol": "Tcp" + }, + { + "backendAddressPoolName": "backendAddressPool2", + "backendPort": 8080, + "frontendIPConfigurationName": "publicIPConfig1", + "frontendPort": 8080, + "loadDistribution": "Default", + "name": "publicIPLBRule2", + "probeName": "probe2" + } + ] + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "outboundRules": { + "value": [ + { + "allocatedOutboundPorts": 63984, + "backendAddressPoolName": "backendAddressPool1", + "frontendIPConfigurationName": "publicIPConfig1", + "name": "outboundRule1" } ] }, "probes": { "value": [ { - "intervalInSeconds": 5, + "intervalInSeconds": 10, "name": "probe1", - "numberOfProbes": 2, - "port": "62000", + "numberOfProbes": 5, + "port": 80, "protocol": "Tcp" + }, + { + "name": "probe2", + "port": 443, + "protocol": "Https", + "requestPath": "/" } ] }, @@ -592,9 +595,6 @@ module loadBalancer 'br:bicep/modules/network.load-balancer:1.0.0' = { } ] }, - "skuName": { - "value": "Standard" - }, "tags": { "value": { "Environment": "Non-Prod", diff --git a/modules/network/local-network-gateway/README.md b/modules/network/local-network-gateway/README.md index 6dd6bd4da7..cc2167d281 100644 --- a/modules/network/local-network-gateway/README.md +++ b/modules/network/local-network-gateway/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.local-network-gateway:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -40,34 +40,16 @@ This instance deploys the module with most of its features enabled. ```bicep module localNetworkGateway 'br:bicep/modules/network.local-network-gateway:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nlngcom' + name: '${uniqueString(deployment().name, location)}-test-nlngmin' params: { // Required parameters localAddressPrefixes: [ '192.168.1.0/24' ] localGatewayPublicIpAddress: '8.8.8.8' - name: 'nlngcom001' + name: 'nlngmin001' // Non-required parameters enableDefaultTelemetry: '' - localAsn: '65123' - localBgpPeeringAddress: '192.168.1.5' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -94,39 +76,11 @@ module localNetworkGateway 'br:bicep/modules/network.local-network-gateway:1.0.0 "value": "8.8.8.8" }, "name": { - "value": "nlngcom001" + "value": "nlngmin001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "localAsn": { - "value": "65123" - }, - "localBgpPeeringAddress": { - "value": "192.168.1.5" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -135,9 +89,9 @@ module localNetworkGateway 'br:bicep/modules/network.local-network-gateway:1.0.0

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -146,16 +100,34 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module localNetworkGateway 'br:bicep/modules/network.local-network-gateway:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nlngmin' + name: '${uniqueString(deployment().name, location)}-test-nlngmax' params: { // Required parameters localAddressPrefixes: [ '192.168.1.0/24' ] localGatewayPublicIpAddress: '8.8.8.8' - name: 'nlngmin001' + name: 'nlngmax001' // Non-required parameters enableDefaultTelemetry: '' + localAsn: '65123' + localBgpPeeringAddress: '192.168.1.5' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -182,11 +154,39 @@ module localNetworkGateway 'br:bicep/modules/network.local-network-gateway:1.0.0 "value": "8.8.8.8" }, "name": { - "value": "nlngmin001" + "value": "nlngmax001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "localAsn": { + "value": "65123" + }, + "localBgpPeeringAddress": { + "value": "192.168.1.5" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } diff --git a/modules/network/nat-gateway/README.md b/modules/network/nat-gateway/README.md index 13c664715f..d848af2b74 100644 --- a/modules/network/nat-gateway/README.md +++ b/modules/network/nat-gateway/README.md @@ -43,10 +43,10 @@ This instance deploys the module with most of its features enabled. ```bicep module natGateway 'br:bicep/modules/network.nat-gateway:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nngcom' + name: '${uniqueString(deployment().name, location)}-test-nngmax' params: { // Required parameters - name: 'nngcom001' + name: 'nngmax001' // Non-required parameters enableDefaultTelemetry: '' lock: { @@ -69,7 +69,7 @@ module natGateway 'br:bicep/modules/network.nat-gateway:1.0.0' = { workspaceResourceId: '' } ] - name: 'nngcom001-pip' + name: 'nngmax001-pip' roleAssignments: [ { principalId: '' @@ -115,7 +115,7 @@ module natGateway 'br:bicep/modules/network.nat-gateway:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "nngcom001" + "value": "nngmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -144,7 +144,7 @@ module natGateway 'br:bicep/modules/network.nat-gateway:1.0.0' = { "workspaceResourceId": "" } ], - "name": "nngcom001-pip", + "name": "nngmax001-pip", "roleAssignments": [ { "principalId": "", diff --git a/modules/network/network-interface/README.md b/modules/network/network-interface/README.md index 2827d18f97..95f9eb34e1 100644 --- a/modules/network/network-interface/README.md +++ b/modules/network/network-interface/README.md @@ -29,10 +29,72 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.network-interface:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module networkInterface 'br:bicep/modules/network.network-interface:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nnimin' + params: { + // Required parameters + ipConfigurations: [ + { + name: 'ipconfig01' + subnetResourceId: '' + } + ] + name: 'nnimin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "ipConfigurations": { + "value": [ + { + "name": "ipconfig01", + "subnetResourceId": "" + } + ] + }, + "name": { + "value": "nnimin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -43,7 +105,7 @@ This instance deploys the module with most of its features enabled. ```bicep module networkInterface 'br:bicep/modules/network.network-interface:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nnicom' + name: '${uniqueString(deployment().name, location)}-test-nnimax' params: { // Required parameters ipConfigurations: [ @@ -70,7 +132,7 @@ module networkInterface 'br:bicep/modules/network.network-interface:1.0.0' = { subnetResourceId: '' } ] - name: 'nnicom001' + name: 'nnimax001' // Non-required parameters diagnosticSettings: [ { @@ -147,7 +209,7 @@ module networkInterface 'br:bicep/modules/network.network-interface:1.0.0' = { ] }, "name": { - "value": "nnicom001" + "value": "nnimax001" }, // Non-required parameters "diagnosticSettings": { @@ -198,68 +260,6 @@ module networkInterface 'br:bicep/modules/network.network-interface:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module networkInterface 'br:bicep/modules/network.network-interface:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nnimin' - params: { - // Required parameters - ipConfigurations: [ - { - name: 'ipconfig01' - subnetResourceId: '' - } - ] - name: 'nnimin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "ipConfigurations": { - "value": [ - { - "name": "ipconfig01", - "subnetResourceId": "" - } - ] - }, - "name": { - "value": "nnimin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/network-manager/README.md b/modules/network/network-manager/README.md index 7f7d82f383..4870ad088b 100644 --- a/modules/network/network-manager/README.md +++ b/modules/network/network-manager/README.md @@ -47,7 +47,7 @@ This instance deploys the module with most of its features enabled. ```bicep module networkManager 'br:bicep/modules/network.network-manager:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nnmcom' + name: '${uniqueString(deployment().name, location)}-test-nnmmax' params: { // Required parameters name: '' diff --git a/modules/network/network-security-group/README.md b/modules/network/network-security-group/README.md index 3aa65e8ff8..f5802ad688 100644 --- a/modules/network/network-security-group/README.md +++ b/modules/network/network-security-group/README.md @@ -28,10 +28,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.network-security-group:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module networkSecurityGroup 'br:bicep/modules/network.network-security-group:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nnsgmin' + params: { + // Required parameters + name: 'nnsgmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nnsgmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,10 +90,10 @@ This instance deploys the module with most of its features enabled. ```bicep module networkSecurityGroup 'br:bicep/modules/network.network-security-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nnsgcom' + name: '${uniqueString(deployment().name, location)}-test-nnsgmax' params: { // Required parameters - name: 'nnsgcom001' + name: 'nnsgmax001' // Non-required parameters diagnosticSettings: [ { @@ -155,7 +203,7 @@ module networkSecurityGroup 'br:bicep/modules/network.network-security-group:1.0 "parameters": { // Required parameters "name": { - "value": "nnsgcom001" + "value": "nnsgmax001" }, // Non-required parameters "diagnosticSettings": { @@ -267,54 +315,6 @@ module networkSecurityGroup 'br:bicep/modules/network.network-security-group:1.0

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module networkSecurityGroup 'br:bicep/modules/network.network-security-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nnsgmin' - params: { - // Required parameters - name: 'nnsgmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nnsgmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/network-watcher/README.md b/modules/network/network-watcher/README.md index 90da9a7ec3..ede8d1e3a8 100644 --- a/modules/network/network-watcher/README.md +++ b/modules/network/network-watcher/README.md @@ -28,10 +28,54 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.network-watcher:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module networkWatcher 'br:bicep/modules/network.network-watcher:1.0.0' = { + name: '${uniqueString(deployment().name, testLocation)}-test-nnwmin' + params: { + enableDefaultTelemetry: '' + location: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + "enableDefaultTelemetry": { + "value": "" + }, + "location": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,7 +86,7 @@ This instance deploys the module with most of its features enabled. ```bicep module networkWatcher 'br:bicep/modules/network.network-watcher:1.0.0' = { - name: '${uniqueString(deployment().name, testLocation)}-test-nnwcom' + name: '${uniqueString(deployment().name, testLocation)}-test-nnwmax' params: { connectionMonitors: [ { @@ -58,7 +102,7 @@ module networkWatcher 'br:bicep/modules/network.network-watcher:1.0.0' = { type: 'ExternalAddress' } ] - name: 'nnwcom-cm-001' + name: 'nnwmax-cm-001' testConfigurations: [ { httpConfiguration: { @@ -106,7 +150,7 @@ module networkWatcher 'br:bicep/modules/network.network-watcher:1.0.0' = { } { formatVersion: 1 - name: 'nnwcom-fl-001' + name: 'nnwmax-fl-001' retentionInDays: 8 storageId: '' targetResourceId: '' @@ -159,7 +203,7 @@ module networkWatcher 'br:bicep/modules/network.network-watcher:1.0.0' = { "type": "ExternalAddress" } ], - "name": "nnwcom-cm-001", + "name": "nnwmax-cm-001", "testConfigurations": [ { "httpConfiguration": { @@ -211,7 +255,7 @@ module networkWatcher 'br:bicep/modules/network.network-watcher:1.0.0' = { }, { "formatVersion": 1, - "name": "nnwcom-fl-001", + "name": "nnwmax-fl-001", "retentionInDays": 8, "storageId": "", "targetResourceId": "", @@ -249,50 +293,6 @@ module networkWatcher 'br:bicep/modules/network.network-watcher:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module networkWatcher 'br:bicep/modules/network.network-watcher:1.0.0' = { - name: '${uniqueString(deployment().name, testLocation)}-test-nnwmin' - params: { - enableDefaultTelemetry: '' - location: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - "enableDefaultTelemetry": { - "value": "" - }, - "location": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/private-dns-zone/README.md b/modules/network/private-dns-zone/README.md index f225228a70..ceb0935638 100644 --- a/modules/network/private-dns-zone/README.md +++ b/modules/network/private-dns-zone/README.md @@ -37,10 +37,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.private-dns-zone:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module privateDnsZone 'br:bicep/modules/network.private-dns-zone:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-npdzmin' + params: { + // Required parameters + name: 'npdzmin001.com' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "npdzmin001.com" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -51,10 +99,10 @@ This instance deploys the module with most of its features enabled. ```bicep module privateDnsZone 'br:bicep/modules/network.private-dns-zone:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-npdzcom' + name: '${uniqueString(deployment().name, location)}-test-npdzmax' params: { // Required parameters - name: 'npdzcom001.com' + name: 'npdzmax001.com' // Non-required parameters a: [ { @@ -242,7 +290,7 @@ module privateDnsZone 'br:bicep/modules/network.private-dns-zone:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "npdzcom001.com" + "value": "npdzmax001.com" }, // Non-required parameters "a": { @@ -446,54 +494,6 @@ module privateDnsZone 'br:bicep/modules/network.private-dns-zone:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module privateDnsZone 'br:bicep/modules/network.private-dns-zone:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-npdzmin' - params: { - // Required parameters - name: 'npdzmin001.com' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "npdzmin001.com" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/private-endpoint/README.md b/modules/network/private-endpoint/README.md index c051e314b3..e23c6bb6b9 100644 --- a/modules/network/private-endpoint/README.md +++ b/modules/network/private-endpoint/README.md @@ -29,10 +29,74 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.private-endpoint:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module privateEndpoint 'br:bicep/modules/network.private-endpoint:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-npemin' + params: { + // Required parameters + groupIds: [ + 'vault' + ] + name: 'npemin001' + serviceResourceId: '' + subnetResourceId: '' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "groupIds": { + "value": [ + "vault" + ] + }, + "name": { + "value": "npemin001" + }, + "serviceResourceId": { + "value": "" + }, + "subnetResourceId": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -43,13 +107,13 @@ This instance deploys the module with most of its features enabled. ```bicep module privateEndpoint 'br:bicep/modules/network.private-endpoint:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-npecom' + name: '${uniqueString(deployment().name, location)}-test-npemax' params: { // Required parameters groupIds: [ 'vault' ] - name: 'npecom001' + name: 'npemax001' serviceResourceId: '' subnetResourceId: '' // Non-required parameters @@ -64,7 +128,7 @@ module privateEndpoint 'br:bicep/modules/network.private-endpoint:1.0.0' = { ] } ] - customNetworkInterfaceName: 'npecom001nic' + customNetworkInterfaceName: 'npemax001nic' enableDefaultTelemetry: '' ipConfigurations: [ { @@ -118,7 +182,7 @@ module privateEndpoint 'br:bicep/modules/network.private-endpoint:1.0.0' = { ] }, "name": { - "value": "npecom001" + "value": "npemax001" }, "serviceResourceId": { "value": "" @@ -143,7 +207,7 @@ module privateEndpoint 'br:bicep/modules/network.private-endpoint:1.0.0' = { ] }, "customNetworkInterfaceName": { - "value": "npecom001nic" + "value": "npemax001nic" }, "enableDefaultTelemetry": { "value": "" @@ -194,70 +258,6 @@ module privateEndpoint 'br:bicep/modules/network.private-endpoint:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module privateEndpoint 'br:bicep/modules/network.private-endpoint:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-npemin' - params: { - // Required parameters - groupIds: [ - 'vault' - ] - name: 'npemin001' - serviceResourceId: '' - subnetResourceId: '' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "groupIds": { - "value": [ - "vault" - ] - }, - "name": { - "value": "npemin001" - }, - "serviceResourceId": { - "value": "" - }, - "subnetResourceId": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/private-link-service/README.md b/modules/network/private-link-service/README.md index 0255a52263..45f9b300e1 100644 --- a/modules/network/private-link-service/README.md +++ b/modules/network/private-link-service/README.md @@ -27,10 +27,92 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.private-link-service:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module privateLinkService 'br:bicep/modules/network.private-link-service:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nplsmin' + params: { + // Required parameters + name: 'nplsmin001' + // Non-required parameters + enableDefaultTelemetry: '' + ipConfigurations: [ + { + name: 'nplsmin01' + properties: { + subnet: { + id: '' + } + } + } + ] + loadBalancerFrontendIpConfigurations: [ + { + id: '' + } + ] + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nplsmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "ipConfigurations": { + "value": [ + { + "name": "nplsmin01", + "properties": { + "subnet": { + "id": "" + } + } + } + ] + }, + "loadBalancerFrontendIpConfigurations": { + "value": [ + { + "id": "" + } + ] + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -41,10 +123,10 @@ This instance deploys the module with most of its features enabled. ```bicep module privateLinkService 'br:bicep/modules/network.private-link-service:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nplscom' + name: '${uniqueString(deployment().name, location)}-test-nplsmax' params: { // Required parameters - name: 'nplscom001' + name: 'nplsmax001' // Non-required parameters autoApproval: { subscriptions: [ @@ -54,12 +136,12 @@ module privateLinkService 'br:bicep/modules/network.private-link-service:1.0.0' enableDefaultTelemetry: '' enableProxyProtocol: true fqdns: [ - 'nplscom.plsfqdn01.azure.privatelinkservice' - 'nplscom.plsfqdn02.azure.privatelinkservice' + 'nplsmax.plsfqdn01.azure.privatelinkservice' + 'nplsmax.plsfqdn02.azure.privatelinkservice' ] ipConfigurations: [ { - name: 'nplscom01' + name: 'nplsmax01' properties: { primary: true privateIPAllocationMethod: 'Dynamic' @@ -113,7 +195,7 @@ module privateLinkService 'br:bicep/modules/network.private-link-service:1.0.0' "parameters": { // Required parameters "name": { - "value": "nplscom001" + "value": "nplsmax001" }, // Non-required parameters "autoApproval": { @@ -131,14 +213,14 @@ module privateLinkService 'br:bicep/modules/network.private-link-service:1.0.0' }, "fqdns": { "value": [ - "nplscom.plsfqdn01.azure.privatelinkservice", - "nplscom.plsfqdn02.azure.privatelinkservice" + "nplsmax.plsfqdn01.azure.privatelinkservice", + "nplsmax.plsfqdn02.azure.privatelinkservice" ] }, "ipConfigurations": { "value": [ { - "name": "nplscom01", + "name": "nplsmax01", "properties": { "primary": true, "privateIPAllocationMethod": "Dynamic", @@ -192,88 +274,6 @@ module privateLinkService 'br:bicep/modules/network.private-link-service:1.0.0'

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module privateLinkService 'br:bicep/modules/network.private-link-service:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nplsmin' - params: { - // Required parameters - name: 'nplsmin001' - // Non-required parameters - enableDefaultTelemetry: '' - ipConfigurations: [ - { - name: 'nplsmin01' - properties: { - subnet: { - id: '' - } - } - } - ] - loadBalancerFrontendIpConfigurations: [ - { - id: '' - } - ] - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nplsmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "ipConfigurations": { - "value": [ - { - "name": "nplsmin01", - "properties": { - "subnet": { - "id": "" - } - } - } - ] - }, - "loadBalancerFrontendIpConfigurations": { - "value": [ - { - "id": "" - } - ] - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/public-ip-address/README.md b/modules/network/public-ip-address/README.md index 8d6d6c6221..a1e26a8374 100644 --- a/modules/network/public-ip-address/README.md +++ b/modules/network/public-ip-address/README.md @@ -29,10 +29,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.public-ip-address:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module publicIpAddress 'br:bicep/modules/network.public-ip-address:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-npiamin' + params: { + // Required parameters + name: 'npiamin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "npiamin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -43,10 +91,10 @@ This instance deploys the module with most of its features enabled. ```bicep module publicIpAddress 'br:bicep/modules/network.public-ip-address:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-npiacom' + name: '${uniqueString(deployment().name, location)}-test-npiamax' params: { // Required parameters - name: 'npiacom001' + name: 'npiamax001' // Non-required parameters diagnosticSettings: [ { @@ -104,7 +152,7 @@ module publicIpAddress 'br:bicep/modules/network.public-ip-address:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "npiacom001" + "value": "npiamax001" }, // Non-required parameters "diagnosticSettings": { @@ -168,54 +216,6 @@ module publicIpAddress 'br:bicep/modules/network.public-ip-address:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module publicIpAddress 'br:bicep/modules/network.public-ip-address:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-npiamin' - params: { - // Required parameters - name: 'npiamin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "npiamin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/public-ip-prefix/README.md b/modules/network/public-ip-prefix/README.md index b9575104a9..efd58740b9 100644 --- a/modules/network/public-ip-prefix/README.md +++ b/modules/network/public-ip-prefix/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.public-ip-prefix:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -40,29 +40,13 @@ This instance deploys the module with most of its features enabled. ```bicep module publicIpPrefix 'br:bicep/modules/network.public-ip-prefix:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-npipcom' + name: '${uniqueString(deployment().name, location)}-test-npipmin' params: { // Required parameters - name: 'npipcom001' + name: 'npipmin001' prefixLength: 28 // Non-required parameters enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -81,7 +65,7 @@ module publicIpPrefix 'br:bicep/modules/network.public-ip-prefix:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "npipcom001" + "value": "npipmin001" }, "prefixLength": { "value": 28 @@ -89,28 +73,6 @@ module publicIpPrefix 'br:bicep/modules/network.public-ip-prefix:1.0.0' = { // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -119,9 +81,9 @@ module publicIpPrefix 'br:bicep/modules/network.public-ip-prefix:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -130,13 +92,29 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module publicIpPrefix 'br:bicep/modules/network.public-ip-prefix:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-npipmin' + name: '${uniqueString(deployment().name, location)}-test-npipmax' params: { // Required parameters - name: 'npipmin001' + name: 'npipmax001' prefixLength: 28 // Non-required parameters enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -155,7 +133,7 @@ module publicIpPrefix 'br:bicep/modules/network.public-ip-prefix:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "npipmin001" + "value": "npipmax001" }, "prefixLength": { "value": 28 @@ -163,6 +141,28 @@ module publicIpPrefix 'br:bicep/modules/network.public-ip-prefix:1.0.0' = { // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } diff --git a/modules/network/route-table/README.md b/modules/network/route-table/README.md index c72d3efdd9..3187ab66e4 100644 --- a/modules/network/route-table/README.md +++ b/modules/network/route-table/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.route-table:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module routeTable 'br:bicep/modules/network.route-table:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nrtmin' + params: { + // Required parameters + name: 'nrtmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nrtmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module routeTable 'br:bicep/modules/network.route-table:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nrtcom' + name: '${uniqueString(deployment().name, location)}-test-nrtmax' params: { // Required parameters - name: 'nrtcom001' + name: 'nrtmax001' // Non-required parameters enableDefaultTelemetry: '' lock: { @@ -90,7 +138,7 @@ module routeTable 'br:bicep/modules/network.route-table:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "nrtcom001" + "value": "nrtmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -137,54 +185,6 @@ module routeTable 'br:bicep/modules/network.route-table:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module routeTable 'br:bicep/modules/network.route-table:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nrtmin' - params: { - // Required parameters - name: 'nrtmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nrtmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/service-endpoint-policy/README.md b/modules/network/service-endpoint-policy/README.md index 84bbf928c5..c97f6b3a41 100644 --- a/modules/network/service-endpoint-policy/README.md +++ b/modules/network/service-endpoint-policy/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.service-endpoint-policy:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module serviceEndpointPolicy 'br:bicep/modules/network.service-endpoint-policy:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nsnpmin' + params: { + // Required parameters + name: 'nsnpmin-001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nsnpmin-001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module serviceEndpointPolicy 'br:bicep/modules/network.service-endpoint-policy:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nsnpcom' + name: '${uniqueString(deployment().name, location)}-test-nsnpmax' params: { // Required parameters - name: 'nsnpcom-001' + name: 'nsnpmax-001' // Non-required parameters enableDefaultTelemetry: '' lock: { @@ -93,7 +141,7 @@ module serviceEndpointPolicy 'br:bicep/modules/network.service-endpoint-policy:1 "parameters": { // Required parameters "name": { - "value": "nsnpcom-001" + "value": "nsnpmax-001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -143,54 +191,6 @@ module serviceEndpointPolicy 'br:bicep/modules/network.service-endpoint-policy:1

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module serviceEndpointPolicy 'br:bicep/modules/network.service-endpoint-policy:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nsnpmin' - params: { - // Required parameters - name: 'nsnpmin-001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nsnpmin-001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/trafficmanagerprofile/README.md b/modules/network/trafficmanagerprofile/README.md index e1247c8513..07d77ebdb1 100644 --- a/modules/network/trafficmanagerprofile/README.md +++ b/modules/network/trafficmanagerprofile/README.md @@ -28,10 +28,62 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.trafficmanagerprofile:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module trafficmanagerprofile 'br:bicep/modules/network.trafficmanagerprofile:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-ntmpmin' + params: { + // Required parameters + name: '' + relativeName: '' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "" + }, + "relativeName": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,7 +94,7 @@ This instance deploys the module with most of its features enabled. ```bicep module trafficmanagerprofile 'br:bicep/modules/network.trafficmanagerprofile:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ntmpcom' + name: '${uniqueString(deployment().name, location)}-test-ntmpmax' params: { // Required parameters name: '' @@ -151,58 +203,6 @@ module trafficmanagerprofile 'br:bicep/modules/network.trafficmanagerprofile:1.0

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module trafficmanagerprofile 'br:bicep/modules/network.trafficmanagerprofile:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ntmpmin' - params: { - // Required parameters - name: '' - relativeName: '' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "" - }, - "relativeName": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/virtual-hub/README.md b/modules/network/virtual-hub/README.md index 9d543ddf8f..794271f0ac 100644 --- a/modules/network/virtual-hub/README.md +++ b/modules/network/virtual-hub/README.md @@ -28,10 +28,66 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.virtual-hub:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module virtualHub 'br:bicep/modules/network.virtual-hub:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nvhmin' + params: { + // Required parameters + addressPrefix: '10.0.0.0/16' + name: 'nvhmin' + virtualWanId: '' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "addressPrefix": { + "value": "10.0.0.0/16" + }, + "name": { + "value": "nvhmin" + }, + "virtualWanId": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,11 +98,11 @@ This instance deploys the module with most of its features enabled. ```bicep module virtualHub 'br:bicep/modules/network.virtual-hub:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvhcom' + name: '${uniqueString(deployment().name, location)}-test-nvhmax' params: { // Required parameters addressPrefix: '10.1.0.0/16' - name: 'nvhcom' + name: 'nvhmax' virtualWanId: '' // Non-required parameters enableDefaultTelemetry: '' @@ -106,7 +162,7 @@ module virtualHub 'br:bicep/modules/network.virtual-hub:1.0.0' = { "value": "10.1.0.0/16" }, "name": { - "value": "nvhcom" + "value": "nvhmax" }, "virtualWanId": { "value": "" @@ -165,62 +221,6 @@ module virtualHub 'br:bicep/modules/network.virtual-hub:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module virtualHub 'br:bicep/modules/network.virtual-hub:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvhmin' - params: { - // Required parameters - addressPrefix: '10.0.0.0/16' - name: 'nvhmin' - virtualWanId: '' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "addressPrefix": { - "value": "10.0.0.0/16" - }, - "name": { - "value": "nvhmin" - }, - "virtualWanId": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/virtual-network/README.md b/modules/network/virtual-network/README.md index c001ac80f3..07083c6cf7 100644 --- a/modules/network/virtual-network/README.md +++ b/modules/network/virtual-network/README.md @@ -30,11 +30,67 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.virtual-network:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) - [Vnetpeering](#example-3-vnetpeering) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module virtualNetwork 'br:bicep/modules/network.virtual-network:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nvnmin' + params: { + // Required parameters + addressPrefixes: [ + '10.0.0.0/16' + ] + name: 'nvnmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "addressPrefixes": { + "value": [ + "10.0.0.0/16" + ] + }, + "name": { + "value": "nvnmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -45,13 +101,13 @@ This instance deploys the module with most of its features enabled. ```bicep module virtualNetwork 'br:bicep/modules/network.virtual-network:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvncom' + name: '${uniqueString(deployment().name, location)}-test-nvnmax' params: { // Required parameters addressPrefixes: [ '' ] - name: 'nvncom001' + name: 'nvnmax001' // Non-required parameters diagnosticSettings: [ { @@ -157,7 +213,7 @@ module virtualNetwork 'br:bicep/modules/network.virtual-network:1.0.0' = { ] }, "name": { - "value": "nvncom001" + "value": "nvnmax001" }, // Non-required parameters "diagnosticSettings": { @@ -264,62 +320,6 @@ module virtualNetwork 'br:bicep/modules/network.virtual-network:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module virtualNetwork 'br:bicep/modules/network.virtual-network:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvnmin' - params: { - // Required parameters - addressPrefixes: [ - '10.0.0.0/16' - ] - name: 'nvnmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "addressPrefixes": { - "value": [ - "10.0.0.0/16" - ] - }, - "name": { - "value": "nvnmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ### Example 3: _Vnetpeering_

diff --git a/modules/network/virtual-wan/README.md b/modules/network/virtual-wan/README.md index 1d107f2932..2837b5d97c 100644 --- a/modules/network/virtual-wan/README.md +++ b/modules/network/virtual-wan/README.md @@ -26,10 +26,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.virtual-wan:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module virtualWan 'br:bicep/modules/network.virtual-wan:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nvwmin' + params: { + // Required parameters + name: 'nvwmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nvwmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -40,10 +88,10 @@ This instance deploys the module with most of its features enabled. ```bicep module virtualWan 'br:bicep/modules/network.virtual-wan:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvwcom' + name: '${uniqueString(deployment().name, location)}-test-nvwmax' params: { // Required parameters - name: 'nvwcom001' + name: 'nvwmax001' // Non-required parameters allowBranchToBranchTraffic: true allowVnetToVnetTraffic: true @@ -84,7 +132,7 @@ module virtualWan 'br:bicep/modules/network.virtual-wan:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "nvwcom001" + "value": "nvwmax001" }, // Non-required parameters "allowBranchToBranchTraffic": { @@ -131,54 +179,6 @@ module virtualWan 'br:bicep/modules/network.virtual-wan:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module virtualWan 'br:bicep/modules/network.virtual-wan:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvwmin' - params: { - // Required parameters - name: 'nvwmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nvwmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/vpn-gateway/README.md b/modules/network/vpn-gateway/README.md index 8ad433891d..e8936ad31c 100644 --- a/modules/network/vpn-gateway/README.md +++ b/modules/network/vpn-gateway/README.md @@ -28,10 +28,62 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.vpn-gateway:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module vpnGateway 'br:bicep/modules/network.vpn-gateway:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nvgmin' + params: { + // Required parameters + name: 'nvgmin001' + virtualHubResourceId: '' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nvgmin001" + }, + "virtualHubResourceId": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,10 +94,10 @@ This instance deploys the module with most of its features enabled. ```bicep module vpnGateway 'br:bicep/modules/network.vpn-gateway:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvgcom' + name: '${uniqueString(deployment().name, location)}-test-nvgmax' params: { // Required parameters - name: 'nvgcom001' + name: 'nvgmax001' virtualHubResourceId: '' // Non-required parameters bgpSettings: { @@ -111,7 +163,7 @@ module vpnGateway 'br:bicep/modules/network.vpn-gateway:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "nvgcom001" + "value": "nvgmax001" }, "virtualHubResourceId": { "value": "" @@ -181,58 +233,6 @@ module vpnGateway 'br:bicep/modules/network.vpn-gateway:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module vpnGateway 'br:bicep/modules/network.vpn-gateway:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvgmin' - params: { - // Required parameters - name: 'nvgmin001' - virtualHubResourceId: '' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nvgmin001" - }, - "virtualHubResourceId": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/network/vpn-site/README.md b/modules/network/vpn-site/README.md index b6da21771a..949d02fd41 100644 --- a/modules/network/vpn-site/README.md +++ b/modules/network/vpn-site/README.md @@ -27,10 +27,74 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.vpn-site:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module vpnSite 'br:bicep/modules/network.vpn-site:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-nvsmin' + params: { + // Required parameters + name: 'nvsmin' + virtualWanId: '' + // Non-required parameters + addressPrefixes: [ + '10.0.0.0/16' + ] + enableDefaultTelemetry: '' + ipAddress: '1.2.3.4' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "nvsmin" + }, + "virtualWanId": { + "value": "" + }, + // Non-required parameters + "addressPrefixes": { + "value": [ + "10.0.0.0/16" + ] + }, + "enableDefaultTelemetry": { + "value": "" + }, + "ipAddress": { + "value": "1.2.3.4" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -41,10 +105,10 @@ This instance deploys the module with most of its features enabled. ```bicep module vpnSite 'br:bicep/modules/network.vpn-site:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvscom' + name: '${uniqueString(deployment().name, location)}-test-nvsmax' params: { // Required parameters - name: 'nvscom' + name: 'nvsmax' virtualWanId: '' // Non-required parameters deviceProperties: { @@ -76,7 +140,7 @@ module vpnSite 'br:bicep/modules/network.vpn-site:1.0.0' = { } vpnSiteLinks: [ { - name: 'vSite-nvscom' + name: 'vSite-nvsmax' properties: { bgpProperties: { asn: 65010 @@ -122,7 +186,7 @@ module vpnSite 'br:bicep/modules/network.vpn-site:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "nvscom" + "value": "nvsmax" }, "virtualWanId": { "value": "" @@ -170,7 +234,7 @@ module vpnSite 'br:bicep/modules/network.vpn-site:1.0.0' = { "vpnSiteLinks": { "value": [ { - "name": "vSite-nvscom", + "name": "vSite-nvsmax", "properties": { "bgpProperties": { "asn": 65010, @@ -206,70 +270,6 @@ module vpnSite 'br:bicep/modules/network.vpn-site:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module vpnSite 'br:bicep/modules/network.vpn-site:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-nvsmin' - params: { - // Required parameters - name: 'nvsmin' - virtualWanId: '' - // Non-required parameters - addressPrefixes: [ - '10.0.0.0/16' - ] - enableDefaultTelemetry: '' - ipAddress: '1.2.3.4' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "nvsmin" - }, - "virtualWanId": { - "value": "" - }, - // Non-required parameters - "addressPrefixes": { - "value": [ - "10.0.0.0/16" - ] - }, - "enableDefaultTelemetry": { - "value": "" - }, - "ipAddress": { - "value": "1.2.3.4" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/operational-insights/workspace/README.md b/modules/operational-insights/workspace/README.md index 02c536f329..cac8424e47 100644 --- a/modules/operational-insights/workspace/README.md +++ b/modules/operational-insights/workspace/README.md @@ -36,8 +36,8 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/operational-insights.workspace:1.0.0`. - [Adv](#example-1-adv) -- [Using large parameter set](#example-2-using-large-parameter-set) -- [Using only defaults](#example-3-using-only-defaults) +- [Using only defaults](#example-2-using-only-defaults) +- [Using large parameter set](#example-3-using-large-parameter-set) ### Example 1: _Adv_ @@ -592,7 +592,55 @@ module workspace 'br:bicep/modules/operational-insights.workspace:1.0.0' = {

-### Example 2: _Using large parameter set_ +### Example 2: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module workspace 'br:bicep/modules/operational-insights.workspace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-oiwmin' + params: { + // Required parameters + name: 'oiwmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "oiwmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -603,10 +651,10 @@ This instance deploys the module with most of its features enabled. ```bicep module workspace 'br:bicep/modules/operational-insights.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-oiwcom' + name: '${uniqueString(deployment().name, location)}-test-oiwmax' params: { // Required parameters - name: 'oiwcom001' + name: 'oiwmax001' // Non-required parameters dailyQuotaGb: 10 dataSources: [ @@ -792,7 +840,7 @@ module workspace 'br:bicep/modules/operational-insights.workspace:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "oiwcom001" + "value": "oiwmax001" }, // Non-required parameters "dailyQuotaGb": { @@ -1000,54 +1048,6 @@ module workspace 'br:bicep/modules/operational-insights.workspace:1.0.0' = {

-### Example 3: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module workspace 'br:bicep/modules/operational-insights.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-oiwmin' - params: { - // Required parameters - name: 'oiwmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "oiwmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/power-bi-dedicated/capacity/README.md b/modules/power-bi-dedicated/capacity/README.md index b70a3883f6..4e238f87bd 100644 --- a/modules/power-bi-dedicated/capacity/README.md +++ b/modules/power-bi-dedicated/capacity/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/power-bi-dedicated.capacity:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -40,32 +40,16 @@ This instance deploys the module with most of its features enabled. ```bicep module capacity 'br:bicep/modules/power-bi-dedicated.capacity:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-pbdcapcom' + name: '${uniqueString(deployment().name, location)}-test-pbdcapmin' params: { // Required parameters members: [ '' ] - name: 'pbdcapcom001' + name: 'pbdcapmin001' skuCapacity: 1 // Non-required parameters enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -89,7 +73,7 @@ module capacity 'br:bicep/modules/power-bi-dedicated.capacity:1.0.0' = { ] }, "name": { - "value": "pbdcapcom001" + "value": "pbdcapmin001" }, "skuCapacity": { "value": 1 @@ -97,28 +81,6 @@ module capacity 'br:bicep/modules/power-bi-dedicated.capacity:1.0.0' = { // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -127,9 +89,9 @@ module capacity 'br:bicep/modules/power-bi-dedicated.capacity:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -138,16 +100,32 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module capacity 'br:bicep/modules/power-bi-dedicated.capacity:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-pbdcapmin' + name: '${uniqueString(deployment().name, location)}-test-pbdcapmax' params: { // Required parameters members: [ '' ] - name: 'pbdcapmin001' + name: 'pbdcapmax001' skuCapacity: 1 // Non-required parameters enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -171,7 +149,7 @@ module capacity 'br:bicep/modules/power-bi-dedicated.capacity:1.0.0' = { ] }, "name": { - "value": "pbdcapmin001" + "value": "pbdcapmax001" }, "skuCapacity": { "value": 1 @@ -179,6 +157,28 @@ module capacity 'br:bicep/modules/power-bi-dedicated.capacity:1.0.0' = { // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } diff --git a/modules/purview/account/README.md b/modules/purview/account/README.md index 7d2d34a463..0110965dca 100644 --- a/modules/purview/account/README.md +++ b/modules/purview/account/README.md @@ -29,10 +29,62 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/purview.account:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module account 'br:bicep/modules/purview.account:1.0.0' = { + name: '${uniqueString(deployment().name)}-test-pvamin' + params: { + // Required parameters + name: 'pvamin001' + // Non-required parameters + enableDefaultTelemetry: '' + managedResourceGroupName: 'pvamin001-managed-rg' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "pvamin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "managedResourceGroupName": { + "value": "pvamin001-managed-rg" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -43,10 +95,10 @@ This instance deploys the module with most of its features enabled. ```bicep module account 'br:bicep/modules/purview.account:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-pvacom' + name: '${uniqueString(deployment().name)}-test-pvamax' params: { // Required parameters - name: 'pvacom001' + name: 'pvamax001' // Non-required parameters accountPrivateEndpoints: [ { @@ -101,7 +153,7 @@ module account 'br:bicep/modules/purview.account:1.0.0' = { '' ] } - managedResourceGroupName: 'pvacom001-managed-rg' + managedResourceGroupName: 'pvamax001-managed-rg' portalPrivateEndpoints: [ { privateDnsZoneResourceIds: [ @@ -175,7 +227,7 @@ module account 'br:bicep/modules/purview.account:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "pvacom001" + "value": "pvamax001" }, // Non-required parameters "accountPrivateEndpoints": { @@ -246,7 +298,7 @@ module account 'br:bicep/modules/purview.account:1.0.0' = { } }, "managedResourceGroupName": { - "value": "pvacom001-managed-rg" + "value": "pvamax001-managed-rg" }, "portalPrivateEndpoints": { "value": [ @@ -322,58 +374,6 @@ module account 'br:bicep/modules/purview.account:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module account 'br:bicep/modules/purview.account:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-pvamin' - params: { - // Required parameters - name: 'pvamin001' - // Non-required parameters - enableDefaultTelemetry: '' - managedResourceGroupName: 'pvamin001-managed-rg' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "pvamin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "managedResourceGroupName": { - "value": "pvamin001-managed-rg" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/recovery-services/vault/README.md b/modules/recovery-services/vault/README.md index 1cf6b13205..0f801f9e45 100644 --- a/modules/recovery-services/vault/README.md +++ b/modules/recovery-services/vault/README.md @@ -39,11 +39,230 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/recovery-services.vault:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Dr](#example-3-dr) +- [Using only defaults](#example-1-using-only-defaults) +- [Dr](#example-2-dr) +- [Using large parameter set](#example-3-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module vault 'br:bicep/modules/recovery-services.vault:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-rsvmin' + params: { + // Required parameters + name: 'rsvmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "rsvmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Dr_ + +

+ +via Bicep module + +```bicep +module vault 'br:bicep/modules/recovery-services.vault:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-rsvdr' + params: { + // Required parameters + name: '' + // Non-required parameters + enableDefaultTelemetry: '' + replicationFabrics: [ + { + location: 'NorthEurope' + replicationContainers: [ + { + name: 'ne-container1' + replicationContainerMappings: [ + { + policyName: 'Default_values' + targetContainerName: 'pluto' + targetProtectionContainerId: '' + } + ] + } + { + name: 'ne-container2' + replicationContainerMappings: [ + { + policyName: 'Default_values' + targetContainerFabricName: 'WE-2' + targetContainerName: 'we-container1' + } + ] + } + ] + } + { + location: 'WestEurope' + name: 'WE-2' + replicationContainers: [ + { + name: 'we-container1' + replicationContainerMappings: [ + { + policyName: 'Default_values' + targetContainerFabricName: 'NorthEurope' + targetContainerName: 'ne-container2' + } + ] + } + ] + } + ] + replicationPolicies: [ + { + name: 'Default_values' + } + { + appConsistentFrequencyInMinutes: 240 + crashConsistentFrequencyInMinutes: 7 + multiVmSyncStatus: 'Disable' + name: 'Custom_values' + recoveryPointHistory: 2880 + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "replicationFabrics": { + "value": [ + { + "location": "NorthEurope", + "replicationContainers": [ + { + "name": "ne-container1", + "replicationContainerMappings": [ + { + "policyName": "Default_values", + "targetContainerName": "pluto", + "targetProtectionContainerId": "" + } + ] + }, + { + "name": "ne-container2", + "replicationContainerMappings": [ + { + "policyName": "Default_values", + "targetContainerFabricName": "WE-2", + "targetContainerName": "we-container1" + } + ] + } + ] + }, + { + "location": "WestEurope", + "name": "WE-2", + "replicationContainers": [ + { + "name": "we-container1", + "replicationContainerMappings": [ + { + "policyName": "Default_values", + "targetContainerFabricName": "NorthEurope", + "targetContainerName": "ne-container2" + } + ] + } + ] + } + ] + }, + "replicationPolicies": { + "value": [ + { + "name": "Default_values" + }, + { + "appConsistentFrequencyInMinutes": 240, + "crashConsistentFrequencyInMinutes": 7, + "multiVmSyncStatus": "Disable", + "name": "Custom_values", + "recoveryPointHistory": 2880 + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -54,10 +273,10 @@ This instance deploys the module with most of its features enabled. ```bicep module vault 'br:bicep/modules/recovery-services.vault:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-rsvcom' + name: '${uniqueString(deployment().name, location)}-test-rsvmax' params: { // Required parameters - name: 'rsvcom001' + name: 'rsvmax001' // Non-required parameters backupConfig: { enhancedSecurityState: 'Disabled' @@ -385,7 +604,7 @@ module vault 'br:bicep/modules/recovery-services.vault:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "rsvcom001" + "value": "rsvmax001" }, // Non-required parameters "backupConfig": { @@ -729,225 +948,6 @@ module vault 'br:bicep/modules/recovery-services.vault:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module vault 'br:bicep/modules/recovery-services.vault:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-rsvmin' - params: { - // Required parameters - name: 'rsvmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "rsvmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Dr_ - -

- -via Bicep module - -```bicep -module vault 'br:bicep/modules/recovery-services.vault:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-rsvdr' - params: { - // Required parameters - name: '' - // Non-required parameters - enableDefaultTelemetry: '' - replicationFabrics: [ - { - location: 'NorthEurope' - replicationContainers: [ - { - name: 'ne-container1' - replicationContainerMappings: [ - { - policyName: 'Default_values' - targetContainerName: 'pluto' - targetProtectionContainerId: '' - } - ] - } - { - name: 'ne-container2' - replicationContainerMappings: [ - { - policyName: 'Default_values' - targetContainerFabricName: 'WE-2' - targetContainerName: 'we-container1' - } - ] - } - ] - } - { - location: 'WestEurope' - name: 'WE-2' - replicationContainers: [ - { - name: 'we-container1' - replicationContainerMappings: [ - { - policyName: 'Default_values' - targetContainerFabricName: 'NorthEurope' - targetContainerName: 'ne-container2' - } - ] - } - ] - } - ] - replicationPolicies: [ - { - name: 'Default_values' - } - { - appConsistentFrequencyInMinutes: 240 - crashConsistentFrequencyInMinutes: 7 - multiVmSyncStatus: 'Disable' - name: 'Custom_values' - recoveryPointHistory: 2880 - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "replicationFabrics": { - "value": [ - { - "location": "NorthEurope", - "replicationContainers": [ - { - "name": "ne-container1", - "replicationContainerMappings": [ - { - "policyName": "Default_values", - "targetContainerName": "pluto", - "targetProtectionContainerId": "" - } - ] - }, - { - "name": "ne-container2", - "replicationContainerMappings": [ - { - "policyName": "Default_values", - "targetContainerFabricName": "WE-2", - "targetContainerName": "we-container1" - } - ] - } - ] - }, - { - "location": "WestEurope", - "name": "WE-2", - "replicationContainers": [ - { - "name": "we-container1", - "replicationContainerMappings": [ - { - "policyName": "Default_values", - "targetContainerFabricName": "NorthEurope", - "targetContainerName": "ne-container2" - } - ] - } - ] - } - ] - }, - "replicationPolicies": { - "value": [ - { - "name": "Default_values" - }, - { - "appConsistentFrequencyInMinutes": 240, - "crashConsistentFrequencyInMinutes": 7, - "multiVmSyncStatus": "Disable", - "name": "Custom_values", - "recoveryPointHistory": 2880 - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/relay/namespace/README.md b/modules/relay/namespace/README.md index 8266783dca..f7f4a331ec 100644 --- a/modules/relay/namespace/README.md +++ b/modules/relay/namespace/README.md @@ -35,11 +35,59 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/relay.namespace:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) - [Pe](#example-3-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-rnmin' + params: { + // Required parameters + name: 'rnmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "rnmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -50,10 +98,10 @@ This instance deploys the module with most of its features enabled. ```bicep module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-rncom' + name: '${uniqueString(deployment().name, location)}-test-rnmax' params: { // Required parameters - name: 'rncom001' + name: 'rnmax001' // Non-required parameters authorizationRules: [ { @@ -89,7 +137,7 @@ module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { enableDefaultTelemetry: '' hybridConnections: [ { - name: 'rncomhc001' + name: 'rnmaxhc001' roleAssignments: [ { principalId: '' @@ -155,7 +203,7 @@ module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { } wcfRelays: [ { - name: 'rncomwcf001' + name: 'rnmaxwcf001' relayType: 'NetTcp' roleAssignments: [ { @@ -184,7 +232,7 @@ module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "rncom001" + "value": "rnmax001" }, // Non-required parameters "authorizationRules": { @@ -228,7 +276,7 @@ module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { "hybridConnections": { "value": [ { - "name": "rncomhc001", + "name": "rnmaxhc001", "roleAssignments": [ { "principalId": "", @@ -308,7 +356,7 @@ module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { "wcfRelays": { "value": [ { - "name": "rncomwcf001", + "name": "rnmaxwcf001", "relayType": "NetTcp", "roleAssignments": [ { @@ -327,54 +375,6 @@ module namespace 'br:bicep/modules/relay.namespace:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-rnmin' - params: { - // Required parameters - name: 'rnmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "rnmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ### Example 3: _Pe_

diff --git a/modules/resource-graph/query/README.md b/modules/resource-graph/query/README.md index d471c82a90..b0a81c470e 100644 --- a/modules/resource-graph/query/README.md +++ b/modules/resource-graph/query/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/resource-graph.query:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -40,30 +40,13 @@ This instance deploys the module with most of its features enabled. ```bicep module query 'br:bicep/modules/resource-graph.query:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-rgqcom' + name: '${uniqueString(deployment().name, location)}-test-rgqmin' params: { // Required parameters - name: 'rgqcom001' + name: 'rgqmin001' query: 'resources | take 10' // Non-required parameters enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - queryDescription: 'An example query to list first 10 resources in the subscription.' - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -82,7 +65,7 @@ module query 'br:bicep/modules/resource-graph.query:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "rgqcom001" + "value": "rgqmin001" }, "query": { "value": "resources | take 10" @@ -90,31 +73,6 @@ module query 'br:bicep/modules/resource-graph.query:1.0.0' = { // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "queryDescription": { - "value": "An example query to list first 10 resources in the subscription." - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -123,9 +81,9 @@ module query 'br:bicep/modules/resource-graph.query:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -134,13 +92,30 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module query 'br:bicep/modules/resource-graph.query:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-rgqmin' + name: '${uniqueString(deployment().name, location)}-test-rgqmax' params: { // Required parameters - name: 'rgqmin001' + name: 'rgqmax001' query: 'resources | take 10' // Non-required parameters enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + queryDescription: 'An example query to list first 10 resources in the subscription.' + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -159,7 +134,7 @@ module query 'br:bicep/modules/resource-graph.query:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "rgqmin001" + "value": "rgqmax001" }, "query": { "value": "resources | take 10" @@ -167,6 +142,31 @@ module query 'br:bicep/modules/resource-graph.query:1.0.0' = { // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "queryDescription": { + "value": "An example query to list first 10 resources in the subscription." + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } diff --git a/modules/resources/resource-group/README.md b/modules/resources/resource-group/README.md index ed5414c1bc..e80ab43762 100644 --- a/modules/resources/resource-group/README.md +++ b/modules/resources/resource-group/README.md @@ -26,12 +26,12 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/resources.resource-group:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.
@@ -40,28 +40,12 @@ This instance deploys the module with most of its features enabled. ```bicep module resourceGroup 'br:bicep/modules/resources.resource-group:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-rrgcom' + name: '${uniqueString(deployment().name)}-test-rrgmin' params: { // Required parameters - name: 'rrgcom001' + name: 'rrgmin001' // Non-required parameters enableDefaultTelemetry: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } } } ``` @@ -80,33 +64,11 @@ module resourceGroup 'br:bicep/modules/resources.resource-group:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "rrgcom001" + "value": "rrgmin001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } } } } @@ -115,9 +77,9 @@ module resourceGroup 'br:bicep/modules/resources.resource-group:1.0.0' = {

-### Example 2: _Using only defaults_ +### Example 2: _Using large parameter set_ -This instance deploys the module with the minimum set of required parameters. +This instance deploys the module with most of its features enabled.

@@ -126,12 +88,28 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module resourceGroup 'br:bicep/modules/resources.resource-group:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-rrgmin' + name: '${uniqueString(deployment().name, location)}-test-rrgmax' params: { // Required parameters - name: 'rrgmin001' + name: 'rrgmax001' // Non-required parameters enableDefaultTelemetry: '' + lock: { + kind: 'CanNotDelete' + name: 'myCustomLockName' + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -150,11 +128,33 @@ module resourceGroup 'br:bicep/modules/resources.resource-group:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "rrgmin001" + "value": "rrgmax001" }, // Non-required parameters "enableDefaultTelemetry": { "value": "" + }, + "lock": { + "value": { + "kind": "CanNotDelete", + "name": "myCustomLockName" + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } diff --git a/modules/search/search-service/README.md b/modules/search/search-service/README.md index 80e140f944..3a6fe2f628 100644 --- a/modules/search/search-service/README.md +++ b/modules/search/search-service/README.md @@ -30,11 +30,59 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/search.search-service:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) - [Pe](#example-3-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module searchService 'br:bicep/modules/search.search-service:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-sssmin' + params: { + // Required parameters + name: 'sssmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "sssmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -45,10 +93,10 @@ This instance deploys the module with most of its features enabled. ```bicep module searchService 'br:bicep/modules/search.search-service:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ssscom' + name: '${uniqueString(deployment().name, location)}-test-sssmax' params: { // Required parameters - name: 'ssscom001' + name: 'sssmax001' // Non-required parameters authOptions: { aadOrApiKey: { @@ -128,7 +176,7 @@ module searchService 'br:bicep/modules/search.search-service:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "ssscom001" + "value": "sssmax001" }, // Non-required parameters "authOptions": { @@ -226,54 +274,6 @@ module searchService 'br:bicep/modules/search.search-service:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module searchService 'br:bicep/modules/search.search-service:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sssmin' - params: { - // Required parameters - name: 'sssmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "sssmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ### Example 3: _Pe_

diff --git a/modules/security/azure-security-center/README.md b/modules/security/azure-security-center/README.md index 042f824136..ea0247aee2 100644 --- a/modules/security/azure-security-center/README.md +++ b/modules/security/azure-security-center/README.md @@ -42,7 +42,7 @@ This instance deploys the module with most of its features enabled. ```bicep module azureSecurityCenter 'br:bicep/modules/security.azure-security-center:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sasccom' + name: '${uniqueString(deployment().name, location)}-test-sascmax' params: { // Required parameters workspaceId: '' diff --git a/modules/service-bus/namespace/README.md b/modules/service-bus/namespace/README.md index 924bde7a97..60aef288fd 100644 --- a/modules/service-bus/namespace/README.md +++ b/modules/service-bus/namespace/README.md @@ -37,12 +37,241 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/service-bus.namespace:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) - [Pe](#example-4-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-sbnmin' + params: { + // Required parameters + name: 'sbnmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "sbnmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-sbnencr' + params: { + // Required parameters + name: 'sbnencr001' + // Non-required parameters + authorizationRules: [ + { + name: 'RootManageSharedAccessKey' + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + { + name: 'AnotherKey' + rights: [ + 'Listen' + 'Send' + ] + } + ] + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + userAssignedIdentityResourceId: '' + } + enableDefaultTelemetry: '' + managedIdentities: { + systemAssigned: false + userAssignedResourcesIds: [ + '' + ] + } + networkRuleSets: { + defaultAction: 'Deny' + ipRules: [ + { + action: 'Allow' + ipMask: '10.0.1.0/32' + } + { + action: 'Allow' + ipMask: '10.0.2.0/32' + } + ] + trustedServiceAccessEnabled: true + virtualNetworkRules: [ + { + ignoreMissingVnetServiceEndpoint: true + subnetResourceId: '' + } + ] + } + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + skuName: 'Premium' + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "sbnencr001" + }, + // Non-required parameters + "authorizationRules": { + "value": [ + { + "name": "RootManageSharedAccessKey", + "rights": [ + "Listen", + "Manage", + "Send" + ] + }, + { + "name": "AnotherKey", + "rights": [ + "Listen", + "Send" + ] + } + ] + }, + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" + } + }, + "enableDefaultTelemetry": { + "value": "" + }, + "managedIdentities": { + "value": { + "systemAssigned": false, + "userAssignedResourcesIds": [ + "" + ] + } + }, + "networkRuleSets": { + "value": { + "defaultAction": "Deny", + "ipRules": [ + { + "action": "Allow", + "ipMask": "10.0.1.0/32" + }, + { + "action": "Allow", + "ipMask": "10.0.2.0/32" + } + ], + "trustedServiceAccessEnabled": true, + "virtualNetworkRules": [ + { + "ignoreMissingVnetServiceEndpoint": true, + "subnetResourceId": "" + } + ] + } + }, + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "skuName": { + "value": "Premium" + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -53,10 +282,10 @@ This instance deploys the module with most of its features enabled. ```bicep module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sbncom' + name: '${uniqueString(deployment().name, location)}-test-sbnmax' params: { // Required parameters - name: 'sbncom001' + name: 'sbnmax001' // Non-required parameters authorizationRules: [ { @@ -159,7 +388,7 @@ module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { ] autoDeleteOnIdle: 'PT5M' maxMessageSizeInKilobytes: 2048 - name: 'sbncomq001' + name: 'sbnmaxq001' roleAssignments: [ { principalId: '' @@ -202,7 +431,7 @@ module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { ] } ] - name: 'sbncomt001' + name: 'sbnmaxt001' roleAssignments: [ { principalId: '' @@ -231,7 +460,7 @@ module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "sbncom001" + "value": "sbnmax001" }, // Non-required parameters "authorizationRules": { @@ -358,7 +587,7 @@ module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { ], "autoDeleteOnIdle": "PT5M", "maxMessageSizeInKilobytes": 2048, - "name": "sbncomq001", + "name": "sbnmaxq001", "roleAssignments": [ { "principalId": "", @@ -411,7 +640,7 @@ module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { ] } ], - "name": "sbncomt001", + "name": "sbnmaxt001", "roleAssignments": [ { "principalId": "", @@ -432,235 +661,6 @@ module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sbnmin' - params: { - // Required parameters - name: 'sbnmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "sbnmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Encr_ - -

- -via Bicep module - -```bicep -module namespace 'br:bicep/modules/service-bus.namespace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sbnencr' - params: { - // Required parameters - name: 'sbnencr001' - // Non-required parameters - authorizationRules: [ - { - name: 'RootManageSharedAccessKey' - rights: [ - 'Listen' - 'Manage' - 'Send' - ] - } - { - name: 'AnotherKey' - rights: [ - 'Listen' - 'Send' - ] - } - ] - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } - enableDefaultTelemetry: '' - managedIdentities: { - systemAssigned: false - userAssignedResourcesIds: [ - '' - ] - } - networkRuleSets: { - defaultAction: 'Deny' - ipRules: [ - { - action: 'Allow' - ipMask: '10.0.1.0/32' - } - { - action: 'Allow' - ipMask: '10.0.2.0/32' - } - ] - trustedServiceAccessEnabled: true - virtualNetworkRules: [ - { - ignoreMissingVnetServiceEndpoint: true - subnetResourceId: '' - } - ] - } - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - skuName: 'Premium' - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "sbnencr001" - }, - // Non-required parameters - "authorizationRules": { - "value": [ - { - "name": "RootManageSharedAccessKey", - "rights": [ - "Listen", - "Manage", - "Send" - ] - }, - { - "name": "AnotherKey", - "rights": [ - "Listen", - "Send" - ] - } - ] - }, - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } - }, - "enableDefaultTelemetry": { - "value": "" - }, - "managedIdentities": { - "value": { - "systemAssigned": false, - "userAssignedResourcesIds": [ - "" - ] - } - }, - "networkRuleSets": { - "value": { - "defaultAction": "Deny", - "ipRules": [ - { - "action": "Allow", - "ipMask": "10.0.1.0/32" - }, - { - "action": "Allow", - "ipMask": "10.0.2.0/32" - } - ], - "trustedServiceAccessEnabled": true, - "virtualNetworkRules": [ - { - "ignoreMissingVnetServiceEndpoint": true, - "subnetResourceId": "" - } - ] - } - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "skuName": { - "value": "Premium" - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - } -} -``` - -
-

- ### Example 4: _Pe_

diff --git a/modules/service-fabric/cluster/README.md b/modules/service-fabric/cluster/README.md index 4f8ed6b890..ff6dbe1f65 100644 --- a/modules/service-fabric/cluster/README.md +++ b/modules/service-fabric/cluster/README.md @@ -29,8 +29,8 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/service-fabric.cluster:1.0.0`. - [Cert](#example-1-cert) -- [Using large parameter set](#example-2-using-large-parameter-set) -- [Using only defaults](#example-3-using-only-defaults) +- [Using only defaults](#example-2-using-only-defaults) +- [Using large parameter set](#example-3-using-large-parameter-set) ### Example 1: _Cert_ @@ -143,7 +143,99 @@ module cluster 'br:bicep/modules/service-fabric.cluster:1.0.0' = {

-### Example 2: _Using large parameter set_ +### Example 2: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module cluster 'br:bicep/modules/service-fabric.cluster:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-sfcmin' + params: { + // Required parameters + managementEndpoint: 'https://sfcmin001.westeurope.cloudapp.azure.com:19080' + name: 'sfcmin001' + nodeTypes: [ + { + applicationPorts: { + endPort: 30000 + startPort: 20000 + } + clientConnectionEndpointPort: 19000 + durabilityLevel: 'Bronze' + ephemeralPorts: { + endPort: 65534 + startPort: 49152 + } + httpGatewayEndpointPort: 19080 + isPrimary: true + name: 'Node01' + } + ] + reliabilityLevel: 'None' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "managementEndpoint": { + "value": "https://sfcmin001.westeurope.cloudapp.azure.com:19080" + }, + "name": { + "value": "sfcmin001" + }, + "nodeTypes": { + "value": [ + { + "applicationPorts": { + "endPort": 30000, + "startPort": 20000 + }, + "clientConnectionEndpointPort": 19000, + "durabilityLevel": "Bronze", + "ephemeralPorts": { + "endPort": 65534, + "startPort": 49152 + }, + "httpGatewayEndpointPort": 19080, + "isPrimary": true, + "name": "Node01" + } + ] + }, + "reliabilityLevel": { + "value": "None" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -154,11 +246,11 @@ This instance deploys the module with most of its features enabled. ```bicep module cluster 'br:bicep/modules/service-fabric.cluster:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sfccom' + name: '${uniqueString(deployment().name, location)}-test-sfcmax' params: { // Required parameters - managementEndpoint: 'https://sfccom001.westeurope.cloudapp.azure.com:19080' - name: 'sfccom001' + managementEndpoint: 'https://sfcmax001.westeurope.cloudapp.azure.com:19080' + name: 'sfcmax001' nodeTypes: [ { applicationPorts: { @@ -302,7 +394,7 @@ module cluster 'br:bicep/modules/service-fabric.cluster:1.0.0' = { } ] tags: { - clusterName: 'sfccom001' + clusterName: 'sfcmax001' 'hidden-title': 'This is visible in the resource name' resourceType: 'Service Fabric' } @@ -343,10 +435,10 @@ module cluster 'br:bicep/modules/service-fabric.cluster:1.0.0' = { "parameters": { // Required parameters "managementEndpoint": { - "value": "https://sfccom001.westeurope.cloudapp.azure.com:19080" + "value": "https://sfcmax001.westeurope.cloudapp.azure.com:19080" }, "name": { - "value": "sfccom001" + "value": "sfcmax001" }, "nodeTypes": { "value": [ @@ -522,7 +614,7 @@ module cluster 'br:bicep/modules/service-fabric.cluster:1.0.0' = { }, "tags": { "value": { - "clusterName": "sfccom001", + "clusterName": "sfcmax001", "hidden-title": "This is visible in the resource name", "resourceType": "Service Fabric" } @@ -557,98 +649,6 @@ module cluster 'br:bicep/modules/service-fabric.cluster:1.0.0' = {

-### Example 3: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module cluster 'br:bicep/modules/service-fabric.cluster:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sfcmin' - params: { - // Required parameters - managementEndpoint: 'https://sfcmin001.westeurope.cloudapp.azure.com:19080' - name: 'sfcmin001' - nodeTypes: [ - { - applicationPorts: { - endPort: 30000 - startPort: 20000 - } - clientConnectionEndpointPort: 19000 - durabilityLevel: 'Bronze' - ephemeralPorts: { - endPort: 65534 - startPort: 49152 - } - httpGatewayEndpointPort: 19080 - isPrimary: true - name: 'Node01' - } - ] - reliabilityLevel: 'None' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "managementEndpoint": { - "value": "https://sfcmin001.westeurope.cloudapp.azure.com:19080" - }, - "name": { - "value": "sfcmin001" - }, - "nodeTypes": { - "value": [ - { - "applicationPorts": { - "endPort": 30000, - "startPort": 20000 - }, - "clientConnectionEndpointPort": 19000, - "durabilityLevel": "Bronze", - "ephemeralPorts": { - "endPort": 65534, - "startPort": 49152 - }, - "httpGatewayEndpointPort": 19080, - "isPrimary": true, - "name": "Node01" - } - ] - }, - "reliabilityLevel": { - "value": "None" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/signal-r-service/signal-r/README.md b/modules/signal-r-service/signal-r/README.md index e7156a5cbe..8a20ce6637 100644 --- a/modules/signal-r-service/signal-r/README.md +++ b/modules/signal-r-service/signal-r/README.md @@ -28,10 +28,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/signal-r-service.signal-r:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module signalR 'br:bicep/modules/signal-r-service.signal-r:1.0.0' = { + name: '${uniqueString(deployment().name)}-test-srsdrmin' + params: { + // Required parameters + name: 'srsdrmin-001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "srsdrmin-001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,10 +90,10 @@ This instance deploys the module with most of its features enabled. ```bicep module signalR 'br:bicep/modules/signal-r-service.signal-r:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-srssrcom' + name: '${uniqueString(deployment().name)}-test-srssrmax' params: { // Required parameters - name: 'srssrcom-001' + name: 'srssrmax-001' // Non-required parameters capacity: 2 clientCertEnabled: false @@ -67,7 +115,7 @@ module signalR 'br:bicep/modules/signal-r-service.signal-r:1.0.0' = { 'ServerConnection' 'Trace' ] - name: 'pe-srssrcom-001' + name: 'pe-srssrmax-001' } ] publicNetwork: { @@ -125,7 +173,7 @@ module signalR 'br:bicep/modules/signal-r-service.signal-r:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "srssrcom-001" + "value": "srssrmax-001" }, // Non-required parameters "capacity": { @@ -165,7 +213,7 @@ module signalR 'br:bicep/modules/signal-r-service.signal-r:1.0.0' = { "ServerConnection", "Trace" ], - "name": "pe-srssrcom-001" + "name": "pe-srssrmax-001" } ], "publicNetwork": { @@ -223,54 +271,6 @@ module signalR 'br:bicep/modules/signal-r-service.signal-r:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module signalR 'br:bicep/modules/signal-r-service.signal-r:1.0.0' = { - name: '${uniqueString(deployment().name)}-test-srsdrmin' - params: { - // Required parameters - name: 'srsdrmin-001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "srsdrmin-001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/signal-r-service/web-pub-sub/README.md b/modules/signal-r-service/web-pub-sub/README.md index c0d2652156..de04a9437c 100644 --- a/modules/signal-r-service/web-pub-sub/README.md +++ b/modules/signal-r-service/web-pub-sub/README.md @@ -28,11 +28,59 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/signal-r-service.web-pub-sub:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) - [Pe](#example-3-pe) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module webPubSub 'br:bicep/modules/signal-r-service.web-pub-sub:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-srswpsmin' + params: { + // Required parameters + name: 'srswpsmin-001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "srswpsmin-001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -43,10 +91,10 @@ This instance deploys the module with most of its features enabled. ```bicep module webPubSub 'br:bicep/modules/signal-r-service.web-pub-sub:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-srswpscom' + name: '${uniqueString(deployment().name, location)}-test-srswpsmax' params: { // Required parameters - name: 'srswpscom-001' + name: 'srswpsmax-001' // Non-required parameters capacity: 2 clientCertEnabled: false @@ -70,7 +118,7 @@ module webPubSub 'br:bicep/modules/signal-r-service.web-pub-sub:1.0.0' = { 'ServerConnection' 'Trace' ] - name: 'pe-srswpscom-001' + name: 'pe-srswpsmax-001' } ] publicNetwork: { @@ -129,7 +177,7 @@ module webPubSub 'br:bicep/modules/signal-r-service.web-pub-sub:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "srswpscom-001" + "value": "srswpsmax-001" }, // Non-required parameters "capacity": { @@ -171,7 +219,7 @@ module webPubSub 'br:bicep/modules/signal-r-service.web-pub-sub:1.0.0' = { "ServerConnection", "Trace" ], - "name": "pe-srswpscom-001" + "name": "pe-srswpsmax-001" } ], "publicNetwork": { @@ -230,54 +278,6 @@ module webPubSub 'br:bicep/modules/signal-r-service.web-pub-sub:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module webPubSub 'br:bicep/modules/signal-r-service.web-pub-sub:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-srswpsmin' - params: { - // Required parameters - name: 'srswpsmin-001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "srswpsmin-001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ### Example 3: _Pe_

diff --git a/modules/sql/managed-instance/README.md b/modules/sql/managed-instance/README.md index d7edde8263..14c4696753 100644 --- a/modules/sql/managed-instance/README.md +++ b/modules/sql/managed-instance/README.md @@ -36,11 +36,71 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/sql.managed-instance:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) - [Vulnassm](#example-3-vulnassm) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module managedInstance 'br:bicep/modules/sql.managed-instance:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-sqlmimin' + params: { + // Required parameters + administratorLogin: 'adminUserName' + administratorLoginPassword: '' + name: 'sqlmimin' + subnetId: '' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "administratorLogin": { + "value": "adminUserName" + }, + "administratorLoginPassword": { + "value": "" + }, + "name": { + "value": "sqlmimin" + }, + "subnetId": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -51,12 +111,12 @@ This instance deploys the module with most of its features enabled. ```bicep module managedInstance 'br:bicep/modules/sql.managed-instance:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sqlmicom' + name: '${uniqueString(deployment().name, location)}-test-sqlmimax' params: { // Required parameters administratorLogin: 'adminUserName' administratorLoginPassword: '' - name: 'sqlmicom' + name: 'sqlmimax' subnetId: '' // Non-required parameters collation: 'SQL_Latin1_General_CP1_CI_AS' @@ -77,7 +137,7 @@ module managedInstance 'br:bicep/modules/sql.managed-instance:1.0.0' = { workspaceResourceId: '' } ] - name: 'sqlmicom-db-001' + name: 'sqlmimax-db-001' } ] diagnosticSettings: [ @@ -178,7 +238,7 @@ module managedInstance 'br:bicep/modules/sql.managed-instance:1.0.0' = { "value": "" }, "name": { - "value": "sqlmicom" + "value": "sqlmimax" }, "subnetId": { "value": "" @@ -204,7 +264,7 @@ module managedInstance 'br:bicep/modules/sql.managed-instance:1.0.0' = { "workspaceResourceId": "" } ], - "name": "sqlmicom-db-001" + "name": "sqlmimax-db-001" } ] }, @@ -332,66 +392,6 @@ module managedInstance 'br:bicep/modules/sql.managed-instance:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module managedInstance 'br:bicep/modules/sql.managed-instance:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sqlmimin' - params: { - // Required parameters - administratorLogin: 'adminUserName' - administratorLoginPassword: '' - name: 'sqlmimin' - subnetId: '' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "administratorLogin": { - "value": "adminUserName" - }, - "administratorLoginPassword": { - "value": "" - }, - "name": { - "value": "sqlmimin" - }, - "subnetId": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ### Example 3: _Vulnassm_

diff --git a/modules/sql/server/README.md b/modules/sql/server/README.md index 57fbcd7a99..329f0f3f82 100644 --- a/modules/sql/server/README.md +++ b/modules/sql/server/README.md @@ -118,10 +118,10 @@ This instance deploys the module with most of its features enabled. ```bicep module server 'br:bicep/modules/sql.server:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-sqlscom' + name: '${uniqueString(deployment().name, location)}-test-sqlsmax' params: { // Required parameters - name: 'sqlscom' + name: 'sqlsmax' // Non-required parameters administratorLogin: 'adminUserName' administratorLoginPassword: '' @@ -151,7 +151,7 @@ module server 'br:bicep/modules/sql.server:1.0.0' = { } licenseType: 'LicenseIncluded' maxSizeBytes: 34359738368 - name: 'sqlscomdb-001' + name: 'sqlsmaxdb-001' skuName: 'ElasticPool' skuTier: 'GeneralPurpose' } @@ -159,7 +159,7 @@ module server 'br:bicep/modules/sql.server:1.0.0' = { elasticPools: [ { maintenanceConfigurationId: '' - name: 'sqlscom-ep-001' + name: 'sqlsmax-ep-001' skuCapacity: 10 skuName: 'GP_Gen5' skuTier: 'GeneralPurpose' @@ -260,7 +260,7 @@ module server 'br:bicep/modules/sql.server:1.0.0' = { "contentVersion": "1.0.0.0", "parameters": { "name": { - "value": "sqlscom" + "value": "sqlsmax" }, "administratorLogin": { "value": "adminUserName" @@ -295,7 +295,7 @@ module server 'br:bicep/modules/sql.server:1.0.0' = { }, "licenseType": "LicenseIncluded", "maxSizeBytes": 34359738368, - "name": "sqlscomdb-001", + "name": "sqlsmaxdb-001", "skuName": "ElasticPool", "skuTier": "GeneralPurpose" } @@ -305,7 +305,7 @@ module server 'br:bicep/modules/sql.server:1.0.0' = { "value": [ { "maintenanceConfigurationId": "", - "name": "sqlscom-ep-001", + "name": "sqlsmax-ep-001", "skuCapacity": 10, "skuName": "GP_Gen5", "skuTier": "GeneralPurpose" diff --git a/modules/storage/storage-account/README.md b/modules/storage/storage-account/README.md index 87e05dea85..137e38dee2 100644 --- a/modules/storage/storage-account/README.md +++ b/modules/storage/storage-account/README.md @@ -41,13 +41,234 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/storage.storage-account:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encr](#example-3-encr) +- [Using only defaults](#example-1-using-only-defaults) +- [Encr](#example-2-encr) +- [Using large parameter set](#example-3-using-large-parameter-set) - [Nfs](#example-4-nfs) - [V1](#example-5-v1) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-ssamin' + params: { + // Required parameters + name: 'ssamin001' + // Non-required parameters + allowBlobPublicAccess: false + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "ssamin001" + }, + // Non-required parameters + "allowBlobPublicAccess": { + "value": false + }, + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Encr_ + +

+ +via Bicep module + +```bicep +module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-ssaencr' + params: { + // Required parameters + name: 'ssaencr001' + // Non-required parameters + allowBlobPublicAccess: false + blobServices: { + automaticSnapshotPolicyEnabled: true + changeFeedEnabled: true + changeFeedRetentionInDays: 10 + containerDeleteRetentionPolicyAllowPermanentDelete: true + containerDeleteRetentionPolicyDays: 10 + containerDeleteRetentionPolicyEnabled: true + containers: [ + { + name: 'container' + publicAccess: 'None' + } + ] + defaultServiceVersion: '2008-10-27' + deleteRetentionPolicyDays: 9 + deleteRetentionPolicyEnabled: true + isVersioningEnabled: true + lastAccessTimeTrackingPolicyEnable: true + restorePolicyDays: 8 + restorePolicyEnabled: true + } + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + userAssignedIdentityResourceId: '' + } + enableDefaultTelemetry: '' + managedIdentities: { + systemAssigned: false + userAssignedResourcesIds: [ + '' + ] + } + privateEndpoints: [ + { + privateDnsZoneResourceIds: [ + '' + ] + service: 'blob' + subnetResourceId: '' + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } + ] + requireInfrastructureEncryption: true + skuName: 'Standard_LRS' + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "ssaencr001" + }, + // Non-required parameters + "allowBlobPublicAccess": { + "value": false + }, + "blobServices": { + "value": { + "automaticSnapshotPolicyEnabled": true, + "changeFeedEnabled": true, + "changeFeedRetentionInDays": 10, + "containerDeleteRetentionPolicyAllowPermanentDelete": true, + "containerDeleteRetentionPolicyDays": 10, + "containerDeleteRetentionPolicyEnabled": true, + "containers": [ + { + "name": "container", + "publicAccess": "None" + } + ], + "defaultServiceVersion": "2008-10-27", + "deleteRetentionPolicyDays": 9, + "deleteRetentionPolicyEnabled": true, + "isVersioningEnabled": true, + "lastAccessTimeTrackingPolicyEnable": true, + "restorePolicyDays": 8, + "restorePolicyEnabled": true + } + }, + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" + } + }, + "enableDefaultTelemetry": { + "value": "" + }, + "managedIdentities": { + "value": { + "systemAssigned": false, + "userAssignedResourcesIds": [ + "" + ] + } + }, + "privateEndpoints": { + "value": [ + { + "privateDnsZoneResourceIds": [ + "" + ], + "service": "blob", + "subnetResourceId": "", + "tags": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + ] + }, + "requireInfrastructureEncryption": { + "value": true + }, + "skuName": { + "value": "Standard_LRS" + }, + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + } +} +``` + +
+

+ +### Example 3: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -58,10 +279,10 @@ This instance deploys the module with most of its features enabled. ```bicep module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ssacom' + name: '${uniqueString(deployment().name, location)}-test-ssamax' params: { // Required parameters - name: 'ssacom001' + name: 'ssamax001' // Non-required parameters allowBlobPublicAccess: false blobServices: { @@ -178,7 +399,7 @@ module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = { service: 'blob' } ] - storageAccountName: 'ssacom001' + storageAccountName: 'ssamax001' } ] lock: { @@ -344,7 +565,7 @@ module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "ssacom001" + "value": "ssamax001" }, // Non-required parameters "allowBlobPublicAccess": { @@ -481,7 +702,7 @@ module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = { "service": "blob" } ], - "storageAccountName": "ssacom001" + "storageAccountName": "ssamax001" } ] }, @@ -661,227 +882,6 @@ module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ssamin' - params: { - // Required parameters - name: 'ssamin001' - // Non-required parameters - allowBlobPublicAccess: false - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "ssamin001" - }, - // Non-required parameters - "allowBlobPublicAccess": { - "value": false - }, - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- -### Example 3: _Encr_ - -

- -via Bicep module - -```bicep -module storageAccount 'br:bicep/modules/storage.storage-account:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-ssaencr' - params: { - // Required parameters - name: 'ssaencr001' - // Non-required parameters - allowBlobPublicAccess: false - blobServices: { - automaticSnapshotPolicyEnabled: true - changeFeedEnabled: true - changeFeedRetentionInDays: 10 - containerDeleteRetentionPolicyAllowPermanentDelete: true - containerDeleteRetentionPolicyDays: 10 - containerDeleteRetentionPolicyEnabled: true - containers: [ - { - name: 'container' - publicAccess: 'None' - } - ] - defaultServiceVersion: '2008-10-27' - deleteRetentionPolicyDays: 9 - deleteRetentionPolicyEnabled: true - isVersioningEnabled: true - lastAccessTimeTrackingPolicyEnable: true - restorePolicyDays: 8 - restorePolicyEnabled: true - } - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } - enableDefaultTelemetry: '' - managedIdentities: { - systemAssigned: false - userAssignedResourcesIds: [ - '' - ] - } - privateEndpoints: [ - { - privateDnsZoneResourceIds: [ - '' - ] - service: 'blob' - subnetResourceId: '' - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } - ] - requireInfrastructureEncryption: true - skuName: 'Standard_LRS' - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "ssaencr001" - }, - // Non-required parameters - "allowBlobPublicAccess": { - "value": false - }, - "blobServices": { - "value": { - "automaticSnapshotPolicyEnabled": true, - "changeFeedEnabled": true, - "changeFeedRetentionInDays": 10, - "containerDeleteRetentionPolicyAllowPermanentDelete": true, - "containerDeleteRetentionPolicyDays": 10, - "containerDeleteRetentionPolicyEnabled": true, - "containers": [ - { - "name": "container", - "publicAccess": "None" - } - ], - "defaultServiceVersion": "2008-10-27", - "deleteRetentionPolicyDays": 9, - "deleteRetentionPolicyEnabled": true, - "isVersioningEnabled": true, - "lastAccessTimeTrackingPolicyEnable": true, - "restorePolicyDays": 8, - "restorePolicyEnabled": true - } - }, - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } - }, - "enableDefaultTelemetry": { - "value": "" - }, - "managedIdentities": { - "value": { - "systemAssigned": false, - "userAssignedResourcesIds": [ - "" - ] - } - }, - "privateEndpoints": { - "value": [ - { - "privateDnsZoneResourceIds": [ - "" - ], - "service": "blob", - "subnetResourceId": "", - "tags": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - ] - }, - "requireInfrastructureEncryption": { - "value": true - }, - "skuName": { - "value": "Standard_LRS" - }, - "tags": { - "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - } -} -``` - -
-

- ### Example 4: _Nfs_

diff --git a/modules/synapse/private-link-hub/README.md b/modules/synapse/private-link-hub/README.md index ab5d11e2d5..6e5a8a801c 100644 --- a/modules/synapse/private-link-hub/README.md +++ b/modules/synapse/private-link-hub/README.md @@ -28,10 +28,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/synapse.private-link-hub:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module privateLinkHub 'br:bicep/modules/synapse.private-link-hub:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-splhmin' + params: { + // Required parameters + name: 'splhmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "splhmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -42,10 +90,10 @@ This instance deploys the module with most of its features enabled. ```bicep module privateLinkHub 'br:bicep/modules/synapse.private-link-hub:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-splhcom' + name: '${uniqueString(deployment().name, location)}-test-splhmax' params: { // Required parameters - name: 'splhcom001' + name: 'splhmax001' // Non-required parameters enableDefaultTelemetry: '' lock: { @@ -101,7 +149,7 @@ module privateLinkHub 'br:bicep/modules/synapse.private-link-hub:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "splhcom001" + "value": "splhmax001" }, // Non-required parameters "enableDefaultTelemetry": { @@ -157,54 +205,6 @@ module privateLinkHub 'br:bicep/modules/synapse.private-link-hub:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module privateLinkHub 'br:bicep/modules/synapse.private-link-hub:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-splhmin' - params: { - // Required parameters - name: 'splhmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "splhmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/synapse/workspace/README.md b/modules/synapse/workspace/README.md index 3b067e5ac2..d00edcb815 100644 --- a/modules/synapse/workspace/README.md +++ b/modules/synapse/workspace/README.md @@ -32,15 +32,15 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/synapse.workspace:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) -- [Encrwsai](#example-3-encrwsai) -- [Encrwuai](#example-4-encrwuai) -- [Managedvnet](#example-5-managedvnet) +- [Using only defaults](#example-1-using-only-defaults) +- [Encrwsai](#example-2-encrwsai) +- [Encrwuai](#example-3-encrwuai) +- [Managedvnet](#example-4-managedvnet) +- [Using large parameter set](#example-5-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ -This instance deploys the module with most of its features enabled. +This instance deploys the module with the minimum set of required parameters.

@@ -49,64 +49,15 @@ This instance deploys the module with most of its features enabled. ```bicep module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-swcom' + name: '${uniqueString(deployment().name, location)}-test-swmin' params: { // Required parameters defaultDataLakeStorageAccountResourceId: '' defaultDataLakeStorageFilesystem: '' - name: 'swcom001' + name: 'swmin001' sqlAdministratorLogin: 'synwsadmin' // Non-required parameters - diagnosticSettings: [ - { - eventHubAuthorizationRuleResourceId: '' - eventHubName: '' - logCategoriesAndGroups: [ - { - category: 'SynapseRbacOperations' - } - { - category: 'SynapseLinkEvent' - } - ] - name: 'customSetting' - storageAccountResourceId: '' - workspaceResourceId: '' - } - ] enableDefaultTelemetry: '' - initialWorkspaceAdminObjectID: '' - integrationRuntimes: [ - { - name: 'shir01' - type: 'SelfHosted' - } - ] - managedVirtualNetwork: true - privateEndpoints: [ - { - privateDnsZoneResourceIds: [ - '' - ] - service: 'SQL' - subnetResourceId: '' - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' - } - } - ] - roleAssignments: [ - { - principalId: '' - principalType: 'ServicePrincipal' - roleDefinitionIdOrName: 'Reader' - } - ] - userAssignedIdentities: { - '': {} - } } } ``` @@ -131,77 +82,14 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { "value": "" }, "name": { - "value": "swcom001" + "value": "swmin001" }, "sqlAdministratorLogin": { "value": "synwsadmin" }, // Non-required parameters - "diagnosticSettings": { - "value": [ - { - "eventHubAuthorizationRuleResourceId": "", - "eventHubName": "", - "logCategoriesAndGroups": [ - { - "category": "SynapseRbacOperations" - }, - { - "category": "SynapseLinkEvent" - } - ], - "name": "customSetting", - "storageAccountResourceId": "", - "workspaceResourceId": "" - } - ] - }, "enableDefaultTelemetry": { "value": "" - }, - "initialWorkspaceAdminObjectID": { - "value": "" - }, - "integrationRuntimes": { - "value": [ - { - "name": "shir01", - "type": "SelfHosted" - } - ] - }, - "managedVirtualNetwork": { - "value": true - }, - "privateEndpoints": { - "value": [ - { - "privateDnsZoneResourceIds": [ - "" - ], - "service": "SQL", - "subnetResourceId": "", - "tags": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" - } - } - ] - }, - "roleAssignments": { - "value": [ - { - "principalId": "", - "principalType": "ServicePrincipal", - "roleDefinitionIdOrName": "Reader" - } - ] - }, - "userAssignedIdentities": { - "value": { - "": {} - } } } } @@ -210,10 +98,7 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - +### Example 2: _Encrwsai_

@@ -221,15 +106,20 @@ This instance deploys the module with the minimum set of required parameters. ```bicep module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-swmin' + name: '${uniqueString(deployment().name, location)}-test-swensa' params: { // Required parameters defaultDataLakeStorageAccountResourceId: '' defaultDataLakeStorageFilesystem: '' - name: 'swmin001' + name: 'swensa001' sqlAdministratorLogin: 'synwsadmin' // Non-required parameters + customerManagedKey: { + keyName: '' + keyVaultResourceId: '' + } enableDefaultTelemetry: '' + encryptionActivateWorkspace: true } } ``` @@ -254,14 +144,23 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { "value": "" }, "name": { - "value": "swmin001" + "value": "swensa001" }, "sqlAdministratorLogin": { "value": "synwsadmin" }, // Non-required parameters + "customerManagedKey": { + "value": { + "keyName": "", + "keyVaultResourceId": "" + } + }, "enableDefaultTelemetry": { "value": "" + }, + "encryptionActivateWorkspace": { + "value": true } } } @@ -270,7 +169,7 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = {

-### Example 3: _Encrwsai_ +### Example 3: _Encrwuai_

@@ -278,20 +177,25 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { ```bicep module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-swensa' + name: '${uniqueString(deployment().name, location)}-test-swenua' params: { // Required parameters defaultDataLakeStorageAccountResourceId: '' defaultDataLakeStorageFilesystem: '' - name: 'swensa001' + name: 'swenua001' sqlAdministratorLogin: 'synwsadmin' // Non-required parameters customerManagedKey: { keyName: '' keyVaultResourceId: '' + userAssignedIdentityResourceId: '' } enableDefaultTelemetry: '' - encryptionActivateWorkspace: true + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } } } ``` @@ -316,7 +220,7 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { "value": "" }, "name": { - "value": "swensa001" + "value": "swenua001" }, "sqlAdministratorLogin": { "value": "synwsadmin" @@ -325,14 +229,19 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { "customerManagedKey": { "value": { "keyName": "", - "keyVaultResourceId": "" + "keyVaultResourceId": "", + "userAssignedIdentityResourceId": "" } }, "enableDefaultTelemetry": { "value": "" }, - "encryptionActivateWorkspace": { - "value": true + "tags": { + "value": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } } } } @@ -341,7 +250,7 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = {

-### Example 4: _Encrwuai_ +### Example 4: _Managedvnet_

@@ -349,20 +258,20 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { ```bicep module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-swenua' + name: '${uniqueString(deployment().name, location)}-test-swmanv' params: { // Required parameters defaultDataLakeStorageAccountResourceId: '' defaultDataLakeStorageFilesystem: '' - name: 'swenua001' + name: 'swmanv001' sqlAdministratorLogin: 'synwsadmin' // Non-required parameters - customerManagedKey: { - keyName: '' - keyVaultResourceId: '' - userAssignedIdentityResourceId: '' - } + allowedAadTenantIdsForLinking: [ + '' + ] enableDefaultTelemetry: '' + managedVirtualNetwork: true + preventDataExfiltration: true tags: { Environment: 'Non-Prod' 'hidden-title': 'This is visible in the resource name' @@ -392,22 +301,26 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { "value": "" }, "name": { - "value": "swenua001" + "value": "swmanv001" }, "sqlAdministratorLogin": { "value": "synwsadmin" }, // Non-required parameters - "customerManagedKey": { - "value": { - "keyName": "", - "keyVaultResourceId": "", - "userAssignedIdentityResourceId": "" - } + "allowedAadTenantIdsForLinking": { + "value": [ + "" + ] }, "enableDefaultTelemetry": { "value": "" }, + "managedVirtualNetwork": { + "value": true + }, + "preventDataExfiltration": { + "value": true + }, "tags": { "value": { "Environment": "Non-Prod", @@ -422,7 +335,10 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = {

-### Example 5: _Managedvnet_ +### Example 5: _Using large parameter set_ + +This instance deploys the module with most of its features enabled. +

@@ -430,24 +346,63 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { ```bicep module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-swmanv' + name: '${uniqueString(deployment().name, location)}-test-swmax' params: { // Required parameters defaultDataLakeStorageAccountResourceId: '' defaultDataLakeStorageFilesystem: '' - name: 'swmanv001' + name: 'swmax001' sqlAdministratorLogin: 'synwsadmin' // Non-required parameters - allowedAadTenantIdsForLinking: [ - '' + diagnosticSettings: [ + { + eventHubAuthorizationRuleResourceId: '' + eventHubName: '' + logCategoriesAndGroups: [ + { + category: 'SynapseRbacOperations' + } + { + category: 'SynapseLinkEvent' + } + ] + name: 'customSetting' + storageAccountResourceId: '' + workspaceResourceId: '' + } ] enableDefaultTelemetry: '' + initialWorkspaceAdminObjectID: '' + integrationRuntimes: [ + { + name: 'shir01' + type: 'SelfHosted' + } + ] managedVirtualNetwork: true - preventDataExfiltration: true - tags: { - Environment: 'Non-Prod' - 'hidden-title': 'This is visible in the resource name' - Role: 'DeploymentValidation' + privateEndpoints: [ + { + privateDnsZoneResourceIds: [ + '' + ] + service: 'SQL' + subnetResourceId: '' + tags: { + Environment: 'Non-Prod' + 'hidden-title': 'This is visible in the resource name' + Role: 'DeploymentValidation' + } + } + ] + roleAssignments: [ + { + principalId: '' + principalType: 'ServicePrincipal' + roleDefinitionIdOrName: 'Reader' + } + ] + userAssignedIdentities: { + '': {} } } } @@ -473,31 +428,76 @@ module workspace 'br:bicep/modules/synapse.workspace:1.0.0' = { "value": "" }, "name": { - "value": "swmanv001" + "value": "swmax001" }, "sqlAdministratorLogin": { "value": "synwsadmin" }, // Non-required parameters - "allowedAadTenantIdsForLinking": { + "diagnosticSettings": { "value": [ - "" + { + "eventHubAuthorizationRuleResourceId": "", + "eventHubName": "", + "logCategoriesAndGroups": [ + { + "category": "SynapseRbacOperations" + }, + { + "category": "SynapseLinkEvent" + } + ], + "name": "customSetting", + "storageAccountResourceId": "", + "workspaceResourceId": "" + } ] }, "enableDefaultTelemetry": { "value": "" }, + "initialWorkspaceAdminObjectID": { + "value": "" + }, + "integrationRuntimes": { + "value": [ + { + "name": "shir01", + "type": "SelfHosted" + } + ] + }, "managedVirtualNetwork": { "value": true }, - "preventDataExfiltration": { - "value": true + "privateEndpoints": { + "value": [ + { + "privateDnsZoneResourceIds": [ + "" + ], + "service": "SQL", + "subnetResourceId": "", + "tags": { + "Environment": "Non-Prod", + "hidden-title": "This is visible in the resource name", + "Role": "DeploymentValidation" + } + } + ] }, - "tags": { + "roleAssignments": { + "value": [ + { + "principalId": "", + "principalType": "ServicePrincipal", + "roleDefinitionIdOrName": "Reader" + } + ] + }, + "userAssignedIdentities": { "value": { - "Environment": "Non-Prod", - "hidden-title": "This is visible in the resource name", - "Role": "DeploymentValidation" + "": {} } } } diff --git a/modules/virtual-machine-images/image-template/README.md b/modules/virtual-machine-images/image-template/README.md index eb1f5bfbfb..d5d30e9144 100644 --- a/modules/virtual-machine-images/image-template/README.md +++ b/modules/virtual-machine-images/image-template/README.md @@ -27,10 +27,100 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/virtual-machine-images.image-template:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +
+ +via Bicep module + +```bicep +module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-vmiitmin' + params: { + // Required parameters + customizationSteps: [ + { + restartTimeout: '30m' + type: 'WindowsRestart' + } + ] + imageSource: { + offer: 'Windows-10' + publisher: 'MicrosoftWindowsDesktop' + sku: 'win10-22h2-ent' + type: 'PlatformImage' + version: 'latest' + } + name: 'vmiitmin001' + userMsiName: '' + // Non-required parameters + enableDefaultTelemetry: '' + managedImageName: 'mi-vmiitmin-001' + userMsiResourceGroup: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "customizationSteps": { + "value": [ + { + "restartTimeout": "30m", + "type": "WindowsRestart" + } + ] + }, + "imageSource": { + "value": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "win10-22h2-ent", + "type": "PlatformImage", + "version": "latest" + } + }, + "name": { + "value": "vmiitmin001" + }, + "userMsiName": { + "value": "" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + }, + "managedImageName": { + "value": "mi-vmiitmin-001" + }, + "userMsiResourceGroup": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -41,7 +131,7 @@ This instance deploys the module with most of its features enabled. ```bicep module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-vmiitcom' + name: '${uniqueString(deployment().name, location)}-test-vmiitmax' params: { // Required parameters customizationSteps: [ @@ -57,7 +147,7 @@ module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0 type: 'PlatformImage' version: 'latest' } - name: 'vmiitcom001' + name: 'vmiitmax001' userMsiName: '' // Non-required parameters buildTimeoutInMinutes: 60 @@ -67,7 +157,7 @@ module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0 kind: 'CanNotDelete' name: 'myCustomLockName' } - managedImageName: 'mi-vmiitcom-001' + managedImageName: 'mi-vmiitmax-001' osDiskSizeGB: 127 roleAssignments: [ { @@ -85,7 +175,7 @@ module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0 'hidden-title': 'This is visible in the resource name' Role: 'DeploymentValidation' } - unManagedImageName: 'umi-vmiitcom-001' + unManagedImageName: 'umi-vmiitmax-001' userAssignedIdentities: [ '' ] @@ -126,7 +216,7 @@ module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0 } }, "name": { - "value": "vmiitcom001" + "value": "vmiitmax001" }, "userMsiName": { "value": "" @@ -148,7 +238,7 @@ module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0 } }, "managedImageName": { - "value": "mi-vmiitcom-001" + "value": "mi-vmiitmax-001" }, "osDiskSizeGB": { "value": 127 @@ -182,7 +272,7 @@ module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0 } }, "unManagedImageName": { - "value": "umi-vmiitcom-001" + "value": "umi-vmiitmax-001" }, "userAssignedIdentities": { "value": [ @@ -202,96 +292,6 @@ module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module imageTemplate 'br:bicep/modules/virtual-machine-images.image-template:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-vmiitmin' - params: { - // Required parameters - customizationSteps: [ - { - restartTimeout: '30m' - type: 'WindowsRestart' - } - ] - imageSource: { - offer: 'Windows-10' - publisher: 'MicrosoftWindowsDesktop' - sku: 'win10-22h2-ent' - type: 'PlatformImage' - version: 'latest' - } - name: 'vmiitmin001' - userMsiName: '' - // Non-required parameters - enableDefaultTelemetry: '' - managedImageName: 'mi-vmiitmin-001' - userMsiResourceGroup: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "customizationSteps": { - "value": [ - { - "restartTimeout": "30m", - "type": "WindowsRestart" - } - ] - }, - "imageSource": { - "value": { - "offer": "Windows-10", - "publisher": "MicrosoftWindowsDesktop", - "sku": "win10-22h2-ent", - "type": "PlatformImage", - "version": "latest" - } - }, - "name": { - "value": "vmiitmin001" - }, - "userMsiName": { - "value": "" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - }, - "managedImageName": { - "value": "mi-vmiitmin-001" - }, - "userMsiResourceGroup": { - "value": "" - } - } -} -``` - -
-

- ## Parameters diff --git a/modules/web/connection/README.md b/modules/web/connection/README.md index d993463be0..bdb9491881 100644 --- a/modules/web/connection/README.md +++ b/modules/web/connection/README.md @@ -39,7 +39,7 @@ This instance deploys the module with most of its features enabled. ```bicep module connection 'br:bicep/modules/web.connection:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-wccom' + name: '${uniqueString(deployment().name, location)}-test-wcmax' params: { // Required parameters displayName: 'azuremonitorlogs' diff --git a/modules/web/serverfarm/README.md b/modules/web/serverfarm/README.md index 1f13295b37..4dc832d2b9 100644 --- a/modules/web/serverfarm/README.md +++ b/modules/web/serverfarm/README.md @@ -40,10 +40,10 @@ This instance deploys the module with most of its features enabled. ```bicep module serverfarm 'br:bicep/modules/web.serverfarm:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-wsfcom' + name: '${uniqueString(deployment().name, location)}-test-wsfmax' params: { // Required parameters - name: 'wsfcom001' + name: 'wsfmax001' sku: { capacity: '1' family: 'S' @@ -101,7 +101,7 @@ module serverfarm 'br:bicep/modules/web.serverfarm:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "wsfcom001" + "value": "wsfmax001" }, "sku": { "value": { diff --git a/modules/web/static-site/README.md b/modules/web/static-site/README.md index cc22765503..ebd2b09d90 100644 --- a/modules/web/static-site/README.md +++ b/modules/web/static-site/README.md @@ -31,10 +31,58 @@ The following section provides usage examples for the module, which were used to >**Note**: To reference the module, please use the following syntax `br:bicep/modules/web.static-site:1.0.0`. -- [Using large parameter set](#example-1-using-large-parameter-set) -- [Using only defaults](#example-2-using-only-defaults) +- [Using only defaults](#example-1-using-only-defaults) +- [Using large parameter set](#example-2-using-large-parameter-set) -### Example 1: _Using large parameter set_ +### Example 1: _Using only defaults_ + +This instance deploys the module with the minimum set of required parameters. + + +

+ +via Bicep module + +```bicep +module staticSite 'br:bicep/modules/web.static-site:1.0.0' = { + name: '${uniqueString(deployment().name, location)}-test-wssmin' + params: { + // Required parameters + name: 'wssmin001' + // Non-required parameters + enableDefaultTelemetry: '' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "name": { + "value": "wssmin001" + }, + // Non-required parameters + "enableDefaultTelemetry": { + "value": "" + } + } +} +``` + +
+

+ +### Example 2: _Using large parameter set_ This instance deploys the module with most of its features enabled. @@ -45,10 +93,10 @@ This instance deploys the module with most of its features enabled. ```bicep module staticSite 'br:bicep/modules/web.static-site:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-wsscom' + name: '${uniqueString(deployment().name, location)}-test-wssmax' params: { // Required parameters - name: 'wsscom001' + name: 'wssmax001' // Non-required parameters allowConfigFileUpdates: true appSettings: { @@ -119,7 +167,7 @@ module staticSite 'br:bicep/modules/web.static-site:1.0.0' = { "parameters": { // Required parameters "name": { - "value": "wsscom001" + "value": "wssmax001" }, // Non-required parameters "allowConfigFileUpdates": { @@ -206,54 +254,6 @@ module staticSite 'br:bicep/modules/web.static-site:1.0.0' = {

-### Example 2: _Using only defaults_ - -This instance deploys the module with the minimum set of required parameters. - - -

- -via Bicep module - -```bicep -module staticSite 'br:bicep/modules/web.static-site:1.0.0' = { - name: '${uniqueString(deployment().name, location)}-test-wssmin' - params: { - // Required parameters - name: 'wssmin001' - // Non-required parameters - enableDefaultTelemetry: '' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "name": { - "value": "wssmin001" - }, - // Non-required parameters - "enableDefaultTelemetry": { - "value": "" - } - } -} -``` - -
-

- ## Parameters