Regenerated modules 181-240 (#4087)

* Regen readmes 4 * Fixed templates * Regen * Renamed header
Azure · Oct 16, 2023 · 7c34c7c · 7c34c7c
1 parent 047a1a7
commit 7c34c7c
Show file tree

Hide file tree

Showing 156 changed files with 6,788 additions and 1,986 deletions.
diff --git a/modules/network/bastion-host/.test/common/main.test.bicep b/modules/network/bastion-host/.test/common/main.test.bicep
@@ -1,5 +1,8 @@
 targetScope = 'subscription'
 
+metadata name = 'Using large parameter set'
+metadata description = 'This instance deploys the module with most of its features enabled.'
+
 // ========== //
 // Parameters //
 // ========== //

diff --git a/modules/network/bastion-host/.test/min/main.test.bicep b/modules/network/bastion-host/.test/min/main.test.bicep
@@ -1,5 +1,8 @@
 targetScope = 'subscription'
 
+metadata name = 'Using only defaults'
+metadata description = 'This instance deploys the module with the minimum set of required parameters.'
+
 // ========== //
 // Parameters //
 // ========== //

diff --git a/modules/network/bastion-host/README.md b/modules/network/bastion-host/README.md
diff --git a/modules/network/bastion-host/main.json b/modules/network/bastion-host/main.json
@@ -4,8 +4,8 @@
   "metadata": {
     "_generator": {
       "name": "bicep",
-      "version": "0.21.1.54444",
-      "templateHash": "17208156201497944921"
+      "version": "0.22.6.54827",
+      "templateHash": "18039554301844568366"
     },
     "name": "Bastion Hosts",
     "description": "This module deploys a Bastion Host.",
@@ -326,8 +326,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.21.1.54444",
-              "templateHash": "1887898957722092173"
+              "version": "0.22.6.54827",
+              "templateHash": "4317747709004918530"
             },
             "name": "Public IP Addresses",
             "description": "This module deploys a Public IP Address.",
@@ -660,8 +660,8 @@
                   "metadata": {
                     "_generator": {
                       "name": "bicep",
-                      "version": "0.21.1.54444",
-                      "templateHash": "7328126239184883887"
+                      "version": "0.22.6.54827",
+                      "templateHash": "9976109177347918049"
                     }
                   },
                   "parameters": {
@@ -878,8 +878,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.21.1.54444",
-              "templateHash": "5797020701488147835"
+              "version": "0.22.6.54827",
+              "templateHash": "7732571198100682148"
             }
           },
           "parameters": {

diff --git a/modules/network/connection/README.md b/modules/network/connection/README.md
@@ -4,83 +4,39 @@ This module deploys a Virtual Network Gateway Connection.
 
 ## Navigation
 
-- [Resource types](#Resource-types)
+- [Resource Types](#Resource-Types)
+- [Usage examples](#Usage-examples)
 - [Parameters](#Parameters)
 - [Outputs](#Outputs)
 - [Cross-referenced modules](#Cross-referenced-modules)
-- [Deployment examples](#Deployment-examples)
 - [Notes](#Notes)
 
-## Resource types
+## Resource Types
 
 | Resource Type | API Version |
 | :-- | :-- |
 | `Microsoft.Authorization/locks` | [2020-05-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Authorization/2020-05-01/locks) |
 | `Microsoft.Network/connections` | [2023-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2023-04-01/connections) |
 
-## Parameters
-
-**Required parameters**
-
-| Parameter Name | Type | Description |
-| :-- | :-- | :-- |
-| `name` | string | Remote connection name. |
-| `virtualNetworkGateway1` | object | The primary Virtual Network Gateway. |
-
-**Optional parameters**
-
-| Parameter Name | Type | Default Value | Allowed Values | Description |
-| :-- | :-- | :-- | :-- | :-- |
-| `authorizationKey` | securestring | `''` |  | The Authorization Key to connect to an Express Route Circuit. Used for connection type [ExpressRoute]. |
-| `connectionMode` | string | `'Default'` | `[Default, InitiatorOnly, ResponderOnly]` | The connection connectionMode for this connection. Available for IPSec connections. |
-| `connectionProtocol` | string | `'IKEv2'` | `[IKEv1, IKEv2]` | Connection connectionProtocol used for this connection. Available for IPSec connections. |
-| `connectionType` | string | `'IPsec'` | `[ExpressRoute, IPsec, Vnet2Vnet, VPNClient]` | Gateway connection connectionType. |
-| `customIPSecPolicy` | object | `{object}` |  | The IPSec Policies to be considered by this connection. |
-| `dpdTimeoutSeconds` | int | `45` |  | The dead peer detection timeout of this connection in seconds. Setting the timeout to shorter periods will cause IKE to rekey more aggressively, causing the connection to appear to be disconnected in some instances. The general recommendation is to set the timeout between 30 to 45 seconds. |
-| `enableBgp` | bool | `False` |  | Value to specify if BGP is enabled or not. |
-| `enableDefaultTelemetry` | bool | `True` |  | Enable telemetry via a Globally Unique Identifier (GUID). |
-| `enablePrivateLinkFastPath` | bool | `False` |  | Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled. Only available when connection connectionType is Express Route. |
-| `expressRouteGatewayBypass` | bool | `False` |  | Bypass ExpressRoute Gateway for data forwarding. Only available when connection connectionType is Express Route. |
-| `localNetworkGateway2` | object | `{object}` |  | The local network gateway. Used for connection type [IPsec]. |
-| `location` | string | `[resourceGroup().location]` |  | Location for all resources. |
-| `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the connectionType of lock. |
-| `peer` | object | `{object}` |  | The remote peer. Used for connection connectionType [ExpressRoute]. |
-| `routingWeight` | int | `-1` |  | The weight added to routes learned from this BGP speaker. |
-| `tags` | object | `{object}` |  | Tags of the resource. |
-| `useLocalAzureIpAddress` | bool | `False` |  | Use private local Azure IP for the connection. Only available for IPSec Virtual Network Gateways that use the Azure Private IP Property. |
-| `usePolicyBasedTrafficSelectors` | bool | `False` |  | Enable policy-based traffic selectors. |
-| `virtualNetworkGateway2` | object | `{object}` |  | The remote Virtual Network Gateway. Used for connection connectionType [Vnet2Vnet]. |
-| `vpnSharedKey` | securestring | `''` |  | Specifies a VPN shared key. The same value has to be specified on both Virtual Network Gateways. |
-
-
-## Outputs
-
-| Output Name | Type | Description |
-| :-- | :-- | :-- |
-| `location` | string | The location the resource was deployed into. |
-| `name` | string | The name of the remote connection. |
-| `resourceGroupName` | string | The resource group the remote connection was deployed into. |
-| `resourceId` | string | The resource ID of the remote connection. |
-
-## Cross-referenced modules
-
-_None_
-
-## Deployment examples
+## Usage examples
 
-The following module usage examples are retrieved from the content of the files hosted in the module's `.test` folder.
+The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.
    >**Note**: The name of each example is based on the name of the file from which it is taken.
 
    >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
-<h3>Example 1: Vnet2vnet</h3>
+   >**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.connection:1.0.0`.
+
+- [Vnet2vnet](#example-1-vnet2vnet)
+
+### Example 1: _Vnet2vnet_
 
 <details>
 
 <summary>via Bicep module</summary>
 
 ```bicep
-module connection './network/connection/main.bicep' = {
+module connection 'br:bicep/modules/network.connection:1.0.0' = {
   name: '${uniqueString(deployment().name, location)}-test-ncvtv'
   params: {
     // Required parameters
@@ -163,6 +119,210 @@ module connection './network/connection/main.bicep' = {
 <p>
 
 
+## Parameters
+
+**Required parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`name`](#parameter-name) | string | Remote connection name. |
+| [`virtualNetworkGateway1`](#parameter-virtualnetworkgateway1) | object | The primary Virtual Network Gateway. |
+
+**Optional parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`authorizationKey`](#parameter-authorizationkey) | securestring | The Authorization Key to connect to an Express Route Circuit. Used for connection type [ExpressRoute]. |
+| [`connectionMode`](#parameter-connectionmode) | string | The connection connectionMode for this connection. Available for IPSec connections. |
+| [`connectionProtocol`](#parameter-connectionprotocol) | string | Connection connectionProtocol used for this connection. Available for IPSec connections. |
+| [`connectionType`](#parameter-connectiontype) | string | Gateway connection connectionType. |
+| [`customIPSecPolicy`](#parameter-customipsecpolicy) | object | The IPSec Policies to be considered by this connection. |
+| [`dpdTimeoutSeconds`](#parameter-dpdtimeoutseconds) | int | The dead peer detection timeout of this connection in seconds. Setting the timeout to shorter periods will cause IKE to rekey more aggressively, causing the connection to appear to be disconnected in some instances. The general recommendation is to set the timeout between 30 to 45 seconds. |
+| [`enableBgp`](#parameter-enablebgp) | bool | Value to specify if BGP is enabled or not. |
+| [`enableDefaultTelemetry`](#parameter-enabledefaulttelemetry) | bool | Enable telemetry via a Globally Unique Identifier (GUID). |
+| [`enablePrivateLinkFastPath`](#parameter-enableprivatelinkfastpath) | bool | Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled. Only available when connection connectionType is Express Route. |
+| [`expressRouteGatewayBypass`](#parameter-expressroutegatewaybypass) | bool | Bypass ExpressRoute Gateway for data forwarding. Only available when connection connectionType is Express Route. |
+| [`localNetworkGateway2`](#parameter-localnetworkgateway2) | object | The local network gateway. Used for connection type [IPsec]. |
+| [`location`](#parameter-location) | string | Location for all resources. |
+| [`lock`](#parameter-lock) | string | Specify the connectionType of lock. |
+| [`peer`](#parameter-peer) | object | The remote peer. Used for connection connectionType [ExpressRoute]. |
+| [`routingWeight`](#parameter-routingweight) | int | The weight added to routes learned from this BGP speaker. |
+| [`tags`](#parameter-tags) | object | Tags of the resource. |
+| [`useLocalAzureIpAddress`](#parameter-uselocalazureipaddress) | bool | Use private local Azure IP for the connection. Only available for IPSec Virtual Network Gateways that use the Azure Private IP Property. |
+| [`usePolicyBasedTrafficSelectors`](#parameter-usepolicybasedtrafficselectors) | bool | Enable policy-based traffic selectors. |
+| [`virtualNetworkGateway2`](#parameter-virtualnetworkgateway2) | object | The remote Virtual Network Gateway. Used for connection connectionType [Vnet2Vnet]. |
+| [`vpnSharedKey`](#parameter-vpnsharedkey) | securestring | Specifies a VPN shared key. The same value has to be specified on both Virtual Network Gateways. |
+
+### Parameter: `authorizationKey`
+
+The Authorization Key to connect to an Express Route Circuit. Used for connection type [ExpressRoute].
+- Required: No
+- Type: securestring
+- Default: `''`
+
+### Parameter: `connectionMode`
+
+The connection connectionMode for this connection. Available for IPSec connections.
+- Required: No
+- Type: string
+- Default: `'Default'`
+- Allowed: `[Default, InitiatorOnly, ResponderOnly]`
+
+### Parameter: `connectionProtocol`
+
+Connection connectionProtocol used for this connection. Available for IPSec connections.
+- Required: No
+- Type: string
+- Default: `'IKEv2'`
+- Allowed: `[IKEv1, IKEv2]`
+
+### Parameter: `connectionType`
+
+Gateway connection connectionType.
+- Required: No
+- Type: string
+- Default: `'IPsec'`
+- Allowed: `[ExpressRoute, IPsec, Vnet2Vnet, VPNClient]`
+
+### Parameter: `customIPSecPolicy`
+
+The IPSec Policies to be considered by this connection.
+- Required: No
+- Type: object
+- Default: `{object}`
+
+### Parameter: `dpdTimeoutSeconds`
+
+The dead peer detection timeout of this connection in seconds. Setting the timeout to shorter periods will cause IKE to rekey more aggressively, causing the connection to appear to be disconnected in some instances. The general recommendation is to set the timeout between 30 to 45 seconds.
+- Required: No
+- Type: int
+- Default: `45`
+
+### Parameter: `enableBgp`
+
+Value to specify if BGP is enabled or not.
+- Required: No
+- Type: bool
+- Default: `False`
+
+### Parameter: `enableDefaultTelemetry`
+
+Enable telemetry via a Globally Unique Identifier (GUID).
+- Required: No
+- Type: bool
+- Default: `True`
+
+### Parameter: `enablePrivateLinkFastPath`
+
+Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled. Only available when connection connectionType is Express Route.
+- Required: No
+- Type: bool
+- Default: `False`
+
+### Parameter: `expressRouteGatewayBypass`
+
+Bypass ExpressRoute Gateway for data forwarding. Only available when connection connectionType is Express Route.
+- Required: No
+- Type: bool
+- Default: `False`
+
+### Parameter: `localNetworkGateway2`
+
+The local network gateway. Used for connection type [IPsec].
+- Required: No
+- Type: object
+- Default: `{object}`
+
+### Parameter: `location`
+
+Location for all resources.
+- Required: No
+- Type: string
+- Default: `[resourceGroup().location]`
+
+### Parameter: `lock`
+
+Specify the connectionType of lock.
+- Required: No
+- Type: string
+- Default: `''`
+- Allowed: `['', CanNotDelete, ReadOnly]`
+
+### Parameter: `name`
+
+Remote connection name.
+- Required: Yes
+- Type: string
+
+### Parameter: `peer`
+
+The remote peer. Used for connection connectionType [ExpressRoute].
+- Required: No
+- Type: object
+- Default: `{object}`
+
+### Parameter: `routingWeight`
+
+The weight added to routes learned from this BGP speaker.
+- Required: No
+- Type: int
+- Default: `-1`
+
+### Parameter: `tags`
+
+Tags of the resource.
+- Required: No
+- Type: object
+- Default: `{object}`
+
+### Parameter: `useLocalAzureIpAddress`
+
+Use private local Azure IP for the connection. Only available for IPSec Virtual Network Gateways that use the Azure Private IP Property.
+- Required: No
+- Type: bool
+- Default: `False`
+
+### Parameter: `usePolicyBasedTrafficSelectors`
+
+Enable policy-based traffic selectors.
+- Required: No
+- Type: bool
+- Default: `False`
+
+### Parameter: `virtualNetworkGateway1`
+
+The primary Virtual Network Gateway.
+- Required: Yes
+- Type: object
+
+### Parameter: `virtualNetworkGateway2`
+
+The remote Virtual Network Gateway. Used for connection connectionType [Vnet2Vnet].
+- Required: No
+- Type: object
+- Default: `{object}`
+
+### Parameter: `vpnSharedKey`
+
+Specifies a VPN shared key. The same value has to be specified on both Virtual Network Gateways.
+- Required: No
+- Type: securestring
+- Default: `''`
+
+
+## Outputs
+
+| Output | Type | Description |
+| :-- | :-- | :-- |
+| `location` | string | The location the resource was deployed into. |
+| `name` | string | The name of the remote connection. |
+| `resourceGroupName` | string | The resource group the remote connection was deployed into. |
+| `resourceId` | string | The resource ID of the remote connection. |
+
+## Cross-referenced modules
+
+_None_
+
 ## Notes
 
 ### Parameter Usage: `localNetworkGateway2`

diff --git a/modules/network/connection/main.json b/modules/network/connection/main.json
@@ -4,8 +4,8 @@
   "metadata": {
     "_generator": {
       "name": "bicep",
-      "version": "0.21.1.54444",
-      "templateHash": "16230225022830179202"
+      "version": "0.22.6.54827",
+      "templateHash": "4819464445955431710"
     },
     "name": "Virtual Network Gateway Connections",
     "description": "This module deploys a Virtual Network Gateway Connection.",

diff --git a/modules/network/ddos-protection-plan/.test/common/main.test.bicep b/modules/network/ddos-protection-plan/.test/common/main.test.bicep
@@ -1,5 +1,8 @@
 targetScope = 'subscription'
 
+metadata name = 'Using large parameter set'
+metadata description = 'This instance deploys the module with most of its features enabled.'
+
 // ========== //
 // Parameters //
 // ========== //

diff --git a/modules/network/ddos-protection-plan/.test/min/main.test.bicep b/modules/network/ddos-protection-plan/.test/min/main.test.bicep
@@ -1,5 +1,8 @@
 targetScope = 'subscription'
 
+metadata name = 'Using only defaults'
+metadata description = 'This instance deploys the module with the minimum set of required parameters.'
+
 // ========== //
 // Parameters //
 // ========== //