diff --git a/modules/aad/domain-service/README.md b/modules/aad/domain-service/README.md index b73a478503..5f254cf354 100644 --- a/modules/aad/domain-service/README.md +++ b/modules/aad/domain-service/README.md @@ -227,7 +227,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module domainServices './aad/domain-service/main.bicep' = { +module domainService './aad/domain-service/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-aaddscom' params: { // Required parameters diff --git a/modules/analysis-services/server/README.md b/modules/analysis-services/server/README.md index 2c395523bb..320ede300c 100644 --- a/modules/analysis-services/server/README.md +++ b/modules/analysis-services/server/README.md @@ -176,7 +176,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module servers './analysis-services/server/main.bicep' = { +module server './analysis-services/server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-asscom' params: { // Required parameters @@ -279,7 +279,7 @@ module servers './analysis-services/server/main.bicep' = { via Bicep module ```bicep -module servers './analysis-services/server/main.bicep' = { +module server './analysis-services/server/main.bicep' = { name: '${uniqueString(deployment().name)}-test-assmax' params: { // Required parameters @@ -416,7 +416,7 @@ module servers './analysis-services/server/main.bicep' = { via Bicep module ```bicep -module servers './analysis-services/server/main.bicep' = { +module server './analysis-services/server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-assmin' params: { // Required parameters diff --git a/modules/api-management/service/README.md b/modules/api-management/service/README.md index 7facb04476..5a6a3c57a6 100644 --- a/modules/api-management/service/README.md +++ b/modules/api-management/service/README.md @@ -49,11 +49,11 @@ This module deploys an API Management Service. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `additionalLocations` | array | `[]` | | Additional datacenter locations of the API Management service. | -| `apis` | _[apis](apis/README.md)_ array | `[]` | | APIs. | -| `apiVersionSets` | _[apiVersionSets](api-version-sets/README.md)_ array | `[]` | | API Version Sets. | +| `apis` | array | `[]` | | APIs. | +| `apiVersionSets` | array | `[]` | | API Version Sets. | | `authorizationServers` | secureObject | `{object}` | | Authorization servers. | -| `backends` | _[backends](backends/README.md)_ array | `[]` | | Backends. | -| `caches` | _[caches](caches/README.md)_ array | `[]` | | Caches. | +| `backends` | array | `[]` | | Backends. | +| `caches` | array | `[]` | | Caches. | | `certificates` | array | `[]` | | List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. | | `customProperties` | object | `{object}` | | Custom properties of the API Management service. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | @@ -68,22 +68,22 @@ This module deploys an API Management Service. | `enableClientCertificate` | bool | `False` | | Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `hostnameConfigurations` | array | `[]` | | Custom hostname configuration of the API Management service. | -| `identityProviders` | _[identityProviders](identity-providers/README.md)_ array | `[]` | | Identity providers. | +| `identityProviders` | array | `[]` | | Identity providers. | | `location` | string | `[resourceGroup().location]` | | Location for all Resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `minApiVersion` | string | `''` | | Limit control plane API calls to API Management service with version equal to or newer than this value. | -| `namedValues` | _[namedValues](named-values/README.md)_ array | `[]` | | Named values. | +| `namedValues` | array | `[]` | | Named values. | | `newGuidValue` | string | `[newGuid()]` | | Necessary to create a new GUID. | | `notificationSenderEmail` | string | `'apimgmt-noreply@mail.windowsazure.com'` | | The notification sender email address for the service. | -| `policies` | _[policies](policies/README.md)_ array | `[]` | | Policies. | -| `portalsettings` | _[portalsettings](portalsettings/README.md)_ array | `[]` | | Portal settings. | -| `products` | _[products](products/README.md)_ array | `[]` | | Products. | +| `policies` | array | `[]` | | Policies. | +| `portalsettings` | array | `[]` | | Portal settings. | +| `products` | array | `[]` | | Products. | | `restore` | bool | `False` | | Undelete API Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `sku` | string | `'Developer'` | `[Basic, Consumption, Developer, Premium, Standard]` | The pricing tier of this API Management service. | | `skuCount` | int | `1` | `[1, 2]` | The instance size of this API Management service. | | `subnetResourceId` | string | `''` | | The full resource ID of a subnet in a virtual network to deploy the API Management service in. | -| `subscriptions` | _[subscriptions](subscriptions/README.md)_ array | `[]` | | Subscriptions. | +| `subscriptions` | array | `[]` | | Subscriptions. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | diff --git a/modules/api-management/service/api/README.md b/modules/api-management/service/api/README.md index 73235d1f42..2390fc6a17 100644 --- a/modules/api-management/service/api/README.md +++ b/modules/api-management/service/api/README.md @@ -47,7 +47,7 @@ This module deploys an API Management Service API. | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `format` | string | `'openapi'` | `[openapi, openapi-link, openapi+json, openapi+json-link, swagger-json, swagger-link-json, wadl-link-json, wadl-xml, wsdl, wsdl-link]` | Format of the Content in which the API is getting imported. | | `isCurrent` | bool | `True` | | Indicates if API revision is current API revision. | -| `policies` | _[policies](policies/README.md)_ array | `[]` | | Array of Policies to apply to the Service API. | +| `policies` | array | `[]` | | Array of Policies to apply to the Service API. | | `protocols` | array | `[https]` | | Describes on which protocols the operations in this API can be invoked. - HTTP or HTTPS. | | `serviceUrl` | string | `''` | | Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. | | `sourceApiId` | string | `''` | | API identifier of the source API. | diff --git a/modules/api-management/service/product/README.md b/modules/api-management/service/product/README.md index e65b164a22..e5b15b55f4 100644 --- a/modules/api-management/service/product/README.md +++ b/modules/api-management/service/product/README.md @@ -35,11 +35,11 @@ This module deploys an API Management Service Product. | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | -| `apis` | _[apis](apis/README.md)_ array | `[]` | Array of Product APIs. | +| `apis` | array | `[]` | Array of Product APIs. | | `approvalRequired` | bool | `False` | Whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the products APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the products APIs. Can be present only if subscriptionRequired property is present and has a value of false. | | `description` | string | `''` | Product description. May include HTML formatting tags. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | -| `groups` | _[groups](groups/README.md)_ array | `[]` | Array of Product Groups. | +| `groups` | array | `[]` | Array of Product Groups. | | `state` | string | `'published'` | whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - notPublished or published. | | `subscriptionRequired` | bool | `False` | Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. | | `subscriptionsLimit` | int | `1` | Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false. | diff --git a/modules/app-configuration/configuration-store/README.md b/modules/app-configuration/configuration-store/README.md index d4117967fb..96101fecc6 100644 --- a/modules/app-configuration/configuration-store/README.md +++ b/modules/app-configuration/configuration-store/README.md @@ -46,7 +46,7 @@ This module deploys an App Configuration Store. | `disableLocalAuth` | bool | `False` | | Disables all authentication methods other than AAD authentication. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `enablePurgeProtection` | bool | `False` | | Property specifying whether protection against purge is enabled for this configuration store. | -| `keyValues` | _[keyValues](key-values/README.md)_ array | `[]` | | All Key / Values to create. | +| `keyValues` | array | `[]` | | All Key / Values to create. | | `location` | string | `[resourceGroup().location]` | | Location for all Resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | @@ -308,7 +308,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -324,7 +324,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module configurationStores './app-configuration/configuration-store/main.bicep' = { +module configurationStore './app-configuration/configuration-store/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-acccom' params: { // Required parameters @@ -477,7 +477,7 @@ module configurationStores './app-configuration/configuration-store/main.bicep' via Bicep module ```bicep -module configurationStores './app-configuration/configuration-store/main.bicep' = { +module configurationStore './app-configuration/configuration-store/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-accmin' params: { // Required parameters @@ -522,7 +522,7 @@ module configurationStores './app-configuration/configuration-store/main.bicep' via Bicep module ```bicep -module configurationStores './app-configuration/configuration-store/main.bicep' = { +module configurationStore './app-configuration/configuration-store/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-accpe' params: { // Required parameters diff --git a/modules/app/container-app/README.md b/modules/app/container-app/README.md index 66bf3e91b9..3ca4982e5b 100644 --- a/modules/app/container-app/README.md +++ b/modules/app/container-app/README.md @@ -224,7 +224,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module containerApps './app/container-app/main.bicep' = { +module containerApp './app/container-app/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-mcappcom' params: { // Required parameters @@ -371,7 +371,7 @@ module containerApps './app/container-app/main.bicep' = { via Bicep module ```bicep -module containerApps './app/container-app/main.bicep' = { +module containerApp './app/container-app/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-mcappmin' params: { // Required parameters diff --git a/modules/app/managed-environment/README.md b/modules/app/managed-environment/README.md index a2e32c436a..7ebf72c246 100644 --- a/modules/app/managed-environment/README.md +++ b/modules/app/managed-environment/README.md @@ -184,7 +184,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module managedEnvironments './app/managed-environment/main.bicep' = { +module managedEnvironment './app/managed-environment/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-amecom' params: { // Required parameters @@ -273,7 +273,7 @@ module managedEnvironments './app/managed-environment/main.bicep' = { via Bicep module ```bicep -module managedEnvironments './app/managed-environment/main.bicep' = { +module managedEnvironment './app/managed-environment/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-amemin' params: { // Required parameters diff --git a/modules/authorization/lock/README.md b/modules/authorization/lock/README.md index 2091a27ca9..1555dae44e 100644 --- a/modules/authorization/lock/README.md +++ b/modules/authorization/lock/README.md @@ -61,7 +61,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module locks './authorization/lock/main.bicep' = { +module lock './authorization/lock/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-alcom' params: { // Required parameters diff --git a/modules/authorization/policy-assignment/README.md b/modules/authorization/policy-assignment/README.md index 141d6b3f6e..92e149daaa 100644 --- a/modules/authorization/policy-assignment/README.md +++ b/modules/authorization/policy-assignment/README.md @@ -189,7 +189,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module policyAssignments './authorization/policy-assignment/main.bicep' = { +module policyAssignment './authorization/policy-assignment/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-apamgcom' params: { // Required parameters @@ -390,7 +390,7 @@ module policyAssignments './authorization/policy-assignment/main.bicep' = { via Bicep module ```bicep -module policyAssignments './authorization/policy-assignment/main.bicep' = { +module policyAssignment './authorization/policy-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apamgmin' params: { // Required parameters @@ -439,7 +439,7 @@ module policyAssignments './authorization/policy-assignment/main.bicep' = { via Bicep module ```bicep -module policyAssignments './authorization/policy-assignment/main.bicep' = { +module policyAssignment './authorization/policy-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apargcom' params: { // Required parameters @@ -648,7 +648,7 @@ module policyAssignments './authorization/policy-assignment/main.bicep' = { via Bicep module ```bicep -module policyAssignments './authorization/policy-assignment/main.bicep' = { +module policyAssignment './authorization/policy-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apargmin' params: { // Required parameters @@ -701,7 +701,7 @@ module policyAssignments './authorization/policy-assignment/main.bicep' = { via Bicep module ```bicep -module policyAssignments './authorization/policy-assignment/main.bicep' = { +module policyAssignment './authorization/policy-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apasubcom' params: { // Required parameters @@ -906,7 +906,7 @@ module policyAssignments './authorization/policy-assignment/main.bicep' = { via Bicep module ```bicep -module policyAssignments './authorization/policy-assignment/main.bicep' = { +module policyAssignment './authorization/policy-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apasubmin' params: { // Required parameters diff --git a/modules/authorization/policy-definition/README.md b/modules/authorization/policy-definition/README.md index 0d746c934c..8c284accfb 100644 --- a/modules/authorization/policy-definition/README.md +++ b/modules/authorization/policy-definition/README.md @@ -145,7 +145,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module policyDefinitions './authorization/policy-definition/main.bicep' = { +module policyDefinition './authorization/policy-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apdmgcom' params: { // Required parameters @@ -300,7 +300,7 @@ module policyDefinitions './authorization/policy-definition/main.bicep' = { via Bicep module ```bicep -module policyDefinitions './authorization/policy-definition/main.bicep' = { +module policyDefinition './authorization/policy-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apdmgmin' params: { // Required parameters @@ -393,7 +393,7 @@ module policyDefinitions './authorization/policy-definition/main.bicep' = { via Bicep module ```bicep -module policyDefinitions './authorization/policy-definition/main.bicep' = { +module policyDefinition './authorization/policy-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apdsubcom' params: { // Required parameters @@ -548,7 +548,7 @@ module policyDefinitions './authorization/policy-definition/main.bicep' = { via Bicep module ```bicep -module policyDefinitions './authorization/policy-definition/main.bicep' = { +module policyDefinition './authorization/policy-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apdsubmin' params: { // Required parameters diff --git a/modules/authorization/policy-exemption/README.md b/modules/authorization/policy-exemption/README.md index 5a1d631b7a..b37f665b6f 100644 --- a/modules/authorization/policy-exemption/README.md +++ b/modules/authorization/policy-exemption/README.md @@ -220,7 +220,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module policyExemptions './authorization/policy-exemption/main.bicep' = { +module policyExemption './authorization/policy-exemption/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apemgcom' params: { // Required parameters @@ -333,7 +333,7 @@ module policyExemptions './authorization/policy-exemption/main.bicep' = { via Bicep module ```bicep -module policyExemptions './authorization/policy-exemption/main.bicep' = { +module policyExemption './authorization/policy-exemption/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apemgmin' params: { // Required parameters @@ -382,7 +382,7 @@ module policyExemptions './authorization/policy-exemption/main.bicep' = { via Bicep module ```bicep -module policyExemptions './authorization/policy-exemption/main.bicep' = { +module policyExemption './authorization/policy-exemption/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apergcom' params: { // Required parameters @@ -495,7 +495,7 @@ module policyExemptions './authorization/policy-exemption/main.bicep' = { via Bicep module ```bicep -module policyExemptions './authorization/policy-exemption/main.bicep' = { +module policyExemption './authorization/policy-exemption/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apergmin' params: { // Required parameters @@ -544,7 +544,7 @@ module policyExemptions './authorization/policy-exemption/main.bicep' = { via Bicep module ```bicep -module policyExemptions './authorization/policy-exemption/main.bicep' = { +module policyExemption './authorization/policy-exemption/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apesubcom' params: { // Required parameters @@ -657,7 +657,7 @@ module policyExemptions './authorization/policy-exemption/main.bicep' = { via Bicep module ```bicep -module policyExemptions './authorization/policy-exemption/main.bicep' = { +module policyExemption './authorization/policy-exemption/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apesubmin' params: { // Required parameters diff --git a/modules/authorization/policy-set-definition/README.md b/modules/authorization/policy-set-definition/README.md index f190d9a415..9ec90f0cee 100644 --- a/modules/authorization/policy-set-definition/README.md +++ b/modules/authorization/policy-set-definition/README.md @@ -151,7 +151,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module policySetDefinitions './authorization/policy-set-definition/main.bicep' = { +module policySetDefinition './authorization/policy-set-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apsdmgcom' params: { // Required parameters @@ -294,7 +294,7 @@ module policySetDefinitions './authorization/policy-set-definition/main.bicep' = via Bicep module ```bicep -module policySetDefinitions './authorization/policy-set-definition/main.bicep' = { +module policySetDefinition './authorization/policy-set-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apsdmgmin' params: { // Required parameters @@ -365,7 +365,7 @@ module policySetDefinitions './authorization/policy-set-definition/main.bicep' = via Bicep module ```bicep -module policySetDefinitions './authorization/policy-set-definition/main.bicep' = { +module policySetDefinition './authorization/policy-set-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apsdsubcom' params: { // Required parameters @@ -508,7 +508,7 @@ module policySetDefinitions './authorization/policy-set-definition/main.bicep' = via Bicep module ```bicep -module policySetDefinitions './authorization/policy-set-definition/main.bicep' = { +module policySetDefinition './authorization/policy-set-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-apsdsubmin' params: { // Required parameters diff --git a/modules/authorization/role-assignment/README.md b/modules/authorization/role-assignment/README.md index df61fb4545..bfeb9d4da4 100644 --- a/modules/authorization/role-assignment/README.md +++ b/modules/authorization/role-assignment/README.md @@ -186,7 +186,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module roleAssignments './authorization/role-assignment/main.bicep' = { +module roleAssignment './authorization/role-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-aramgcom' params: { // Required parameters @@ -247,7 +247,7 @@ module roleAssignments './authorization/role-assignment/main.bicep' = { via Bicep module ```bicep -module roleAssignments './authorization/role-assignment/main.bicep' = { +module roleAssignment './authorization/role-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-aramgmin' params: { // Required parameters @@ -300,7 +300,7 @@ module roleAssignments './authorization/role-assignment/main.bicep' = { via Bicep module ```bicep -module roleAssignments './authorization/role-assignment/main.bicep' = { +module roleAssignment './authorization/role-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-arargcom' params: { // Required parameters @@ -365,7 +365,7 @@ module roleAssignments './authorization/role-assignment/main.bicep' = { via Bicep module ```bicep -module roleAssignments './authorization/role-assignment/main.bicep' = { +module roleAssignment './authorization/role-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-arargmin' params: { // Required parameters @@ -426,7 +426,7 @@ module roleAssignments './authorization/role-assignment/main.bicep' = { via Bicep module ```bicep -module roleAssignments './authorization/role-assignment/main.bicep' = { +module roleAssignment './authorization/role-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-arasubcom' params: { // Required parameters @@ -487,7 +487,7 @@ module roleAssignments './authorization/role-assignment/main.bicep' = { via Bicep module ```bicep -module roleAssignments './authorization/role-assignment/main.bicep' = { +module roleAssignment './authorization/role-assignment/main.bicep' = { name: '${uniqueString(deployment().name)}-test-arasubmin' params: { // Required parameters diff --git a/modules/authorization/role-definition/README.md b/modules/authorization/role-definition/README.md index 6502d42653..ba94584af6 100644 --- a/modules/authorization/role-definition/README.md +++ b/modules/authorization/role-definition/README.md @@ -190,7 +190,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module roleDefinitions './authorization/role-definition/main.bicep' = { +module roleDefinition './authorization/role-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-ardmgcom' params: { // Required parameters @@ -269,7 +269,7 @@ module roleDefinitions './authorization/role-definition/main.bicep' = { via Bicep module ```bicep -module roleDefinitions './authorization/role-definition/main.bicep' = { +module roleDefinition './authorization/role-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-ardmgmin' params: { // Required parameters @@ -324,7 +324,7 @@ module roleDefinitions './authorization/role-definition/main.bicep' = { via Bicep module ```bicep -module roleDefinitions './authorization/role-definition/main.bicep' = { +module roleDefinition './authorization/role-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-ardrgcom' params: { // Required parameters @@ -419,7 +419,7 @@ module roleDefinitions './authorization/role-definition/main.bicep' = { via Bicep module ```bicep -module roleDefinitions './authorization/role-definition/main.bicep' = { +module roleDefinition './authorization/role-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-ardrgmin' params: { // Required parameters @@ -474,7 +474,7 @@ module roleDefinitions './authorization/role-definition/main.bicep' = { via Bicep module ```bicep -module roleDefinitions './authorization/role-definition/main.bicep' = { +module roleDefinition './authorization/role-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-ardsubcom' params: { // Required parameters @@ -569,7 +569,7 @@ module roleDefinitions './authorization/role-definition/main.bicep' = { via Bicep module ```bicep -module roleDefinitions './authorization/role-definition/main.bicep' = { +module roleDefinition './authorization/role-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-ardsubmin' params: { // Required parameters diff --git a/modules/automation/automation-account/README.md b/modules/automation/automation-account/README.md index 7679adfcc1..1099651b4d 100644 --- a/modules/automation/automation-account/README.md +++ b/modules/automation/automation-account/README.md @@ -61,22 +61,22 @@ This module deploys an Azure Automation Account. | `disableLocalAuth` | bool | `True` | | Disable local authentication profile used within the resource. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `gallerySolutions` | array | `[]` | | List of gallerySolutions to be created in the linked log analytics workspace. | -| `jobSchedules` | _[jobSchedules](job-schedules/README.md)_ array | `[]` | | List of jobSchedules to be created in the automation account. | +| `jobSchedules` | array | `[]` | | List of jobSchedules to be created in the automation account. | | `linkedWorkspaceResourceId` | string | `''` | | ID of the log analytics workspace to be linked to the deployed automation account. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | -| `modules` | _[modules](modules/README.md)_ array | `[]` | | List of modules to be created in the automation account. | +| `modules` | array | `[]` | | List of modules to be created in the automation account. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | | `publicNetworkAccess` | string | `''` | `['', Disabled, Enabled]` | Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `runbooks` | _[runbooks](runbooks/README.md)_ array | `[]` | | List of runbooks to be created in the automation account. | -| `schedules` | _[schedules](schedules/README.md)_ array | `[]` | | List of schedules to be created in the automation account. | +| `runbooks` | array | `[]` | | List of runbooks to be created in the automation account. | +| `schedules` | array | `[]` | | List of schedules to be created in the automation account. | | `skuName` | string | `'Basic'` | `[Basic, Free]` | SKU name of the account. | -| `softwareUpdateConfigurations` | _[softwareUpdateConfigurations](software-update-configurations/README.md)_ array | `[]` | | List of softwareUpdateConfigurations to be created in the automation account. | +| `softwareUpdateConfigurations` | array | `[]` | | List of softwareUpdateConfigurations to be created in the automation account. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | | `tags` | object | `{object}` | | Tags of the Automation Account resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | -| `variables` | _[variables](variables/README.md)_ array | `[]` | | List of variables to be created in the automation account. | +| `variables` | array | `[]` | | List of variables to be created in the automation account. | ### Parameter Usage: `encryption` @@ -383,9 +383,9 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | -| `operational-insights/workspaces/linked-services` | Local reference | -| `operations-management/solutions` | Local reference | +| `network/private-endpoint` | Local reference | +| `operational-insights/workspace/linked-service` | Local reference | +| `operations-management/solution` | Local reference | ## Deployment examples @@ -401,7 +401,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module automationAccounts './automation/automation-account/main.bicep' = { +module automationAccount './automation/automation-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-aacom' params: { // Required parameters @@ -842,7 +842,7 @@ module automationAccounts './automation/automation-account/main.bicep' = { via Bicep module ```bicep -module automationAccounts './automation/automation-account/main.bicep' = { +module automationAccount './automation/automation-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-aaencr' params: { // Required parameters @@ -907,7 +907,7 @@ module automationAccounts './automation/automation-account/main.bicep' = { via Bicep module ```bicep -module automationAccounts './automation/automation-account/main.bicep' = { +module automationAccount './automation/automation-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-aamin' params: { // Required parameters diff --git a/modules/batch/batch-account/README.md b/modules/batch/batch-account/README.md index f04cabf355..e27c76e1ca 100644 --- a/modules/batch/batch-account/README.md +++ b/modules/batch/batch-account/README.md @@ -256,7 +256,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -272,7 +272,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module batchAccounts './batch/batch-account/main.bicep' = { +module batchAccount './batch/batch-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-bbacom' params: { // Required parameters @@ -421,7 +421,7 @@ module batchAccounts './batch/batch-account/main.bicep' = { via Bicep module ```bicep -module batchAccounts './batch/batch-account/main.bicep' = { +module batchAccount './batch/batch-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-bbaencr' params: { // Required parameters @@ -540,7 +540,7 @@ module batchAccounts './batch/batch-account/main.bicep' = { via Bicep module ```bicep -module batchAccounts './batch/batch-account/main.bicep' = { +module batchAccount './batch/batch-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-bbamin' params: { // Required parameters diff --git a/modules/cache/redis/README.md b/modules/cache/redis/README.md index 1d43d64d3c..94f11f48a3 100644 --- a/modules/cache/redis/README.md +++ b/modules/cache/redis/README.md @@ -350,7 +350,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples diff --git a/modules/cdn/profile/README.md b/modules/cdn/profile/README.md index 4f2a799d77..fbd9c4b680 100644 --- a/modules/cdn/profile/README.md +++ b/modules/cdn/profile/README.md @@ -171,7 +171,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module profiles './cdn/profile/main.bicep' = { +module profile './cdn/profile/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cdnpcom' params: { // Required parameters diff --git a/modules/cognitive-services/account/README.md b/modules/cognitive-services/account/README.md index e8b3b80385..33ab28034c 100644 --- a/modules/cognitive-services/account/README.md +++ b/modules/cognitive-services/account/README.md @@ -438,7 +438,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -454,7 +454,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module accounts './cognitive-services/account/main.bicep' = { +module account './cognitive-services/account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-csacom' params: { // Required parameters @@ -639,7 +639,7 @@ module accounts './cognitive-services/account/main.bicep' = { via Bicep module ```bicep -module accounts './cognitive-services/account/main.bicep' = { +module account './cognitive-services/account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-csaencr' params: { // Required parameters @@ -720,7 +720,7 @@ module accounts './cognitive-services/account/main.bicep' = { via Bicep module ```bicep -module accounts './cognitive-services/account/main.bicep' = { +module account './cognitive-services/account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-csamin' params: { // Required parameters @@ -769,7 +769,7 @@ module accounts './cognitive-services/account/main.bicep' = { via Bicep module ```bicep -module accounts './cognitive-services/account/main.bicep' = { +module account './cognitive-services/account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-csaspeech' params: { // Required parameters diff --git a/modules/compute/availability-set/README.md b/modules/compute/availability-set/README.md index fa366dbd48..9fe7f4a0ff 100644 --- a/modules/compute/availability-set/README.md +++ b/modules/compute/availability-set/README.md @@ -168,7 +168,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module availabilitySets './compute/availability-set/main.bicep' = { +module availabilitySet './compute/availability-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cascom' params: { // Required parameters @@ -251,7 +251,7 @@ module availabilitySets './compute/availability-set/main.bicep' = { via Bicep module ```bicep -module availabilitySets './compute/availability-set/main.bicep' = { +module availabilitySet './compute/availability-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-casmin' params: { // Required parameters diff --git a/modules/compute/disk-encryption-set/README.md b/modules/compute/disk-encryption-set/README.md index 17dd652977..3f2b118f7c 100644 --- a/modules/compute/disk-encryption-set/README.md +++ b/modules/compute/disk-encryption-set/README.md @@ -203,7 +203,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `key-vault/vaults/access-policies` | Local reference | +| `key-vault/vault/access-policy` | Local reference | ## Deployment examples @@ -219,7 +219,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module diskEncryptionSets './compute/disk-encryption-set/main.bicep' = { +module diskEncryptionSet './compute/disk-encryption-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cdesap' params: { // Required parameters @@ -314,7 +314,7 @@ module diskEncryptionSets './compute/disk-encryption-set/main.bicep' = { via Bicep module ```bicep -module diskEncryptionSets './compute/disk-encryption-set/main.bicep' = { +module diskEncryptionSet './compute/disk-encryption-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cdescom' params: { // Required parameters diff --git a/modules/compute/disk/README.md b/modules/compute/disk/README.md index 2e75ba784e..eed4e08682 100644 --- a/modules/compute/disk/README.md +++ b/modules/compute/disk/README.md @@ -191,7 +191,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module disks './compute/disk/main.bicep' = { +module disk './compute/disk/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cdcom' params: { // Required parameters @@ -298,7 +298,7 @@ module disks './compute/disk/main.bicep' = { via Bicep module ```bicep -module disks './compute/disk/main.bicep' = { +module disk './compute/disk/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cdimg' params: { // Required parameters @@ -385,7 +385,7 @@ module disks './compute/disk/main.bicep' = { via Bicep module ```bicep -module disks './compute/disk/main.bicep' = { +module disk './compute/disk/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cdimp' params: { // Required parameters @@ -476,7 +476,7 @@ module disks './compute/disk/main.bicep' = { via Bicep module ```bicep -module disks './compute/disk/main.bicep' = { +module disk './compute/disk/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cdmin' params: { // Required parameters diff --git a/modules/compute/gallery/README.md b/modules/compute/gallery/README.md index c51c47f081..68a64f36bc 100644 --- a/modules/compute/gallery/README.md +++ b/modules/compute/gallery/README.md @@ -32,10 +32,10 @@ This module deploys an Azure Compute Gallery (formerly known as Shared Image Gal | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `applications` | _[applications](applications/README.md)_ array | `[]` | | Applications to create. | +| `applications` | array | `[]` | | Applications to create. | | `description` | string | `''` | | Description of the Azure Shared Image Gallery. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `images` | _[images](images/README.md)_ array | `[]` | | Images to create. | +| `images` | array | `[]` | | Images to create. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | @@ -169,7 +169,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module galleries './compute/gallery/main.bicep' = { +module gallery './compute/gallery/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cgcom' params: { // Required parameters @@ -506,7 +506,7 @@ module galleries './compute/gallery/main.bicep' = { via Bicep module ```bicep -module galleries './compute/gallery/main.bicep' = { +module gallery './compute/gallery/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cgmin' params: { // Required parameters diff --git a/modules/compute/image/README.md b/modules/compute/image/README.md index 6257c38168..da954dedb1 100644 --- a/modules/compute/image/README.md +++ b/modules/compute/image/README.md @@ -176,7 +176,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module images './compute/image/main.bicep' = { +module image './compute/image/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cicom' params: { // Required parameters diff --git a/modules/compute/proximity-placement-group/README.md b/modules/compute/proximity-placement-group/README.md index 3ab6782041..6a8e84b799 100644 --- a/modules/compute/proximity-placement-group/README.md +++ b/modules/compute/proximity-placement-group/README.md @@ -168,7 +168,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module proximityPlacementGroups './compute/proximity-placement-group/main.bicep' = { +module proximityPlacementGroup './compute/proximity-placement-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cppgcom' params: { // Required parameters @@ -287,7 +287,7 @@ module proximityPlacementGroups './compute/proximity-placement-group/main.bicep' via Bicep module ```bicep -module proximityPlacementGroups './compute/proximity-placement-group/main.bicep' = { +module proximityPlacementGroup './compute/proximity-placement-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cppgmin' params: { // Required parameters diff --git a/modules/compute/ssh-public-key/README.md b/modules/compute/ssh-public-key/README.md index 33f77453fd..ff38ea2ad3 100644 --- a/modules/compute/ssh-public-key/README.md +++ b/modules/compute/ssh-public-key/README.md @@ -167,7 +167,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module sshPublicKeys './compute/ssh-public-key/main.bicep' = { +module sshPublicKey './compute/ssh-public-key/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cspkcom' params: { // Required parameters @@ -216,7 +216,7 @@ module sshPublicKeys './compute/ssh-public-key/main.bicep' = { via Bicep module ```bicep -module sshPublicKeys './compute/ssh-public-key/main.bicep' = { +module sshPublicKey './compute/ssh-public-key/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cspkmin' params: { // Required parameters diff --git a/modules/compute/virtual-machine-scale-set/README.md b/modules/compute/virtual-machine-scale-set/README.md index a4541f1d29..4ec607b828 100644 --- a/modules/compute/virtual-machine-scale-set/README.md +++ b/modules/compute/virtual-machine-scale-set/README.md @@ -909,7 +909,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' = { +module virtualMachineScaleSet './compute/virtual-machine-scale-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmsslin' params: { // Required parameters @@ -1262,7 +1262,7 @@ module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' via Bicep module ```bicep -module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' = { +module virtualMachineScaleSet './compute/virtual-machine-scale-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmsslinmin' params: { // Required parameters @@ -1399,7 +1399,7 @@ module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' via Bicep module ```bicep -module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' = { +module virtualMachineScaleSet './compute/virtual-machine-scale-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmsslcmk' params: { // Required parameters @@ -1584,7 +1584,7 @@ module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' via Bicep module ```bicep -module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' = { +module virtualMachineScaleSet './compute/virtual-machine-scale-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmsswin' params: { // Required parameters @@ -1919,7 +1919,7 @@ module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' via Bicep module ```bicep -module virtualMachineScaleSets './compute/virtual-machine-scale-set/main.bicep' = { +module virtualMachineScaleSet './compute/virtual-machine-scale-set/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmsswinmin' params: { // Required parameters diff --git a/modules/compute/virtual-machine/README.md b/modules/compute/virtual-machine/README.md index 0e4a9982cd..b405407096 100644 --- a/modules/compute/virtual-machine/README.md +++ b/modules/compute/virtual-machine/README.md @@ -1026,7 +1026,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `recovery-services/vaults/backup-fabrics/protection-containers/protected-items` | Local reference | +| `recovery-services/vault/backup-fabric/protection-container/protected-item` | Local reference | ## Deployment examples @@ -1042,7 +1042,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module virtualMachines './compute/virtual-machine/main.bicep' = { +module virtualMachine './compute/virtual-machine/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmlincom' params: { // Required parameters @@ -1539,7 +1539,7 @@ module virtualMachines './compute/virtual-machine/main.bicep' = { via Bicep module ```bicep -module virtualMachines './compute/virtual-machine/main.bicep' = { +module virtualMachine './compute/virtual-machine/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmlinatmg' params: { // Required parameters @@ -1706,7 +1706,7 @@ module virtualMachines './compute/virtual-machine/main.bicep' = { via Bicep module ```bicep -module virtualMachines './compute/virtual-machine/main.bicep' = { +module virtualMachine './compute/virtual-machine/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmlinmin' params: { // Required parameters @@ -1843,7 +1843,7 @@ module virtualMachines './compute/virtual-machine/main.bicep' = { via Bicep module ```bicep -module virtualMachines './compute/virtual-machine/main.bicep' = { +module virtualMachine './compute/virtual-machine/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmwincom' params: { // Required parameters @@ -2376,7 +2376,7 @@ module virtualMachines './compute/virtual-machine/main.bicep' = { via Bicep module ```bicep -module virtualMachines './compute/virtual-machine/main.bicep' = { +module virtualMachine './compute/virtual-machine/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmwinatmg' params: { // Required parameters @@ -2507,7 +2507,7 @@ module virtualMachines './compute/virtual-machine/main.bicep' = { via Bicep module ```bicep -module virtualMachines './compute/virtual-machine/main.bicep' = { +module virtualMachine './compute/virtual-machine/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmwinmin' params: { // Required parameters @@ -2624,7 +2624,7 @@ module virtualMachines './compute/virtual-machine/main.bicep' = { via Bicep module ```bicep -module virtualMachines './compute/virtual-machine/main.bicep' = { +module virtualMachine './compute/virtual-machine/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cvmwincmk' params: { // Required parameters diff --git a/modules/consumption/budget/README.md b/modules/consumption/budget/README.md index 9b2127ef05..191cc3a890 100644 --- a/modules/consumption/budget/README.md +++ b/modules/consumption/budget/README.md @@ -72,7 +72,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module budgets './consumption/budget/main.bicep' = { +module budget './consumption/budget/main.bicep' = { name: '${uniqueString(deployment().name)}-test-cbcom' params: { // Required parameters @@ -145,7 +145,7 @@ module budgets './consumption/budget/main.bicep' = { via Bicep module ```bicep -module budgets './consumption/budget/main.bicep' = { +module budget './consumption/budget/main.bicep' = { name: '${uniqueString(deployment().name)}-test-cbmin' params: { // Required parameters diff --git a/modules/container-instance/container-group/README.md b/modules/container-instance/container-group/README.md index ccccaacb43..109433ddb9 100644 --- a/modules/container-instance/container-group/README.md +++ b/modules/container-instance/container-group/README.md @@ -308,7 +308,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module containerGroups './container-instance/container-group/main.bicep' = { +module containerGroup './container-instance/container-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cicgcom' params: { // Required parameters @@ -495,7 +495,7 @@ module containerGroups './container-instance/container-group/main.bicep' = { via Bicep module ```bicep -module containerGroups './container-instance/container-group/main.bicep' = { +module containerGroup './container-instance/container-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cicgenc' params: { // Required parameters @@ -694,7 +694,7 @@ module containerGroups './container-instance/container-group/main.bicep' = { via Bicep module ```bicep -module containerGroups './container-instance/container-group/main.bicep' = { +module containerGroup './container-instance/container-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cicgmin' params: { // Required parameters @@ -795,7 +795,7 @@ module containerGroups './container-instance/container-group/main.bicep' = { via Bicep module ```bicep -module containerGroups './container-instance/container-group/main.bicep' = { +module containerGroup './container-instance/container-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-cicgprivate' params: { // Required parameters diff --git a/modules/container-registry/registry/README.md b/modules/container-registry/registry/README.md index 55a3aca8ba..dc3bf65c9a 100644 --- a/modules/container-registry/registry/README.md +++ b/modules/container-registry/registry/README.md @@ -67,7 +67,7 @@ This module deploys an Azure Container Registry (ACR). | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. Note, requires the 'acrSku' to be 'Premium'. | | `publicNetworkAccess` | string | `''` | `['', Disabled, Enabled]` | Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set and networkRuleSetIpRules are not set. Note, requires the 'acrSku' to be 'Premium'. | | `quarantinePolicyStatus` | string | `'disabled'` | `[disabled, enabled]` | The value that indicates whether the quarantine policy is enabled or not. | -| `replications` | _[replications](replications/README.md)_ array | `[]` | | All replications to create. | +| `replications` | array | `[]` | | All replications to create. | | `retentionPolicyDays` | int | `15` | | The number of days to retain an untagged manifest after which it gets purged. | | `retentionPolicyStatus` | string | `'enabled'` | `[disabled, enabled]` | The value that indicates whether the retention policy is enabled or not. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | @@ -77,7 +77,7 @@ This module deploys an Azure Container Registry (ACR). | `tags` | object | `{object}` | | Tags of the resource. | | `trustPolicyStatus` | string | `'disabled'` | `[disabled, enabled]` | The value that indicates whether the trust policy is enabled or not. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | -| `webhooks` | _[webhooks](webhooks/README.md)_ array | `[]` | | All webhooks to create. | +| `webhooks` | array | `[]` | | All webhooks to create. | | `zoneRedundancy` | string | `'Disabled'` | `[Disabled, Enabled]` | Whether or not zone redundancy is enabled for this container registry. | @@ -366,7 +366,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -382,7 +382,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module registries './container-registry/registry/main.bicep' = { +module registry './container-registry/registry/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-crrcom' params: { // Required parameters @@ -599,7 +599,7 @@ module registries './container-registry/registry/main.bicep' = { via Bicep module ```bicep -module registries './container-registry/registry/main.bicep' = { +module registry './container-registry/registry/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-crrencr' params: { // Required parameters @@ -682,7 +682,7 @@ module registries './container-registry/registry/main.bicep' = { via Bicep module ```bicep -module registries './container-registry/registry/main.bicep' = { +module registry './container-registry/registry/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-crrmin' params: { // Required parameters @@ -727,7 +727,7 @@ module registries './container-registry/registry/main.bicep' = { via Bicep module ```bicep -module registries './container-registry/registry/main.bicep' = { +module registry './container-registry/registry/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-crrpe' params: { // Required parameters diff --git a/modules/container-service/managed-cluster/README.md b/modules/container-service/managed-cluster/README.md index c9314a34f8..a601b0f019 100644 --- a/modules/container-service/managed-cluster/README.md +++ b/modules/container-service/managed-cluster/README.md @@ -49,7 +49,7 @@ This module deploys an Azure Kubernetes Service (AKS) Managed Cluster. | `aadProfileServerAppSecret` | string | `''` | | The server AAD application secret. | | `aadProfileTenantId` | string | `[subscription().tenantId]` | | Specifies the tenant ID of the Azure Active Directory used by the AKS cluster for authentication. | | `aciConnectorLinuxEnabled` | bool | `False` | | Specifies whether the aciConnectorLinux add-on is enabled or not. | -| `agentPools` | _[agentPools](agent-pools/README.md)_ array | `[]` | | Define one or more secondary/additional agent pools. | +| `agentPools` | array | `[]` | | Define one or more secondary/additional agent pools. | | `aksClusterAdminUsername` | string | `'azureuser'` | | Specifies the administrator username of Linux virtual machines. | | `aksClusterDnsPrefix` | string | `[parameters('name')]` | | Specifies the DNS prefix specified when creating the managed cluster. | | `aksClusterDnsServiceIP` | string | `''` | | Specifies the IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. | @@ -376,8 +376,8 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `kubernetes-configuration/extensions` | Local reference | -| `kubernetes-configuration/flux-configurations` | Local reference | +| `kubernetes-configuration/extension` | Local reference | +| `kubernetes-configuration/flux-configuration` | Local reference | ## Deployment examples @@ -393,7 +393,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module managedClusters './container-service/managed-cluster/main.bicep' = { +module managedCluster './container-service/managed-cluster/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-csmaz' params: { // Required parameters @@ -774,7 +774,7 @@ module managedClusters './container-service/managed-cluster/main.bicep' = { via Bicep module ```bicep -module managedClusters './container-service/managed-cluster/main.bicep' = { +module managedCluster './container-service/managed-cluster/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-csmkube' params: { // Required parameters @@ -1025,7 +1025,7 @@ module managedClusters './container-service/managed-cluster/main.bicep' = { via Bicep module ```bicep -module managedClusters './container-service/managed-cluster/main.bicep' = { +module managedCluster './container-service/managed-cluster/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-csmmin' params: { // Required parameters @@ -1092,7 +1092,7 @@ module managedClusters './container-service/managed-cluster/main.bicep' = { via Bicep module ```bicep -module managedClusters './container-service/managed-cluster/main.bicep' = { +module managedCluster './container-service/managed-cluster/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-csmpriv' params: { // Required parameters diff --git a/modules/data-factory/factory/README.md b/modules/data-factory/factory/README.md index 6651e101c5..01a81857c9 100644 --- a/modules/data-factory/factory/README.md +++ b/modules/data-factory/factory/README.md @@ -64,7 +64,7 @@ This module deploys a Data Factory. | `gitRepoType` | string | `'FactoryVSTSConfiguration'` | | Repository type - can be 'FactoryVSTSConfiguration' or 'FactoryGitHubConfiguration'. Default is 'FactoryVSTSConfiguration'. | | `gitRootFolder` | string | `'/'` | | The root folder path name. Default is '/'. | | `globalParameters` | object | `{object}` | | List of Global Parameters for the factory. | -| `integrationRuntimes` | _[integrationRuntimes](integration-runtimes/README.md)_ array | `[]` | | An array of objects for the configuration of an Integration Runtime. | +| `integrationRuntimes` | array | `[]` | | An array of objects for the configuration of an Integration Runtime. | | `location` | string | `[resourceGroup().location]` | | Location for all Resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `managedPrivateEndpoints` | array | `[]` | | An array of managed private endpoints objects created in the Data Factory managed virtual network. | @@ -376,7 +376,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -392,7 +392,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module factories './data-factory/factory/main.bicep' = { +module factory './data-factory/factory/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dffcom' params: { // Required parameters @@ -623,7 +623,7 @@ module factories './data-factory/factory/main.bicep' = { via Bicep module ```bicep -module factories './data-factory/factory/main.bicep' = { +module factory './data-factory/factory/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dffmin' params: { // Required parameters diff --git a/modules/data-factory/factory/main.bicep b/modules/data-factory/factory/main.bicep index 934a3cf37b..f4a7ae7072 100644 --- a/modules/data-factory/factory/main.bicep +++ b/modules/data-factory/factory/main.bicep @@ -225,7 +225,7 @@ resource dataFactory 'Microsoft.DataFactory/factories@2018-06-01' = { } } -module dataFactory_managedVirtualNetwork '/main.bicep' = if (!empty(managedVirtualNetworkName)) { +module dataFactory_managedVirtualNetwork 'managed-virtual-network/main.bicep' = if (!empty(managedVirtualNetworkName)) { name: '${uniqueString(deployment().name, location)}-DataFactory-ManagedVNet' params: { name: managedVirtualNetworkName @@ -235,7 +235,7 @@ module dataFactory_managedVirtualNetwork '/main.bicep' = if (!empty(managedVirtu } } -module dataFactory_integrationRuntimes '/main.bicep' = [for (integrationRuntime, index) in integrationRuntimes: { +module dataFactory_integrationRuntimes 'integration-runtime/main.bicep' = [for (integrationRuntime, index) in integrationRuntimes: { name: '${uniqueString(deployment().name, location)}-DataFactory-IntegrationRuntime-${index}' params: { dataFactoryName: dataFactory.name diff --git a/modules/data-factory/factory/managed-virtual-network/README.md b/modules/data-factory/factory/managed-virtual-network/README.md index 6f6fa8a26d..d1da00c980 100644 --- a/modules/data-factory/factory/managed-virtual-network/README.md +++ b/modules/data-factory/factory/managed-virtual-network/README.md @@ -35,7 +35,7 @@ This module deploys a Data Factory Managed Virtual Network. | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | -| `managedPrivateEndpoints` | _[managedPrivateEndpoints](managed-private-endpoints/README.md)_ array | `[]` | An array of managed private endpoints objects created in the Data Factory managed virtual network. | +| `managedPrivateEndpoints` | array | `[]` | An array of managed private endpoints objects created in the Data Factory managed virtual network. | ### Parameter Usage: `managedPrivateEndpoints` diff --git a/modules/data-factory/factory/managed-virtual-network/main.bicep b/modules/data-factory/factory/managed-virtual-network/main.bicep index 0ca6924f70..61e71c1ea7 100644 --- a/modules/data-factory/factory/managed-virtual-network/main.bicep +++ b/modules/data-factory/factory/managed-virtual-network/main.bicep @@ -38,7 +38,7 @@ resource managedVirtualNetwork 'Microsoft.DataFactory/factories/managedVirtualNe properties: {} } -module managedVirtualNetwork_managedPrivateEndpoint '/main.bicep' = [for (managedPrivateEndpoint, index) in managedPrivateEndpoints: { +module managedVirtualNetwork_managedPrivateEndpoint 'managed-private-endpoint/main.bicep' = [for (managedPrivateEndpoint, index) in managedPrivateEndpoints: { name: '${deployment().name}-managedPrivateEndpoint-${index}' params: { dataFactoryName: dataFactoryName diff --git a/modules/data-protection/backup-vault/README.md b/modules/data-protection/backup-vault/README.md index a8ec89ee26..1dd564e8e0 100644 --- a/modules/data-protection/backup-vault/README.md +++ b/modules/data-protection/backup-vault/README.md @@ -32,7 +32,7 @@ This module deploys a Data Protection Backup Vault. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `azureMonitorAlertSettingsAlertsForAllJobFailures` | string | `'Enabled'` | `[Disabled, Enabled]` | Settings for Azure Monitor based alerts for job failures. | -| `backupPolicies` | _[backupPolicies](backup-policies/README.md)_ array | `[]` | | List of all backup policies. | +| `backupPolicies` | array | `[]` | | List of all backup policies. | | `dataStoreType` | string | `'VaultStore'` | `[ArchiveStore, OperationalStore, VaultStore]` | The datastore type to use. ArchiveStore does not support ZoneRedundancy. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | @@ -351,7 +351,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module backupVaults './data-protection/backup-vault/main.bicep' = { +module backupVault './data-protection/backup-vault/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dpbvcom' params: { // Required parameters @@ -564,7 +564,7 @@ module backupVaults './data-protection/backup-vault/main.bicep' = { via Bicep module ```bicep -module backupVaults './data-protection/backup-vault/main.bicep' = { +module backupVault './data-protection/backup-vault/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dpbvmin' params: { // Required parameters diff --git a/modules/databricks/workspace/README.md b/modules/databricks/workspace/README.md index 5d44290736..d8e0d0bd23 100644 --- a/modules/databricks/workspace/README.md +++ b/modules/databricks/workspace/README.md @@ -240,7 +240,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module workspaces './databricks/workspace/main.bicep' = { +module workspace './databricks/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dwcom' params: { // Required parameters diff --git a/modules/db-for-my-sql/flexible-server/README.md b/modules/db-for-my-sql/flexible-server/README.md index 38be617a79..b9be319b7a 100644 --- a/modules/db-for-my-sql/flexible-server/README.md +++ b/modules/db-for-my-sql/flexible-server/README.md @@ -56,7 +56,7 @@ This module deploys a DBforMySQL Flexible Server. | `cMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption. | | `cMKKeyVersion` | string | `''` | | The version of the customer managed key to reference for encryption. If not provided, the latest key version is used. | | `createMode` | string | `'Default'` | `[Default, GeoRestore, PointInTimeRestore, Replica]` | The mode to create a new MySQL server. | -| `databases` | _[databases](databases/README.md)_ array | `[]` | | The databases to create in the server. | +| `databases` | array | `[]` | | The databases to create in the server. | | `delegatedSubnetResourceId` | string | `''` | | Delegated subnet arm resource ID. Used when the desired connectivity mode is "Private Access" - virtual network integration. Delegation must be enabled on the subnet for MySQL Flexible Servers and subnet CIDR size is /29. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | @@ -67,7 +67,7 @@ This module deploys a DBforMySQL Flexible Server. | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of the diagnostic log analytics workspace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `firewallRules` | _[firewallRules](firewall-rules/README.md)_ array | `[]` | | The firewall rules to create in the MySQL flexible server. | +| `firewallRules` | array | `[]` | | The firewall rules to create in the MySQL flexible server. | | `geoBackupCMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption when geoRedundantBackup is "Enabled". | | `geoBackupCMKKeyVersion` | string | `''` | | The version of the customer managed key to reference for encryption when geoRedundantBackup is "Enabled". If not provided, the latest key version is used. | | `geoRedundantBackup` | string | `'Disabled'` | `[Disabled, Enabled]` | A value indicating whether Geo-Redundant backup is enabled on the server. If "Enabled" and "cMKKeyName" is not empty, then "geoBackupCMKKeyVaultResourceId" and "cMKUserAssignedIdentityResourceId" are also required. | @@ -244,7 +244,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module flexibleServers './db-for-my-sql/flexible-server/main.bicep' = { +module flexibleServer './db-for-my-sql/flexible-server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dfmsfsmin' params: { // Required parameters @@ -305,7 +305,7 @@ module flexibleServers './db-for-my-sql/flexible-server/main.bicep' = { via Bicep module ```bicep -module flexibleServers './db-for-my-sql/flexible-server/main.bicep' = { +module flexibleServer './db-for-my-sql/flexible-server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dfmsfspvt' params: { // Required parameters @@ -476,7 +476,7 @@ module flexibleServers './db-for-my-sql/flexible-server/main.bicep' = { via Bicep module ```bicep -module flexibleServers './db-for-my-sql/flexible-server/main.bicep' = { +module flexibleServer './db-for-my-sql/flexible-server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dfmsfsp' params: { // Required parameters diff --git a/modules/db-for-postgre-sql/flexible-server/README.md b/modules/db-for-postgre-sql/flexible-server/README.md index bfc4d14c56..d6a9a3a6db 100644 --- a/modules/db-for-postgre-sql/flexible-server/README.md +++ b/modules/db-for-postgre-sql/flexible-server/README.md @@ -52,9 +52,9 @@ This module deploys a DBforPostgreSQL Flexible Server. | `backupRetentionDays` | int | `7` | | Backup retention days for the server. | | `cMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption. | | `cMKKeyVersion` | string | `''` | | The version of the customer managed key to reference for encryption. If not provided, the latest key version is used. | -| `configurations` | _[configurations](configurations/README.md)_ array | `[]` | | The configurations to create in the server. | +| `configurations` | array | `[]` | | The configurations to create in the server. | | `createMode` | string | `'Default'` | `[Create, Default, PointInTimeRestore, Update]` | The mode to create a new PostgreSQL server. | -| `databases` | _[databases](databases/README.md)_ array | `[]` | | The databases to create in the server. | +| `databases` | array | `[]` | | The databases to create in the server. | | `delegatedSubnetResourceId` | string | `''` | | Delegated subnet arm resource ID. Used when the desired connectivity mode is "Private Access" - virtual network integration. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | @@ -65,7 +65,7 @@ This module deploys a DBforPostgreSQL Flexible Server. | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of the diagnostic log analytics workspace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `firewallRules` | _[firewallRules](firewall-rules/README.md)_ array | `[]` | | The firewall rules to create in the PostgreSQL flexible server. | +| `firewallRules` | array | `[]` | | The firewall rules to create in the PostgreSQL flexible server. | | `geoRedundantBackup` | string | `'Disabled'` | `[Disabled, Enabled]` | A value indicating whether Geo-Redundant backup is enabled on the server. Should be left disabled if 'cMKKeyName' is not empty. | | `highAvailability` | string | `'Disabled'` | `[Disabled, SameZone, ZoneRedundant]` | The mode for high availability. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | @@ -381,7 +381,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module flexibleServers './db-for-postgre-sql/flexible-server/main.bicep' = { +module flexibleServer './db-for-postgre-sql/flexible-server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dfpsfsmin' params: { // Required parameters @@ -442,7 +442,7 @@ module flexibleServers './db-for-postgre-sql/flexible-server/main.bicep' = { via Bicep module ```bicep -module flexibleServers './db-for-postgre-sql/flexible-server/main.bicep' = { +module flexibleServer './db-for-postgre-sql/flexible-server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dfpsfspvt' params: { // Required parameters @@ -593,7 +593,7 @@ module flexibleServers './db-for-postgre-sql/flexible-server/main.bicep' = { via Bicep module ```bicep -module flexibleServers './db-for-postgre-sql/flexible-server/main.bicep' = { +module flexibleServer './db-for-postgre-sql/flexible-server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dfpsfsp' params: { // Required parameters diff --git a/modules/desktop-virtualization/application-group/README.md b/modules/desktop-virtualization/application-group/README.md index b848104b87..36c167f77a 100644 --- a/modules/desktop-virtualization/application-group/README.md +++ b/modules/desktop-virtualization/application-group/README.md @@ -34,7 +34,7 @@ This module deploys an Azure Virtual Desktop (AVD) Application Group. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `applications` | _[applications](applications/README.md)_ array | `[]` | | List of applications to be created in the Application Group. | +| `applications` | array | `[]` | | List of applications to be created in the Application Group. | | `description` | string | `''` | | The description of the Application Group to be created. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | @@ -178,7 +178,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module applicationGroups './desktop-virtualization/application-group/main.bicep' = { +module applicationGroup './desktop-virtualization/application-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dvagcom' params: { // Required parameters @@ -335,7 +335,7 @@ module applicationGroups './desktop-virtualization/application-group/main.bicep' via Bicep module ```bicep -module applicationGroups './desktop-virtualization/application-group/main.bicep' = { +module applicationGroup './desktop-virtualization/application-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dvagmin' params: { // Required parameters diff --git a/modules/desktop-virtualization/host-pool/README.md b/modules/desktop-virtualization/host-pool/README.md index 73cfb265a4..8b189af837 100644 --- a/modules/desktop-virtualization/host-pool/README.md +++ b/modules/desktop-virtualization/host-pool/README.md @@ -281,7 +281,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module hostPools './desktop-virtualization/host-pool/main.bicep' = { +module hostPool './desktop-virtualization/host-pool/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dvhpcom' params: { // Required parameters @@ -480,7 +480,7 @@ module hostPools './desktop-virtualization/host-pool/main.bicep' = { via Bicep module ```bicep -module hostPools './desktop-virtualization/host-pool/main.bicep' = { +module hostPool './desktop-virtualization/host-pool/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dvhpmin' params: { // Required parameters diff --git a/modules/desktop-virtualization/scaling-plan/README.md b/modules/desktop-virtualization/scaling-plan/README.md index 5afd7bc72f..28ec89ea82 100644 --- a/modules/desktop-virtualization/scaling-plan/README.md +++ b/modules/desktop-virtualization/scaling-plan/README.md @@ -277,7 +277,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module scalingPlans './desktop-virtualization/scaling-plan/main.bicep' = { +module scalingPlan './desktop-virtualization/scaling-plan/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dvspcom' params: { // Required parameters @@ -384,7 +384,7 @@ module scalingPlans './desktop-virtualization/scaling-plan/main.bicep' = { via Bicep module ```bicep -module scalingPlans './desktop-virtualization/scaling-plan/main.bicep' = { +module scalingPlan './desktop-virtualization/scaling-plan/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dvspmin' params: { // Required parameters diff --git a/modules/desktop-virtualization/workspace/README.md b/modules/desktop-virtualization/workspace/README.md index d424f4929e..f1be8d6dec 100644 --- a/modules/desktop-virtualization/workspace/README.md +++ b/modules/desktop-virtualization/workspace/README.md @@ -175,7 +175,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module workspaces './desktop-virtualization/workspace/main.bicep' = { +module workspace './desktop-virtualization/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dvwcom' params: { // Required parameters @@ -294,7 +294,7 @@ module workspaces './desktop-virtualization/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './desktop-virtualization/workspace/main.bicep' = { +module workspace './desktop-virtualization/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dvwmin' params: { // Required parameters diff --git a/modules/dev-test-lab/lab/README.md b/modules/dev-test-lab/lab/README.md index e37567c373..6cc88abf36 100644 --- a/modules/dev-test-lab/lab/README.md +++ b/modules/dev-test-lab/lab/README.md @@ -37,17 +37,17 @@ This module deploys a DevTest Lab. | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `encryptionDiskEncryptionSetId` | string | `''` | The Disk Encryption Set Resource ID used to encrypt OS and data disks created as part of the the lab. Required if encryptionType is set to "EncryptionAtRestWithCustomerKey". | -| `notificationchannels` | _[notificationchannels](notificationchannels/README.md)_ array | `[]` | Notification Channels to create for the lab. Required if the schedules property "notificationSettingsStatus" is set to "Enabled. | +| `notificationchannels` | array | `[]` | Notification Channels to create for the lab. Required if the schedules property "notificationSettingsStatus" is set to "Enabled. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `announcement` | object | `{object}` | | The properties of any lab announcement associated with this lab. | -| `artifactsources` | _[artifactsources](artifactsources/README.md)_ array | `[]` | | Artifact sources to create for the lab. | +| `artifactsources` | array | `[]` | | Artifact sources to create for the lab. | | `artifactsStorageAccount` | string | `''` | | The resource ID of the storage account used to store artifacts and images by the lab. Also used for defaultStorageAccount, defaultPremiumStorageAccount and premiumDataDiskStorageAccount properties. If left empty, a default storage account will be created by the lab and used. | | `browserConnect` | string | `'Disabled'` | `[Disabled, Enabled]` | Enable browser connect on virtual machines if the lab's VNETs have configured Azure Bastion. | -| `costs` | _[costs](costs/README.md)_ object | `{object}` | | Costs to create for the lab. | +| `costs` | object | `{object}` | | Costs to create for the lab. | | `disableAutoUpgradeCseMinorVersion` | bool | `False` | | Disable auto upgrade custom script extension minor version. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `encryptionType` | string | `'EncryptionAtRestWithPlatformKey'` | `[EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformKey]` | Specify how OS and data disks created as part of the lab are encrypted. | @@ -63,11 +63,11 @@ This module deploys a DevTest Lab. | `policies` | array | `[]` | | Policies to create for the lab. | | `premiumDataDisks` | string | `'Disabled'` | `[Disabled, Enabled]` | The setting to enable usage of premium data disks. When its value is "Enabled", creation of standard or premium data disks is allowed. When its value is "Disabled", only creation of standard data disks is allowed. Default is "Disabled". | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalIds' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `schedules` | _[schedules](schedules/README.md)_ array | `[]` | | Schedules to create for the lab. | +| `schedules` | array | `[]` | | Schedules to create for the lab. | | `support` | object | `{object}` | | The properties of any lab support message associated with this lab. | | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | -| `virtualnetworks` | _[virtualnetworks](virtualnetworks/README.md)_ array | `[]` | | Virtual networks to create for the lab. | +| `virtualnetworks` | array | `[]` | | Virtual networks to create for the lab. | | `vmCreationResourceGroupId` | string | `[resourceGroup().id]` | | Resource Group allocation for virtual machines. If left empty, virtual machines will be deployed in their own Resource Groups. Default is the same Resource Group for DevTest Lab. | @@ -233,7 +233,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module labs './dev-test-lab/lab/main.bicep' = { +module lab './dev-test-lab/lab/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dtllcom' params: { // Required parameters @@ -764,7 +764,7 @@ module labs './dev-test-lab/lab/main.bicep' = { via Bicep module ```bicep -module labs './dev-test-lab/lab/main.bicep' = { +module lab './dev-test-lab/lab/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dtllmin' params: { // Required parameters diff --git a/modules/digital-twins/digital-twins-instance/README.md b/modules/digital-twins/digital-twins-instance/README.md index 4156ded06c..475adddc2f 100644 --- a/modules/digital-twins/digital-twins-instance/README.md +++ b/modules/digital-twins/digital-twins-instance/README.md @@ -434,7 +434,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -450,7 +450,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module digitalTwinsInstances './digital-twins/digital-twins-instance/main.bicep' = { +module digitalTwinsInstance './digital-twins/digital-twins-instance/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dtdticom' params: { // Required parameters @@ -619,7 +619,7 @@ module digitalTwinsInstances './digital-twins/digital-twins-instance/main.bicep' via Bicep module ```bicep -module digitalTwinsInstances './digital-twins/digital-twins-instance/main.bicep' = { +module digitalTwinsInstance './digital-twins/digital-twins-instance/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dtdtimin' params: { // Required parameters diff --git a/modules/document-db/database-account/README.md b/modules/document-db/database-account/README.md index f5909a55b2..e0f3ad0023 100644 --- a/modules/document-db/database-account/README.md +++ b/modules/document-db/database-account/README.md @@ -59,16 +59,16 @@ This module deploys a DocumentDB Database Account. | `diagnosticWorkspaceId` | string | `''` | | Resource ID of the log analytics workspace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `enableFreeTier` | bool | `False` | | Flag to indicate whether Free Tier is enabled. | -| `gremlinDatabases` | _[gremlinDatabases](gremlin-databases/README.md)_ array | `[]` | | Gremlin Databases configurations. | +| `gremlinDatabases` | array | `[]` | | Gremlin Databases configurations. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `maxIntervalInSeconds` | int | `300` | | Max lag time (minutes). Required for BoundedStaleness. Valid ranges, Single Region: 5 to 84600. Multi Region: 300 to 86400. | | `maxStalenessPrefix` | int | `100000` | | Max stale requests. Required for BoundedStaleness. Valid ranges, Single Region: 10 to 1000000. Multi Region: 100000 to 1000000. | -| `mongodbDatabases` | _[mongodbDatabases](mongodb-databases/README.md)_ array | `[]` | | MongoDB Databases configurations. | +| `mongodbDatabases` | array | `[]` | | MongoDB Databases configurations. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalIds' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `serverVersion` | string | `'4.2'` | `[3.2, 3.6, 4.0, 4.2]` | Specifies the MongoDB server version to use. | -| `sqlDatabases` | _[sqlDatabases](sql-databases/README.md)_ array | `[]` | | SQL Databases configurations. | +| `sqlDatabases` | array | `[]` | | SQL Databases configurations. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | | `tags` | object | `{object}` | | Tags of the Database Account resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | @@ -643,7 +643,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -659,7 +659,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module databaseAccounts './document-db/database-account/main.bicep' = { +module databaseAccount './document-db/database-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dddagrm' params: { // Required parameters @@ -894,7 +894,7 @@ module databaseAccounts './document-db/database-account/main.bicep' = { via Bicep module ```bicep -module databaseAccounts './document-db/database-account/main.bicep' = { +module databaseAccount './document-db/database-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dddamng' params: { // Required parameters @@ -1393,7 +1393,7 @@ module databaseAccounts './document-db/database-account/main.bicep' = { via Bicep module ```bicep -module databaseAccounts './document-db/database-account/main.bicep' = { +module databaseAccount './document-db/database-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dddapln' params: { // Required parameters @@ -1518,7 +1518,7 @@ module databaseAccounts './document-db/database-account/main.bicep' = { via Bicep module ```bicep -module databaseAccounts './document-db/database-account/main.bicep' = { +module databaseAccount './document-db/database-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-dddasql' params: { // Required parameters diff --git a/modules/document-db/database-account/gremlin-database/README.md b/modules/document-db/database-account/gremlin-database/README.md index 023141bbed..4e531443bb 100644 --- a/modules/document-db/database-account/gremlin-database/README.md +++ b/modules/document-db/database-account/gremlin-database/README.md @@ -35,7 +35,7 @@ This module deploys a Gremlin Database within a CosmosDB Account. | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | -| `graphs` | _[graphs](graphs/README.md)_ array | `[]` | Array of graphs to deploy in the Gremlin database. | +| `graphs` | array | `[]` | Array of graphs to deploy in the Gremlin database. | | `maxThroughput` | int | `4000` | Represents maximum throughput, the resource can scale up to. Cannot be set together with `throughput`. If `throughput` is set to something else than -1, this autoscale setting is ignored. | | `systemAssignedIdentity` | bool | `False` | Enables system assigned managed identity on the resource. | | `tags` | object | `{object}` | Tags of the Gremlin database resource. | diff --git a/modules/document-db/database-account/mongodb-database/README.md b/modules/document-db/database-account/mongodb-database/README.md index 18bdfc83e2..7b59822e38 100644 --- a/modules/document-db/database-account/mongodb-database/README.md +++ b/modules/document-db/database-account/mongodb-database/README.md @@ -34,7 +34,7 @@ This module deploys a MongoDB Database within a CosmosDB Account. | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | -| `collections` | _[collections](collections/README.md)_ array | `[]` | Collections in the mongodb database. | +| `collections` | array | `[]` | Collections in the mongodb database. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | | `tags` | object | `{object}` | Tags of the resource. | | `throughput` | int | `400` | Name of the mongodb database. | diff --git a/modules/document-db/database-account/sql-database/README.md b/modules/document-db/database-account/sql-database/README.md index 763dbbc51d..fa35dfa962 100644 --- a/modules/document-db/database-account/sql-database/README.md +++ b/modules/document-db/database-account/sql-database/README.md @@ -35,7 +35,7 @@ This module deploys a SQL Database in a CosmosDB Account. | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `autoscaleSettingsMaxThroughput` | int | `-1` | Specifies the Autoscale settings and represents maximum throughput, the resource can scale up to. The autoscale throughput should have valid throughput values between 1000 and 1000000 inclusive in increments of 1000. If value is set to -1, then the property will be set to null and autoscale will be disabled. | -| `containers` | _[containers](containers/README.md)_ array | `[]` | Array of containers to deploy in the SQL database. | +| `containers` | array | `[]` | Array of containers to deploy in the SQL database. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | | `tags` | object | `{object}` | Tags of the SQL database resource. | | `throughput` | int | `400` | Request units per second. Will be set to null if autoscaleSettingsMaxThroughput is used. | diff --git a/modules/event-grid/domain/README.md b/modules/event-grid/domain/README.md index e3b91651ba..622fb2af80 100644 --- a/modules/event-grid/domain/README.md +++ b/modules/event-grid/domain/README.md @@ -52,7 +52,7 @@ This module deploys an Event Grid Domain. | `publicNetworkAccess` | string | `''` | `['', Disabled, Enabled]` | Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set and inboundIpRules are not set. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `tags` | object | `{object}` | | Tags of the resource. | -| `topics` | _[topics](topics/README.md)_ array | `[]` | | The topic names which are associated with the domain. | +| `topics` | array | `[]` | | The topic names which are associated with the domain. | ### Parameter Usage: `privateEndpoints` @@ -270,7 +270,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -286,7 +286,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module domains './event-grid/domain/main.bicep' = { +module domain './event-grid/domain/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-egdcom' params: { // Required parameters @@ -439,7 +439,7 @@ module domains './event-grid/domain/main.bicep' = { via Bicep module ```bicep -module domains './event-grid/domain/main.bicep' = { +module domain './event-grid/domain/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-egdmin' params: { // Required parameters @@ -484,7 +484,7 @@ module domains './event-grid/domain/main.bicep' = { via Bicep module ```bicep -module domains './event-grid/domain/main.bicep' = { +module domain './event-grid/domain/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-egdpe' params: { // Required parameters diff --git a/modules/event-grid/system-topic/README.md b/modules/event-grid/system-topic/README.md index b03547909d..cb654ff3eb 100644 --- a/modules/event-grid/system-topic/README.md +++ b/modules/event-grid/system-topic/README.md @@ -286,7 +286,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module systemTopics './event-grid/system-topic/main.bicep' = { +module systemTopic './event-grid/system-topic/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-egstcom' params: { // Required parameters @@ -443,7 +443,7 @@ module systemTopics './event-grid/system-topic/main.bicep' = { via Bicep module ```bicep -module systemTopics './event-grid/system-topic/main.bicep' = { +module systemTopic './event-grid/system-topic/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-egstmin' params: { // Required parameters diff --git a/modules/event-grid/topic/README.md b/modules/event-grid/topic/README.md index 0db07fb12c..f41ed493f2 100644 --- a/modules/event-grid/topic/README.md +++ b/modules/event-grid/topic/README.md @@ -341,7 +341,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -357,7 +357,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module topics './event-grid/topic/main.bicep' = { +module topic './event-grid/topic/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-egtcom' params: { // Required parameters @@ -552,7 +552,7 @@ module topics './event-grid/topic/main.bicep' = { via Bicep module ```bicep -module topics './event-grid/topic/main.bicep' = { +module topic './event-grid/topic/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-egtmin' params: { // Required parameters @@ -597,7 +597,7 @@ module topics './event-grid/topic/main.bicep' = { via Bicep module ```bicep -module topics './event-grid/topic/main.bicep' = { +module topic './event-grid/topic/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-egtpe' params: { // Required parameters diff --git a/modules/event-hub/namespace/README.md b/modules/event-hub/namespace/README.md index 4a710dc8b8..72dc8fbd40 100644 --- a/modules/event-hub/namespace/README.md +++ b/modules/event-hub/namespace/README.md @@ -46,7 +46,7 @@ This module deploys an Event Hub Namespace. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `authorizationRules` | _[authorizationRules](authorization-rules/README.md)_ array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Event Hub namespace. | +| `authorizationRules` | array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Event Hub namespace. | | `cMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption. Customer-managed key encryption at rest is only available for namespaces of premium SKU or namespaces created in a Dedicated Cluster. | | `cMKKeyVersion` | string | `''` | | The version of the customer managed key to reference for encryption. If not provided, the latest key version is used. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | @@ -58,16 +58,16 @@ This module deploys an Event Hub Namespace. | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of the diagnostic log analytics workspace. | | `disableLocalAuth` | bool | `True` | | This property disables SAS authentication for the Event Hubs namespace. | -| `disasterRecoveryConfig` | object | `{object}` | | The disaster recovery config for this namespace. | +| `disasterRecoveryConfig` | _[disasterRecoveryConfig](disaster-recovery-config/README.md)_ object | `{object}` | | The disaster recovery config for this namespace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `eventhubs` | _[eventhubs](eventhubs/README.md)_ array | `[]` | | The event hubs to deploy into this namespace. | +| `eventhubs` | array | `[]` | | The event hubs to deploy into this namespace. | | `isAutoInflateEnabled` | bool | `False` | | Switch to enable the Auto Inflate feature of Event Hub. | | `kafkaEnabled` | bool | `False` | | Value that indicates whether Kafka is enabled for Event Hubs Namespace. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `maximumThroughputUnits` | int | `1` | | Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. | | `minimumTlsVersion` | string | `'1.2'` | `[1.0, 1.1, 1.2]` | The minimum TLS version for the cluster to support. | -| `networkRuleSets` | _[networkRuleSets](network-rule-sets/README.md)_ object | `{object}` | | Configure networking options. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. | +| `networkRuleSets` | object | `{object}` | | Configure networking options. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | | `publicNetworkAccess` | string | `''` | `['', Disabled, Enabled, SecuredByPerimeter]` | Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set. | | `requireInfrastructureEncryption` | bool | `False` | | Enable infrastructure encryption (double encryption). Note, this setting requires the configuration of Customer-Managed-Keys (CMK) via the corresponding module parameters. | @@ -329,7 +329,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -345,7 +345,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module namespaces './event-hub/namespace/main.bicep' = { +module namespace './event-hub/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ehncom' params: { // Required parameters @@ -690,7 +690,7 @@ module namespaces './event-hub/namespace/main.bicep' = { via Bicep module ```bicep -module namespaces './event-hub/namespace/main.bicep' = { +module namespace './event-hub/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ehnenc' params: { // Required parameters @@ -781,7 +781,7 @@ module namespaces './event-hub/namespace/main.bicep' = { via Bicep module ```bicep -module namespaces './event-hub/namespace/main.bicep' = { +module namespace './event-hub/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ehnmin' params: { // Required parameters @@ -826,7 +826,7 @@ module namespaces './event-hub/namespace/main.bicep' = { via Bicep module ```bicep -module namespaces './event-hub/namespace/main.bicep' = { +module namespace './event-hub/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ehnpe' params: { // Required parameters diff --git a/modules/event-hub/namespace/eventhub/README.md b/modules/event-hub/namespace/eventhub/README.md index 4be604be62..81b77b1a28 100644 --- a/modules/event-hub/namespace/eventhub/README.md +++ b/modules/event-hub/namespace/eventhub/README.md @@ -37,7 +37,7 @@ This module deploys an Event Hub Namespace Event Hub. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `authorizationRules` | _[authorizationRules](authorization-rules/README.md)_ array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the event hub. | +| `authorizationRules` | array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the event hub. | | `captureDescriptionDestinationArchiveNameFormat` | string | `'{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}'` | | Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order. | | `captureDescriptionDestinationBlobContainer` | string | `''` | | Blob container Name. | | `captureDescriptionDestinationName` | string | `'EventHubArchive.AzureBlockBlob'` | | Name for capture destination. | @@ -47,7 +47,7 @@ This module deploys an Event Hub Namespace Event Hub. | `captureDescriptionIntervalInSeconds` | int | `300` | | The time window allows you to set the frequency with which the capture to Azure Blobs will happen. | | `captureDescriptionSizeLimitInBytes` | int | `314572800` | | The size window defines the amount of data built up in your Event Hub before an capture operation. | | `captureDescriptionSkipEmptyArchives` | bool | `False` | | A value that indicates whether to Skip Empty Archives. | -| `consumergroups` | _[consumergroups](consumergroups/README.md)_ array | `[System.Management.Automation.OrderedHashtable]` | | The consumer groups to create in this event hub instance. | +| `consumergroups` | array | `[System.Management.Automation.OrderedHashtable]` | | The consumer groups to create in this event hub instance. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `messageRetentionInDays` | int | `1` | | Number of days to retain the events for this Event Hub, value should be 1 to 7 days. | diff --git a/modules/health-bot/health-bot/README.md b/modules/health-bot/health-bot/README.md index 34b48744a0..35104e82ee 100644 --- a/modules/health-bot/health-bot/README.md +++ b/modules/health-bot/health-bot/README.md @@ -199,7 +199,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module healthBots './health-bot/health-bot/main.bicep' = { +module healthBot './health-bot/health-bot/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-hbhbcom' params: { // Required parameters @@ -290,7 +290,7 @@ module healthBots './health-bot/health-bot/main.bicep' = { via Bicep module ```bicep -module healthBots './health-bot/health-bot/main.bicep' = { +module healthBot './health-bot/health-bot/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-hbhbmin' params: { // Required parameters diff --git a/modules/healthcare-apis/workspace/README.md b/modules/healthcare-apis/workspace/README.md index 552e571465..c1eea8d1d8 100644 --- a/modules/healthcare-apis/workspace/README.md +++ b/modules/healthcare-apis/workspace/README.md @@ -35,10 +35,10 @@ This module deploys a Healthcare API Workspace. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `dicomservices` | _[dicomservices](dicomservices/README.md)_ array | `[]` | | Deploy DICOM services. | +| `dicomservices` | array | `[]` | | Deploy DICOM services. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `fhirservices` | _[fhirservices](fhirservices/README.md)_ array | `[]` | | Deploy FHIR services. | -| `iotconnectors` | _[iotconnectors](iotconnectors/README.md)_ array | `[]` | | Deploy IOT connectors. | +| `fhirservices` | array | `[]` | | Deploy FHIR services. | +| `iotconnectors` | array | `[]` | | Deploy IOT connectors. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `publicNetworkAccess` | string | `'Disabled'` | `[Disabled, Enabled]` | Control permission for data plane traffic coming from public networks while private endpoint is enabled. | @@ -426,7 +426,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module workspaces './healthcare-apis/workspace/main.bicep' = { +module workspace './healthcare-apis/workspace/main.bicep' = { name: '${uniqueString(deployment().name)}-test-hawcom' params: { // Required parameters @@ -641,7 +641,7 @@ module workspaces './healthcare-apis/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './healthcare-apis/workspace/main.bicep' = { +module workspace './healthcare-apis/workspace/main.bicep' = { name: '${uniqueString(deployment().name)}-test-hawmin' params: { // Required parameters diff --git a/modules/healthcare-apis/workspace/iotconnector/README.md b/modules/healthcare-apis/workspace/iotconnector/README.md index 72afbe4aec..5367007d20 100644 --- a/modules/healthcare-apis/workspace/iotconnector/README.md +++ b/modules/healthcare-apis/workspace/iotconnector/README.md @@ -49,7 +49,7 @@ This module deploys a Healthcare API Workspace IoT Connector. | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of the diagnostic log analytics workspace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `fhirdestination` | object | `{object}` | | FHIR Destination. | +| `fhirdestination` | _[fhirdestination](fhirdestination/README.md)_ object | `{object}` | | FHIR Destination. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | diff --git a/modules/insights/action-group/README.md b/modules/insights/action-group/README.md index 21111edfe8..e1c208b52f 100644 --- a/modules/insights/action-group/README.md +++ b/modules/insights/action-group/README.md @@ -251,7 +251,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module actionGroups './insights/action-group/main.bicep' = { +module actionGroup './insights/action-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-iagcom' params: { // Required parameters @@ -370,7 +370,7 @@ module actionGroups './insights/action-group/main.bicep' = { via Bicep module ```bicep -module actionGroups './insights/action-group/main.bicep' = { +module actionGroup './insights/action-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-iagmin' params: { // Required parameters diff --git a/modules/insights/activity-log-alert/README.md b/modules/insights/activity-log-alert/README.md index b93ba3ceba..c3a757a032 100644 --- a/modules/insights/activity-log-alert/README.md +++ b/modules/insights/activity-log-alert/README.md @@ -413,7 +413,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module activityLogAlerts './insights/activity-log-alert/main.bicep' = { +module activityLogAlert './insights/activity-log-alert/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ialacom' params: { // Required parameters diff --git a/modules/insights/component/README.md b/modules/insights/component/README.md index dcc0967911..37697220e5 100644 --- a/modules/insights/component/README.md +++ b/modules/insights/component/README.md @@ -180,7 +180,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module components './insights/component/main.bicep' = { +module component './insights/component/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-iccom' params: { // Required parameters @@ -279,7 +279,7 @@ module components './insights/component/main.bicep' = { via Bicep module ```bicep -module components './insights/component/main.bicep' = { +module component './insights/component/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-icmin' params: { // Required parameters diff --git a/modules/insights/data-collection-endpoint/README.md b/modules/insights/data-collection-endpoint/README.md index 80532cd55d..f228a6266f 100644 --- a/modules/insights/data-collection-endpoint/README.md +++ b/modules/insights/data-collection-endpoint/README.md @@ -166,7 +166,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module dataCollectionEndpoints './insights/data-collection-endpoint/main.bicep' = { +module dataCollectionEndpoint './insights/data-collection-endpoint/main.bicep' = { name: '${uniqueString(deployment().name)}-test-idcecom' params: { // Required parameters @@ -253,7 +253,7 @@ module dataCollectionEndpoints './insights/data-collection-endpoint/main.bicep' via Bicep module ```bicep -module dataCollectionEndpoints './insights/data-collection-endpoint/main.bicep' = { +module dataCollectionEndpoint './insights/data-collection-endpoint/main.bicep' = { name: '${uniqueString(deployment().name)}-test-idcemin' params: { // Required parameters diff --git a/modules/insights/data-collection-rule/README.md b/modules/insights/data-collection-rule/README.md index a38f1b87e9..7e8778c23a 100644 --- a/modules/insights/data-collection-rule/README.md +++ b/modules/insights/data-collection-rule/README.md @@ -171,7 +171,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module dataCollectionRules './insights/data-collection-rule/main.bicep' = { +module dataCollectionRule './insights/data-collection-rule/main.bicep' = { name: '${uniqueString(deployment().name)}-test-idcrcusadv' params: { // Required parameters @@ -410,7 +410,7 @@ module dataCollectionRules './insights/data-collection-rule/main.bicep' = { via Bicep module ```bicep -module dataCollectionRules './insights/data-collection-rule/main.bicep' = { +module dataCollectionRule './insights/data-collection-rule/main.bicep' = { name: '${uniqueString(deployment().name)}-test-idcrcusbas' params: { // Required parameters @@ -617,7 +617,7 @@ module dataCollectionRules './insights/data-collection-rule/main.bicep' = { via Bicep module ```bicep -module dataCollectionRules './insights/data-collection-rule/main.bicep' = { +module dataCollectionRule './insights/data-collection-rule/main.bicep' = { name: '${uniqueString(deployment().name)}-test-idcrcusiis' params: { // Required parameters @@ -780,7 +780,7 @@ module dataCollectionRules './insights/data-collection-rule/main.bicep' = { via Bicep module ```bicep -module dataCollectionRules './insights/data-collection-rule/main.bicep' = { +module dataCollectionRule './insights/data-collection-rule/main.bicep' = { name: '${uniqueString(deployment().name)}-test-idcrlin' params: { // Required parameters @@ -1167,7 +1167,7 @@ module dataCollectionRules './insights/data-collection-rule/main.bicep' = { via Bicep module ```bicep -module dataCollectionRules './insights/data-collection-rule/main.bicep' = { +module dataCollectionRule './insights/data-collection-rule/main.bicep' = { name: '${uniqueString(deployment().name)}-test-idcrmin' params: { // Required parameters @@ -1298,7 +1298,7 @@ module dataCollectionRules './insights/data-collection-rule/main.bicep' = { via Bicep module ```bicep -module dataCollectionRules './insights/data-collection-rule/main.bicep' = { +module dataCollectionRule './insights/data-collection-rule/main.bicep' = { name: '${uniqueString(deployment().name)}-test-idcrwin' params: { // Required parameters diff --git a/modules/insights/diagnostic-setting/README.md b/modules/insights/diagnostic-setting/README.md index 3d11e77c11..3574719a0e 100644 --- a/modules/insights/diagnostic-setting/README.md +++ b/modules/insights/diagnostic-setting/README.md @@ -59,7 +59,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module diagnosticSettings './insights/diagnostic-setting/main.bicep' = { +module diagnosticSetting './insights/diagnostic-setting/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-idscom' params: { diagnosticEventHubAuthorizationRuleId: '' diff --git a/modules/insights/metric-alert/README.md b/modules/insights/metric-alert/README.md index e2d9d241b9..d97b8bb205 100644 --- a/modules/insights/metric-alert/README.md +++ b/modules/insights/metric-alert/README.md @@ -395,7 +395,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module metricAlerts './insights/metric-alert/main.bicep' = { +module metricAlert './insights/metric-alert/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-imacom' params: { // Required parameters diff --git a/modules/insights/private-link-scope/README.md b/modules/insights/private-link-scope/README.md index 985ff26dd7..674c31ac5f 100644 --- a/modules/insights/private-link-scope/README.md +++ b/modules/insights/private-link-scope/README.md @@ -38,7 +38,7 @@ This module deploys an Azure Monitor Private Link Scope. | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `scopedResources` | _[scopedResources](scoped-resources/README.md)_ array | `[]` | | Configuration details for Azure Monitor Resources. | +| `scopedResources` | array | `[]` | | Configuration details for Azure Monitor Resources. | | `tags` | object | `{object}` | | Resource tags. | @@ -257,7 +257,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -273,7 +273,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module privateLinkScopes './insights/private-link-scope/main.bicep' = { +module privateLinkScope './insights/private-link-scope/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-iplscom' params: { // Required parameters @@ -394,7 +394,7 @@ module privateLinkScopes './insights/private-link-scope/main.bicep' = { via Bicep module ```bicep -module privateLinkScopes './insights/private-link-scope/main.bicep' = { +module privateLinkScope './insights/private-link-scope/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-iplsmin' params: { // Required parameters diff --git a/modules/insights/scheduled-query-rule/README.md b/modules/insights/scheduled-query-rule/README.md index 911d3a000b..aeabdb47ca 100644 --- a/modules/insights/scheduled-query-rule/README.md +++ b/modules/insights/scheduled-query-rule/README.md @@ -176,7 +176,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module scheduledQueryRules './insights/scheduled-query-rule/main.bicep' = { +module scheduledQueryRule './insights/scheduled-query-rule/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-isqrcom' params: { // Required parameters diff --git a/modules/insights/webtest/README.md b/modules/insights/webtest/README.md index f0cdfcabbb..4be482bd57 100644 --- a/modules/insights/webtest/README.md +++ b/modules/insights/webtest/README.md @@ -176,7 +176,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module webtests './insights/webtest/main.bicep' = { +module webtest './insights/webtest/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-iwtcom' params: { // Required parameters @@ -263,7 +263,7 @@ module webtests './insights/webtest/main.bicep' = { via Bicep module ```bicep -module webtests './insights/webtest/main.bicep' = { +module webtest './insights/webtest/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-iwtmin' params: { // Required parameters diff --git a/modules/key-vault/vault/README.md b/modules/key-vault/vault/README.md index e328656478..c4529a2f21 100644 --- a/modules/key-vault/vault/README.md +++ b/modules/key-vault/vault/README.md @@ -36,7 +36,7 @@ This module deploys a Key Vault. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `accessPolicies` | _[accessPolicies](access-policies/README.md)_ array | `[]` | | All access policies to create. | +| `accessPolicies` | array | `[]` | | All access policies to create. | | `createMode` | string | `'default'` | | The vault's create mode to indicate whether the vault need to be recovered or not. - recover or default. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub. | @@ -53,7 +53,7 @@ This module deploys a Key Vault. | `enableVaultForDeployment` | bool | `True` | | Specifies if the vault is enabled for deployment by script or compute. | | `enableVaultForDiskEncryption` | bool | `True` | | Specifies if the azure platform has access to the vault for enabling disk encryption scenarios. | | `enableVaultForTemplateDeployment` | bool | `True` | | Specifies if the vault is enabled for a template deployment. | -| `keys` | _[keys](keys/README.md)_ array | `[]` | | All keys to create. | +| `keys` | array | `[]` | | All keys to create. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `networkAcls` | object | `{object}` | | Service endpoint object information. For security reasons, it is recommended to set the DefaultAction Deny. | @@ -394,7 +394,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -410,7 +410,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module vaults './key-vault/vault/main.bicep' = { +module vault './key-vault/vault/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-kvvcom' params: { name: 'kvvcom002' @@ -763,7 +763,7 @@ module vaults './key-vault/vault/main.bicep' = { via Bicep module ```bicep -module vaults './key-vault/vault/main.bicep' = { +module vault './key-vault/vault/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-kvvmin' params: { // Required parameters @@ -812,7 +812,7 @@ module vaults './key-vault/vault/main.bicep' = { via Bicep module ```bicep -module vaults './key-vault/vault/main.bicep' = { +module vault './key-vault/vault/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-kvvpe' params: { // Required parameters diff --git a/modules/kubernetes-configuration/extension/README.md b/modules/kubernetes-configuration/extension/README.md index f39f509041..d5718433e2 100644 --- a/modules/kubernetes-configuration/extension/README.md +++ b/modules/kubernetes-configuration/extension/README.md @@ -75,7 +75,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `kubernetes-configuration/flux-configurations` | Local reference | +| `kubernetes-configuration/flux-configuration` | Local reference | ## Deployment examples @@ -91,7 +91,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module extensions './kubernetes-configuration/extension/main.bicep' = { +module extension './kubernetes-configuration/extension/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-kcecom' params: { // Required parameters @@ -202,7 +202,7 @@ module extensions './kubernetes-configuration/extension/main.bicep' = { via Bicep module ```bicep -module extensions './kubernetes-configuration/extension/main.bicep' = { +module extension './kubernetes-configuration/extension/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-kcemin' params: { // Required parameters diff --git a/modules/kubernetes-configuration/flux-configuration/README.md b/modules/kubernetes-configuration/flux-configuration/README.md index 655ad47fea..ab26af9c42 100644 --- a/modules/kubernetes-configuration/flux-configuration/README.md +++ b/modules/kubernetes-configuration/flux-configuration/README.md @@ -86,7 +86,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module fluxConfigurations './kubernetes-configuration/flux-configuration/main.bicep' = { +module fluxConfiguration './kubernetes-configuration/flux-configuration/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-kcfccom' params: { // Required parameters @@ -185,7 +185,7 @@ module fluxConfigurations './kubernetes-configuration/flux-configuration/main.bi via Bicep module ```bicep -module fluxConfigurations './kubernetes-configuration/flux-configuration/main.bicep' = { +module fluxConfiguration './kubernetes-configuration/flux-configuration/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-kcfcmin' params: { // Required parameters diff --git a/modules/logic/workflow/README.md b/modules/logic/workflow/README.md index 7f7fdafc85..f2d6d77eb6 100644 --- a/modules/logic/workflow/README.md +++ b/modules/logic/workflow/README.md @@ -331,7 +331,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module workflows './logic/workflow/main.bicep' = { +module workflow './logic/workflow/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-lwcom' params: { // Required parameters diff --git a/modules/machine-learning-services/workspace/README.md b/modules/machine-learning-services/workspace/README.md index 8be6886df1..a15a4bd947 100644 --- a/modules/machine-learning-services/workspace/README.md +++ b/modules/machine-learning-services/workspace/README.md @@ -52,7 +52,7 @@ This module deploys a Machine Learning Services Workspace. | `cMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption. | | `cMKKeyVersion` | string | `''` | | The version of the customer managed key to reference for encryption. If not provided, the latest key version is used. | | `cMKUserAssignedIdentityResourceId` | string | `''` | | User assigned identity to use when fetching the customer managed key. If not provided, a system-assigned identity can be used - but must be given access to the referenced key vault first. | -| `computes` | _[computes](computes/README.md)_ array | `[]` | | Computes to create respectively attach to the workspace. | +| `computes` | array | `[]` | | Computes to create respectively attach to the workspace. | | `description` | string | `''` | | The description of this workspace. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | @@ -431,7 +431,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -447,7 +447,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module workspaces './machine-learning-services/workspace/main.bicep' = { +module workspace './machine-learning-services/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-mlswcom' params: { // Required parameters @@ -680,7 +680,7 @@ module workspaces './machine-learning-services/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './machine-learning-services/workspace/main.bicep' = { +module workspace './machine-learning-services/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-mlswecr' params: { // Required parameters @@ -811,7 +811,7 @@ module workspaces './machine-learning-services/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './machine-learning-services/workspace/main.bicep' = { +module workspace './machine-learning-services/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-mlswmin' params: { // Required parameters diff --git a/modules/maintenance/maintenance-configuration/README.md b/modules/maintenance/maintenance-configuration/README.md index 35fcd330a7..91066c75d6 100644 --- a/modules/maintenance/maintenance-configuration/README.md +++ b/modules/maintenance/maintenance-configuration/README.md @@ -205,7 +205,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module maintenanceConfigurations './maintenance/maintenance-configuration/main.bicep' = { +module maintenanceConfiguration './maintenance/maintenance-configuration/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-mmccom' params: { // Required parameters @@ -312,7 +312,7 @@ module maintenanceConfigurations './maintenance/maintenance-configuration/main.b via Bicep module ```bicep -module maintenanceConfigurations './maintenance/maintenance-configuration/main.bicep' = { +module maintenanceConfiguration './maintenance/maintenance-configuration/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-mmcmin' params: { // Required parameters diff --git a/modules/managed-identity/user-assigned-identity/README.md b/modules/managed-identity/user-assigned-identity/README.md index 9a47a1fcea..bbeaa81dcb 100644 --- a/modules/managed-identity/user-assigned-identity/README.md +++ b/modules/managed-identity/user-assigned-identity/README.md @@ -161,7 +161,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module userAssignedIdentities './managed-identity/user-assigned-identity/main.bicep' = { +module userAssignedIdentity './managed-identity/user-assigned-identity/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-miuaicom' params: { enableDefaultTelemetry: '' diff --git a/modules/managed-services/registration-definition/README.md b/modules/managed-services/registration-definition/README.md index 5d5d85fb93..734520321a 100644 --- a/modules/managed-services/registration-definition/README.md +++ b/modules/managed-services/registration-definition/README.md @@ -184,7 +184,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module registrationDefinitions './managed-services/registration-definition/main.bicep' = { +module registrationDefinition './managed-services/registration-definition/main.bicep' = { name: '${uniqueString(deployment().name)}-test-msrdcom' params: { // Required parameters @@ -273,7 +273,7 @@ module registrationDefinitions './managed-services/registration-definition/main. via Bicep module ```bicep -module registrationDefinitions './managed-services/registration-definition/main.bicep' = { +module registrationDefinition './managed-services/registration-definition/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-msrdrg' params: { // Required parameters diff --git a/modules/management/management-group/README.md b/modules/management/management-group/README.md index 538102db67..998c5b341b 100644 --- a/modules/management/management-group/README.md +++ b/modules/management/management-group/README.md @@ -141,7 +141,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module managementGroups './management/management-group/main.bicep' = { +module managementGroup './management/management-group/main.bicep' = { name: '${uniqueString(deployment().name)}-test-mmgcom' params: { // Required parameters @@ -194,7 +194,7 @@ module managementGroups './management/management-group/main.bicep' = { via Bicep module ```bicep -module managementGroups './management/management-group/main.bicep' = { +module managementGroup './management/management-group/main.bicep' = { name: '${uniqueString(deployment().name)}-test-mmgmin' params: { // Required parameters diff --git a/modules/net-app/net-app-account/README.md b/modules/net-app/net-app-account/README.md index f2f043eb0f..47bcbdc2d8 100644 --- a/modules/net-app/net-app-account/README.md +++ b/modules/net-app/net-app-account/README.md @@ -32,7 +32,7 @@ This module deploys an Azure NetApp File. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `capacityPools` | _[capacityPools](capacity-pools/README.md)_ array | `[]` | | Capacity pools to create. | +| `capacityPools` | array | `[]` | | Capacity pools to create. | | `dnsServers` | string | `''` | | Required if domainName is specified. Comma separated list of DNS server IP addresses (IPv4 only) required for the Active Directory (AD) domain join and SMB authentication operations to succeed. | | `domainJoinOU` | string | `''` | | Used only if domainName is specified. LDAP Path for the Organization Unit (OU) where SMB Server machine accounts will be created (i.e. 'OU=SecondLevel,OU=FirstLevel'). | | `domainJoinPassword` | securestring | `''` | | Required if domainName is specified. Password of the user specified in domainJoinUser parameter. | @@ -207,7 +207,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module netAppAccounts './net-app/net-app-account/main.bicep' = { +module netAppAccount './net-app/net-app-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nanaamin' params: { // Required parameters @@ -252,7 +252,7 @@ module netAppAccounts './net-app/net-app-account/main.bicep' = { via Bicep module ```bicep -module netAppAccounts './net-app/net-app-account/main.bicep' = { +module netAppAccount './net-app/net-app-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nanaanfs3' params: { // Required parameters @@ -477,7 +477,7 @@ module netAppAccounts './net-app/net-app-account/main.bicep' = { via Bicep module ```bicep -module netAppAccounts './net-app/net-app-account/main.bicep' = { +module netAppAccount './net-app/net-app-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nanaanfs41' params: { // Required parameters diff --git a/modules/net-app/net-app-account/capacity-pool/README.md b/modules/net-app/net-app-account/capacity-pool/README.md index 9f92243b26..aa1143ba4c 100644 --- a/modules/net-app/net-app-account/capacity-pool/README.md +++ b/modules/net-app/net-app-account/capacity-pool/README.md @@ -43,7 +43,7 @@ This module deploys an Azure NetApp Files Capacity Pool. | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `serviceLevel` | string | `'Standard'` | `[Premium, Standard, StandardZRS, Ultra]` | The pool service level. | | `tags` | object | `{object}` | | Tags for all resources. | -| `volumes` | _[volumes](volumes/README.md)_ array | `[]` | | List of volumnes to create in the capacity pool. | +| `volumes` | array | `[]` | | List of volumnes to create in the capacity pool. | ### Parameter Usage: `tags` 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 c8884db8da..55f4aef906 100644 --- a/modules/network/application-gateway-web-application-firewall-policy/README.md +++ b/modules/network/application-gateway-web-application-firewall-policy/README.md @@ -104,7 +104,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module applicationGatewayWebApplicationFirewallPolicies './network/application-gateway-web-application-firewall-policy/main.bicep' = { +module applicationGatewayWebApplicationFirewallPolicy './network/application-gateway-web-application-firewall-policy/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nagwafpcom' params: { // Required parameters diff --git a/modules/network/application-gateway/README.md b/modules/network/application-gateway/README.md index 81a5406c18..ef200720f9 100644 --- a/modules/network/application-gateway/README.md +++ b/modules/network/application-gateway/README.md @@ -244,7 +244,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module applicationGateways './network/application-gateway/main.bicep' = { +module applicationGateway './network/application-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nagcom' params: { // Required parameters diff --git a/modules/network/application-security-group/README.md b/modules/network/application-security-group/README.md index 823514c993..0f6578986a 100644 --- a/modules/network/application-security-group/README.md +++ b/modules/network/application-security-group/README.md @@ -164,7 +164,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module applicationSecurityGroups './network/application-security-group/main.bicep' = { +module applicationSecurityGroup './network/application-security-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nasgcom' params: { // Required parameters diff --git a/modules/network/azure-firewall/README.md b/modules/network/azure-firewall/README.md index 897b4a15d5..1b63fae853 100644 --- a/modules/network/azure-firewall/README.md +++ b/modules/network/azure-firewall/README.md @@ -314,7 +314,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/public-ip-addresses` | Local reference | +| `network/public-ip-address` | Local reference | ## Deployment examples @@ -330,7 +330,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module azureFirewalls './network/azure-firewall/main.bicep' = { +module azureFirewall './network/azure-firewall/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nafaddpip' params: { // Required parameters @@ -433,7 +433,7 @@ module azureFirewalls './network/azure-firewall/main.bicep' = { via Bicep module ```bicep -module azureFirewalls './network/azure-firewall/main.bicep' = { +module azureFirewall './network/azure-firewall/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nafcom' params: { // Required parameters @@ -718,7 +718,7 @@ module azureFirewalls './network/azure-firewall/main.bicep' = { via Bicep module ```bicep -module azureFirewalls './network/azure-firewall/main.bicep' = { +module azureFirewall './network/azure-firewall/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nafcstpip' params: { // Required parameters @@ -827,7 +827,7 @@ module azureFirewalls './network/azure-firewall/main.bicep' = { via Bicep module ```bicep -module azureFirewalls './network/azure-firewall/main.bicep' = { +module azureFirewall './network/azure-firewall/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nafhubcom' params: { // Required parameters @@ -902,7 +902,7 @@ module azureFirewalls './network/azure-firewall/main.bicep' = { via Bicep module ```bicep -module azureFirewalls './network/azure-firewall/main.bicep' = { +module azureFirewall './network/azure-firewall/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nafhubmin' params: { // Required parameters @@ -963,7 +963,7 @@ module azureFirewalls './network/azure-firewall/main.bicep' = { via Bicep module ```bicep -module azureFirewalls './network/azure-firewall/main.bicep' = { +module azureFirewall './network/azure-firewall/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nafmin' params: { // Required parameters diff --git a/modules/network/azure-firewall/main.bicep b/modules/network/azure-firewall/main.bicep index 37000f74b8..cb6beb7e01 100644 --- a/modules/network/azure-firewall/main.bicep +++ b/modules/network/azure-firewall/main.bicep @@ -272,7 +272,7 @@ module publicIPAddress '../../network/public-ip-address/main.bicep' = if (empty( } // create a Management Public IP address if one is not provided and the flag is true -module managementIPAddress '../../network/public-ip-addresses/main.bicep' = if (empty(managementIPResourceID) && isCreateDefaultManagementIP && azureSkuName == 'AZFW_VNet') { +module managementIPAddress '../../network/public-ip-address/main.bicep' = if (empty(managementIPResourceID) && isCreateDefaultManagementIP && azureSkuName == 'AZFW_VNet') { name: '${uniqueString(deployment().name, location)}-Firewall-MIP' params: { name: contains(managementIPAddressObject, 'name') ? (!(empty(managementIPAddressObject.name)) ? managementIPAddressObject.name : '${name}-mip') : '${name}-mip' diff --git a/modules/network/bastion-host/README.md b/modules/network/bastion-host/README.md index e0e83c52c9..5e5c36581b 100644 --- a/modules/network/bastion-host/README.md +++ b/modules/network/bastion-host/README.md @@ -294,7 +294,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/public-ip-addresses` | Local reference | +| `network/public-ip-address` | Local reference | ## Deployment examples @@ -310,7 +310,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module bastionHosts './network/bastion-host/main.bicep' = { +module bastionHost './network/bastion-host/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nbhcom' params: { // Required parameters @@ -441,7 +441,7 @@ module bastionHosts './network/bastion-host/main.bicep' = { via Bicep module ```bicep -module bastionHosts './network/bastion-host/main.bicep' = { +module bastionHost './network/bastion-host/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nbhctmpip' params: { // Required parameters @@ -550,7 +550,7 @@ module bastionHosts './network/bastion-host/main.bicep' = { via Bicep module ```bicep -module bastionHosts './network/bastion-host/main.bicep' = { +module bastionHost './network/bastion-host/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nbhmin' params: { // Required parameters diff --git a/modules/network/connection/README.md b/modules/network/connection/README.md index a02b79e33c..21fdbaed66 100644 --- a/modules/network/connection/README.md +++ b/modules/network/connection/README.md @@ -330,7 +330,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module connections './network/connection/main.bicep' = { +module connection './network/connection/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ncvtv' params: { // Required parameters diff --git a/modules/network/ddos-protection-plan/README.md b/modules/network/ddos-protection-plan/README.md index 652920b8bf..64bd627893 100644 --- a/modules/network/ddos-protection-plan/README.md +++ b/modules/network/ddos-protection-plan/README.md @@ -164,7 +164,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module ddosProtectionPlans './network/ddos-protection-plan/main.bicep' = { +module ddosProtectionPlan './network/ddos-protection-plan/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ndppcom' params: { // Required parameters @@ -243,7 +243,7 @@ module ddosProtectionPlans './network/ddos-protection-plan/main.bicep' = { via Bicep module ```bicep -module ddosProtectionPlans './network/ddos-protection-plan/main.bicep' = { +module ddosProtectionPlan './network/ddos-protection-plan/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ndppmin' params: { // Required parameters diff --git a/modules/network/dns-forwarding-ruleset/README.md b/modules/network/dns-forwarding-ruleset/README.md index 7f13828b7b..7693b11e53 100644 --- a/modules/network/dns-forwarding-ruleset/README.md +++ b/modules/network/dns-forwarding-ruleset/README.md @@ -34,7 +34,7 @@ This template deploys an dns forwarding ruleset. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `forwardingRules` | _[forwardingRules](forwarding-rules/README.md)_ array | `[]` | | Array of forwarding rules. | +| `forwardingRules` | array | `[]` | | Array of forwarding rules. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | @@ -169,7 +169,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module dnsForwardingRulesets './network/dns-forwarding-ruleset/main.bicep' = { +module dnsForwardingRuleset './network/dns-forwarding-ruleset/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ndfrscom' params: { // Required parameters @@ -292,7 +292,7 @@ module dnsForwardingRulesets './network/dns-forwarding-ruleset/main.bicep' = { via Bicep module ```bicep -module dnsForwardingRulesets './network/dns-forwarding-ruleset/main.bicep' = { +module dnsForwardingRuleset './network/dns-forwarding-ruleset/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ndfrsmin' params: { // Required parameters diff --git a/modules/network/dns-resolver/README.md b/modules/network/dns-resolver/README.md index 450ddbc1fa..da3bdaf6a1 100644 --- a/modules/network/dns-resolver/README.md +++ b/modules/network/dns-resolver/README.md @@ -251,7 +251,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module dnsResolvers './network/dns-resolver/main.bicep' = { +module dnsResolver './network/dns-resolver/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ndrcom' params: { // Required parameters diff --git a/modules/network/dns-zone/README.md b/modules/network/dns-zone/README.md index 36a29d0b3a..05e4e095cb 100644 --- a/modules/network/dns-zone/README.md +++ b/modules/network/dns-zone/README.md @@ -184,7 +184,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module dnsZones './network/dns-zone/main.bicep' = { +module dnsZone './network/dns-zone/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ndzcom' params: { // Required parameters @@ -605,7 +605,7 @@ module dnsZones './network/dns-zone/main.bicep' = { via Bicep module ```bicep -module dnsZones './network/dns-zone/main.bicep' = { +module dnsZone './network/dns-zone/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ndzmin' params: { // Required parameters diff --git a/modules/network/express-route-circuit/README.md b/modules/network/express-route-circuit/README.md index 0ae02c190f..051e689910 100644 --- a/modules/network/express-route-circuit/README.md +++ b/modules/network/express-route-circuit/README.md @@ -190,7 +190,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module expressRouteCircuits './network/express-route-circuit/main.bicep' = { +module expressRouteCircuit './network/express-route-circuit/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nerccom' params: { // Required parameters @@ -313,7 +313,7 @@ module expressRouteCircuits './network/express-route-circuit/main.bicep' = { via Bicep module ```bicep -module expressRouteCircuits './network/express-route-circuit/main.bicep' = { +module expressRouteCircuit './network/express-route-circuit/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nercmin' params: { // Required parameters diff --git a/modules/network/firewall-policy/README.md b/modules/network/firewall-policy/README.md index 50d925df2a..b61a8274a4 100644 --- a/modules/network/firewall-policy/README.md +++ b/modules/network/firewall-policy/README.md @@ -45,7 +45,7 @@ This module deploys a Firewall Policy. | `mode` | string | `'Off'` | `[Alert, Deny, Off]` | The configuring of intrusion detection. | | `privateRanges` | array | `[]` | | List of private IP addresses/IP address ranges to not be SNAT. | | `retentionDays` | int | `365` | | Number of days the insights should be enabled on the policy. | -| `ruleCollectionGroups` | _[ruleCollectionGroups](rule-collection-groups/README.md)_ array | `[]` | | Rule collection groups. | +| `ruleCollectionGroups` | array | `[]` | | Rule collection groups. | | `servers` | array | `[]` | | List of Custom DNS Servers. | | `signatureOverrides` | array | `[]` | | List of specific signatures states. | | `tags` | object | `{object}` | | Tags of the Firewall policy resource. | @@ -156,7 +156,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module firewallPolicies './network/firewall-policy/main.bicep' = { +module firewallPolicy './network/firewall-policy/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nfpcom' params: { // Required parameters @@ -297,7 +297,7 @@ module firewallPolicies './network/firewall-policy/main.bicep' = { via Bicep module ```bicep -module firewallPolicies './network/firewall-policy/main.bicep' = { +module firewallPolicy './network/firewall-policy/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nfpmin' params: { // Required parameters diff --git a/modules/network/front-door/README.md b/modules/network/front-door/README.md index 4ff3adfee7..99d21d9b11 100644 --- a/modules/network/front-door/README.md +++ b/modules/network/front-door/README.md @@ -180,7 +180,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module frontDoors './network/front-door/main.bicep' = { +module frontDoor './network/front-door/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nfdcom' params: { // Required parameters @@ -451,7 +451,7 @@ module frontDoors './network/front-door/main.bicep' = { via Bicep module ```bicep -module frontDoors './network/front-door/main.bicep' = { +module frontDoor './network/front-door/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nfdmin' params: { // Required parameters diff --git a/modules/network/ip-group/README.md b/modules/network/ip-group/README.md index 7c8e07c16d..6ada26e4ac 100644 --- a/modules/network/ip-group/README.md +++ b/modules/network/ip-group/README.md @@ -165,7 +165,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module ipGroups './network/ip-group/main.bicep' = { +module ipGroup './network/ip-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nigcom' params: { // Required parameters @@ -254,7 +254,7 @@ module ipGroups './network/ip-group/main.bicep' = { via Bicep module ```bicep -module ipGroups './network/ip-group/main.bicep' = { +module ipGroup './network/ip-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nigmin' params: { // Required parameters diff --git a/modules/network/load-balancer/README.md b/modules/network/load-balancer/README.md index d39e44dfe7..624a38a950 100644 --- a/modules/network/load-balancer/README.md +++ b/modules/network/load-balancer/README.md @@ -34,7 +34,7 @@ This module deploys a Load Balancer. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `backendAddressPools` | _[backendAddressPools](backend-address-pools/README.md)_ array | `[]` | | Collection of backend address pools used by a load balancer. | +| `backendAddressPools` | array | `[]` | | Collection of backend address pools used by a load balancer. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | | `diagnosticLogsRetentionInDays` | int | `365` | | Specifies the number of days that logs will be kept for; a value of 0 will retain data indefinitely. | @@ -43,7 +43,7 @@ This module deploys a Load Balancer. | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of the diagnostic log analytics workspace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `inboundNatRules` | _[inboundNatRules](inbound-nat-rules/README.md)_ array | `[]` | | Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules. | +| `inboundNatRules` | array | `[]` | | Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules. | | `loadBalancingRules` | array | `[]` | | Array of objects containing all load balancing rules. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | @@ -478,7 +478,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module loadBalancers './network/load-balancer/main.bicep' = { +module loadBalancer './network/load-balancer/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nlbcom' params: { // Required parameters @@ -749,7 +749,7 @@ module loadBalancers './network/load-balancer/main.bicep' = { via Bicep module ```bicep -module loadBalancers './network/load-balancer/main.bicep' = { +module loadBalancer './network/load-balancer/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nlbint' params: { // Required parameters @@ -966,7 +966,7 @@ module loadBalancers './network/load-balancer/main.bicep' = { via Bicep module ```bicep -module loadBalancers './network/load-balancer/main.bicep' = { +module loadBalancer './network/load-balancer/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nlbmin' params: { // Required parameters diff --git a/modules/network/local-network-gateway/README.md b/modules/network/local-network-gateway/README.md index d57c2e12b9..02aedfdd97 100644 --- a/modules/network/local-network-gateway/README.md +++ b/modules/network/local-network-gateway/README.md @@ -170,7 +170,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module localNetworkGateways './network/local-network-gateway/main.bicep' = { +module localNetworkGateway './network/local-network-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nlngcom' params: { // Required parameters @@ -269,7 +269,7 @@ module localNetworkGateways './network/local-network-gateway/main.bicep' = { via Bicep module ```bicep -module localNetworkGateways './network/local-network-gateway/main.bicep' = { +module localNetworkGateway './network/local-network-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nlngmin' params: { // Required parameters diff --git a/modules/network/nat-gateway/README.md b/modules/network/nat-gateway/README.md index 6eb2c2a26e..6f06099d30 100644 --- a/modules/network/nat-gateway/README.md +++ b/modules/network/nat-gateway/README.md @@ -170,7 +170,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/public-ip-addresses` | Local reference | +| `network/public-ip-address` | Local reference | ## Deployment examples @@ -186,7 +186,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module natGateways './network/nat-gateway/main.bicep' = { +module natGateway './network/nat-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nngcom' params: { // Required parameters diff --git a/modules/network/network-interface/README.md b/modules/network/network-interface/README.md index ebc15fc596..4dadb3d2ab 100644 --- a/modules/network/network-interface/README.md +++ b/modules/network/network-interface/README.md @@ -200,7 +200,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module networkInterfaces './network/network-interface/main.bicep' = { +module networkInterface './network/network-interface/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nnicom' params: { // Required parameters @@ -349,7 +349,7 @@ module networkInterfaces './network/network-interface/main.bicep' = { via Bicep module ```bicep -module networkInterfaces './network/network-interface/main.bicep' = { +module networkInterface './network/network-interface/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nnimin' params: { // Required parameters diff --git a/modules/network/network-manager/README.md b/modules/network/network-manager/README.md index e95812c026..f55f05c7d9 100644 --- a/modules/network/network-manager/README.md +++ b/modules/network/network-manager/README.md @@ -40,20 +40,20 @@ This module deploys a Network Manager. | Parameter Name | Type | Description | | :-- | :-- | :-- | -| `networkGroups` | _[networkGroups](network-groups/README.md)_ array | Network Groups and static members to create for the network manager. Required if using "connectivityConfigurations" or "securityAdminConfigurations" parameters. | +| `networkGroups` | array | Network Groups and static members to create for the network manager. Required if using "connectivityConfigurations" or "securityAdminConfigurations" parameters. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `connectivityConfigurations` | _[connectivityConfigurations](connectivity-configurations/README.md)_ array | `[]` | | Connectivity Configurations to create for the network manager. Network manager must contain at least one network group in order to define connectivity configurations. | +| `connectivityConfigurations` | array | `[]` | | Connectivity Configurations to create for the network manager. Network manager must contain at least one network group in order to define connectivity configurations. | | `description` | string | `''` | | A description of the network manager. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `scopeConnections` | _[scopeConnections](scope-connections/README.md)_ array | `[]` | | Scope Connections to create for the network manager. Allows network manager to manage resources from another tenant. | -| `securityAdminConfigurations` | _[securityAdminConfigurations](security-admin-configurations/README.md)_ array | `[]` | | Security Admin Configurations, Rule Collections and Rules to create for the network manager. | +| `scopeConnections` | array | `[]` | | Scope Connections to create for the network manager. Allows network manager to manage resources from another tenant. | +| `securityAdminConfigurations` | array | `[]` | | Security Admin Configurations, Rule Collections and Rules to create for the network manager. | | `tags` | object | `{object}` | | Tags of the resource. | @@ -549,7 +549,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module networkManagers './network/network-manager/main.bicep' = { +module networkManager './network/network-manager/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nnmcom' params: { // Required parameters diff --git a/modules/network/network-manager/network-group/README.md b/modules/network/network-manager/network-group/README.md index 2870c87665..b902fd22a1 100644 --- a/modules/network/network-manager/network-group/README.md +++ b/modules/network/network-manager/network-group/README.md @@ -37,7 +37,7 @@ A network group is a collection of same-type network resources that you can asso | :-- | :-- | :-- | :-- | | `description` | string | `''` | A description of the network group. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | -| `staticMembers` | _[staticMembers](static-members/README.md)_ array | `[]` | Static Members to create for the network group. Contains virtual networks to add to the network group. | +| `staticMembers` | array | `[]` | Static Members to create for the network group. Contains virtual networks to add to the network group. | ## Outputs diff --git a/modules/network/network-manager/security-admin-configuration/README.md b/modules/network/network-manager/security-admin-configuration/README.md index 6fe2519599..10cd562c0a 100644 --- a/modules/network/network-manager/security-admin-configuration/README.md +++ b/modules/network/network-manager/security-admin-configuration/README.md @@ -39,7 +39,7 @@ A security admin configuration contains a set of rule collections. Each rule col | :-- | :-- | :-- | :-- | | `description` | string | `''` | A description of the security admin configuration. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | -| `ruleCollections` | _[ruleCollections](rule-collections/README.md)_ array | `[]` | A security admin configuration contains a set of rule collections that are applied to network groups. Each rule collection contains one or more security admin rules. | +| `ruleCollections` | array | `[]` | A security admin configuration contains a set of rule collections that are applied to network groups. Each rule collection contains one or more security admin rules. | ## Outputs diff --git a/modules/network/network-manager/security-admin-configuration/rule-collection/README.md b/modules/network/network-manager/security-admin-configuration/rule-collection/README.md index 7a211fec4a..33bd75c517 100644 --- a/modules/network/network-manager/security-admin-configuration/rule-collection/README.md +++ b/modules/network/network-manager/security-admin-configuration/rule-collection/README.md @@ -39,7 +39,7 @@ A security admin configuration contains a set of rule collections. Each rule col | :-- | :-- | :-- | :-- | | `description` | string | `''` | A description of the admin rule collection. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via a Globally Unique Identifier (GUID). | -| `rules` | _[rules](rules/README.md)_ array | | List of rules for the admin rules collection. Security admin rules allows enforcing security policy criteria that matches the conditions set. Warning: A rule collection without rule will cause a deployment configuration for security admin goal state in network manager to fail. | +| `rules` | array | | List of rules for the admin rules collection. Security admin rules allows enforcing security policy criteria that matches the conditions set. Warning: A rule collection without rule will cause a deployment configuration for security admin goal state in network manager to fail. | ## Outputs diff --git a/modules/network/network-security-group/README.md b/modules/network/network-security-group/README.md index e47405e177..4155d7e0db 100644 --- a/modules/network/network-security-group/README.md +++ b/modules/network/network-security-group/README.md @@ -44,7 +44,7 @@ This module deploys a Network security Group (NSG). | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `securityRules` | _[securityRules](security-rules/README.md)_ array | `[]` | | Array of Security Rules to deploy to the Network Security Group. When not provided, an NSG including only the built-in roles will be deployed. | +| `securityRules` | array | `[]` | | Array of Security Rules to deploy to the Network Security Group. When not provided, an NSG including only the built-in roles will be deployed. | | `tags` | object | `{object}` | | Tags of the NSG resource. | @@ -175,7 +175,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module networkSecurityGroups './network/network-security-group/main.bicep' = { +module networkSecurityGroup './network/network-security-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nnsgcom' params: { // Required parameters @@ -404,7 +404,7 @@ module networkSecurityGroups './network/network-security-group/main.bicep' = { via Bicep module ```bicep -module networkSecurityGroups './network/network-security-group/main.bicep' = { +module networkSecurityGroup './network/network-security-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nnsgmin' params: { // Required parameters diff --git a/modules/network/network-watcher/README.md b/modules/network/network-watcher/README.md index 8fcf765ec5..4c74e3768f 100644 --- a/modules/network/network-watcher/README.md +++ b/modules/network/network-watcher/README.md @@ -26,9 +26,9 @@ This module deploys a Network Watcher. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `connectionMonitors` | _[connectionMonitors](connection-monitors/README.md)_ array | `[]` | | Array that contains the Connection Monitors. | +| `connectionMonitors` | array | `[]` | | Array that contains the Connection Monitors. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `flowLogs` | _[flowLogs](flow-logs/README.md)_ array | `[]` | | Array that contains the Flow Logs. | +| `flowLogs` | array | `[]` | | Array that contains the Flow Logs. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `name` | string | `[format('NetworkWatcher_{0}', parameters('location'))]` | | Name of the Network Watcher resource (hidden). | @@ -163,7 +163,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module networkWatchers './network/network-watcher/main.bicep' = { +module networkWatcher './network/network-watcher/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nnwcom' params: { connectionMonitors: [ @@ -380,7 +380,7 @@ module networkWatchers './network/network-watcher/main.bicep' = { via Bicep module ```bicep -module networkWatchers './network/network-watcher/main.bicep' = { +module networkWatcher './network/network-watcher/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nnwmin' params: { enableDefaultTelemetry: '' diff --git a/modules/network/private-dns-zone/README.md b/modules/network/private-dns-zone/README.md index 253bfa546a..4dc4d17fae 100644 --- a/modules/network/private-dns-zone/README.md +++ b/modules/network/private-dns-zone/README.md @@ -52,7 +52,7 @@ This module deploys a Private DNS zone. | `srv` | _[srv](srv/README.md)_ array | `[]` | | Array of SRV records. | | `tags` | object | `{object}` | | Tags of the resource. | | `txt` | _[txt](txt/README.md)_ array | `[]` | | Array of TXT records. | -| `virtualNetworkLinks` | _[virtualNetworkLinks](virtual-network-links/README.md)_ array | `[]` | | Array of custom objects describing vNet links of the DNS zone. Each object should contain properties 'vnetResourceId' and 'registrationEnabled'. The 'vnetResourceId' is a resource ID of a vNet to link, 'registrationEnabled' (bool) enables automatic DNS registration in the zone for the linked vNet. | +| `virtualNetworkLinks` | array | `[]` | | Array of custom objects describing vNet links of the DNS zone. Each object should contain properties 'vnetResourceId' and 'registrationEnabled'. The 'vnetResourceId' is a resource ID of a vNet to link, 'registrationEnabled' (bool) enables automatic DNS registration in the zone for the linked vNet. | ### Parameter Usage: `roleAssignments` @@ -182,7 +182,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module privateDnsZones './network/private-dns-zone/main.bicep' = { +module privateDnsZone './network/private-dns-zone/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-npdzcom' params: { // Required parameters @@ -609,7 +609,7 @@ module privateDnsZones './network/private-dns-zone/main.bicep' = { via Bicep module ```bicep -module privateDnsZones './network/private-dns-zone/main.bicep' = { +module privateDnsZone './network/private-dns-zone/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-npdzmin' params: { // Required parameters diff --git a/modules/network/private-endpoint/README.md b/modules/network/private-endpoint/README.md index 740bb2a43d..18541322bd 100644 --- a/modules/network/private-endpoint/README.md +++ b/modules/network/private-endpoint/README.md @@ -52,7 +52,7 @@ The following resources are required to be able to deploy this resource: | `location` | string | `[resourceGroup().location]` | | Location for all Resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `manualPrivateLinkServiceConnections` | array | `[]` | | Manual PrivateLink Service Connections. | -| `privateDnsZoneGroup` | object | `{object}` | | The private DNS zone group configuration used to associate the private endpoint with one or multiple private DNS zones. A DNS zone group can support up to 5 DNS zones. | +| `privateDnsZoneGroup` | _[privateDnsZoneGroup](private-dns-zone-group/README.md)_ object | `{object}` | | The private DNS zone group configuration used to associate the private endpoint with one or multiple private DNS zones. A DNS zone group can support up to 5 DNS zones. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `tags` | object | `{object}` | | Tags to be applied on all resources/resource groups in this deployment. | @@ -297,7 +297,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module privateEndpoints './network/private-endpoint/main.bicep' = { +module privateEndpoint './network/private-endpoint/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-npecom' params: { // Required parameters @@ -442,7 +442,7 @@ module privateEndpoints './network/private-endpoint/main.bicep' = { via Bicep module ```bicep -module privateEndpoints './network/private-endpoint/main.bicep' = { +module privateEndpoint './network/private-endpoint/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-npemin' params: { // Required parameters diff --git a/modules/network/private-link-service/README.md b/modules/network/private-link-service/README.md index 63574fc90e..e61e7b4ec3 100644 --- a/modules/network/private-link-service/README.md +++ b/modules/network/private-link-service/README.md @@ -440,7 +440,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module privateLinkServices './network/private-link-service/main.bicep' = { +module privateLinkService './network/private-link-service/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nplscom' params: { // Required parameters @@ -593,7 +593,7 @@ module privateLinkServices './network/private-link-service/main.bicep' = { via Bicep module ```bicep -module privateLinkServices './network/private-link-service/main.bicep' = { +module privateLinkService './network/private-link-service/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nplsmin' params: { // Required parameters diff --git a/modules/network/public-ip-address/README.md b/modules/network/public-ip-address/README.md index 1e251b2fc8..65a7b06232 100644 --- a/modules/network/public-ip-address/README.md +++ b/modules/network/public-ip-address/README.md @@ -183,7 +183,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module publicIPAddresses './network/public-ip-address/main.bicep' = { +module publicIpAddress './network/public-ip-address/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-npiacom' params: { // Required parameters @@ -302,7 +302,7 @@ module publicIPAddresses './network/public-ip-address/main.bicep' = { via Bicep module ```bicep -module publicIPAddresses './network/public-ip-address/main.bicep' = { +module publicIpAddress './network/public-ip-address/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-npiamin' params: { // Required parameters diff --git a/modules/network/public-ip-prefix/README.md b/modules/network/public-ip-prefix/README.md index 2481033fde..7f568db336 100644 --- a/modules/network/public-ip-prefix/README.md +++ b/modules/network/public-ip-prefix/README.md @@ -166,7 +166,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module publicIPPrefixes './network/public-ip-prefix/main.bicep' = { +module publicIpPrefix './network/public-ip-prefix/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-npipcom' params: { // Required parameters @@ -249,7 +249,7 @@ module publicIPPrefixes './network/public-ip-prefix/main.bicep' = { via Bicep module ```bicep -module publicIPPrefixes './network/public-ip-prefix/main.bicep' = { +module publicIpPrefix './network/public-ip-prefix/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-npipmin' params: { // Required parameters diff --git a/modules/network/route-table/README.md b/modules/network/route-table/README.md index d7df9ab3b7..a76478d9a8 100644 --- a/modules/network/route-table/README.md +++ b/modules/network/route-table/README.md @@ -255,7 +255,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module routeTables './network/route-table/main.bicep' = { +module routeTable './network/route-table/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nrtcom' params: { // Required parameters @@ -356,7 +356,7 @@ module routeTables './network/route-table/main.bicep' = { via Bicep module ```bicep -module routeTables './network/route-table/main.bicep' = { +module routeTable './network/route-table/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nrtmin' params: { // Required parameters diff --git a/modules/network/service-endpoint-policy/README.md b/modules/network/service-endpoint-policy/README.md index 47dcabc1ba..b6728b963c 100644 --- a/modules/network/service-endpoint-policy/README.md +++ b/modules/network/service-endpoint-policy/README.md @@ -167,7 +167,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module serviceEndpointPolicies './network/service-endpoint-policy/main.bicep' = { +module serviceEndpointPolicy './network/service-endpoint-policy/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nsnpcom' params: { // Required parameters @@ -274,7 +274,7 @@ module serviceEndpointPolicies './network/service-endpoint-policy/main.bicep' = via Bicep module ```bicep -module serviceEndpointPolicies './network/service-endpoint-policy/main.bicep' = { +module serviceEndpointPolicy './network/service-endpoint-policy/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nsnpmin' params: { // Required parameters diff --git a/modules/network/trafficmanagerprofile/README.md b/modules/network/trafficmanagerprofile/README.md index 828a88b445..61fe35d3df 100644 --- a/modules/network/trafficmanagerprofile/README.md +++ b/modules/network/trafficmanagerprofile/README.md @@ -269,7 +269,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module trafficmanagerprofiles './network/trafficmanagerprofile/main.bicep' = { +module trafficmanagerprofile './network/trafficmanagerprofile/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ntmpcom' params: { // Required parameters @@ -372,7 +372,7 @@ module trafficmanagerprofiles './network/trafficmanagerprofile/main.bicep' = { via Bicep module ```bicep -module trafficmanagerprofiles './network/trafficmanagerprofile/main.bicep' = { +module trafficmanagerprofile './network/trafficmanagerprofile/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ntmpmin' params: { // Required parameters diff --git a/modules/network/virtual-hub/README.md b/modules/network/virtual-hub/README.md index 4925df1c7a..274ce7240b 100644 --- a/modules/network/virtual-hub/README.md +++ b/modules/network/virtual-hub/README.md @@ -37,8 +37,8 @@ If you are planning to deploy a Secure Virtual Hub (with an Azure Firewall integ | `allowBranchToBranchTraffic` | bool | `True` | | Flag to control transit for VirtualRouter hub. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `expressRouteGatewayId` | string | `''` | | Resource ID of the Express Route Gateway to link to. | -| `hubRouteTables` | _[hubRouteTables](hub-route-tables/README.md)_ array | `[]` | | Route tables to create for the virtual hub. | -| `hubVirtualNetworkConnections` | _[hubVirtualNetworkConnections](hub-virtual-network-connections/README.md)_ array | `[]` | | Virtual network connections to create for the virtual hub. | +| `hubRouteTables` | array | `[]` | | Route tables to create for the virtual hub. | +| `hubVirtualNetworkConnections` | array | `[]` | | Virtual network connections to create for the virtual hub. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `p2SVpnGatewayId` | string | `''` | | Resource ID of the Point-to-Site VPN Gateway to link to. | @@ -122,7 +122,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module virtualHubs './network/virtual-hub/main.bicep' = { +module virtualHub './network/virtual-hub/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvhcom' params: { // Required parameters @@ -245,7 +245,7 @@ module virtualHubs './network/virtual-hub/main.bicep' = { via Bicep module ```bicep -module virtualHubs './network/virtual-hub/main.bicep' = { +module virtualHub './network/virtual-hub/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvhmin' params: { // Required parameters diff --git a/modules/network/virtual-network-gateway/README.md b/modules/network/virtual-network-gateway/README.md index dd2ea92a44..d612514139 100644 --- a/modules/network/virtual-network-gateway/README.md +++ b/modules/network/virtual-network-gateway/README.md @@ -61,7 +61,7 @@ This module deploys a Virtual Network Gateway. | `gatewayPipName` | string | `[format('{0}-pip1', parameters('name'))]` | | Specifies the name of the Public IP used by the Virtual Network Gateway. If it's not provided, a '-pip' suffix will be appended to the gateway's name. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | -| `natRules` | _[natRules](nat-rules/README.md)_ array | `[]` | | NatRules for virtual network gateway. NAT is supported on the the following SKUs: VpnGw2~5, VpnGw2AZ~5AZ and is supported for IPsec/IKE cross-premises connections only. | +| `natRules` | array | `[]` | | NatRules for virtual network gateway. NAT is supported on the the following SKUs: VpnGw2~5, VpnGw2AZ~5AZ and is supported for IPsec/IKE cross-premises connections only. | | `publicIpdiagnosticLogCategoriesToEnable` | array | `[allLogs]` | `['', allLogs, DDoSMitigationFlowLogs, DDoSMitigationReports, DDoSProtectionNotifications]` | The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to '' to disable log collection. | | `publicIpDiagnosticSettingsName` | string | `''` | | The name of the public IP diagnostic setting, if deployed. If left empty, it defaults to "-diagnosticSettings". | | `publicIPPrefixResourceId` | string | `''` | | Resource ID of the Public IP Prefix object. This is only needed if you want your Public IPs created in a PIP Prefix. | @@ -258,7 +258,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/public-ip-addresses` | Local reference | +| `network/public-ip-address` | Local reference | ## Deployment examples @@ -274,7 +274,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module virtualNetworkGateways './network/virtual-network-gateway/main.bicep' = { +module virtualNetworkGateway './network/virtual-network-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvngavpn' params: { // Required parameters @@ -429,7 +429,7 @@ module virtualNetworkGateways './network/virtual-network-gateway/main.bicep' = { via Bicep module ```bicep -module virtualNetworkGateways './network/virtual-network-gateway/main.bicep' = { +module virtualNetworkGateway './network/virtual-network-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvger' params: { // Required parameters @@ -554,7 +554,7 @@ module virtualNetworkGateways './network/virtual-network-gateway/main.bicep' = { via Bicep module ```bicep -module virtualNetworkGateways './network/virtual-network-gateway/main.bicep' = { +module virtualNetworkGateway './network/virtual-network-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvgvpn' params: { // Required parameters diff --git a/modules/network/virtual-network/README.md b/modules/network/virtual-network/README.md index 89e206b714..bccfd1f292 100644 --- a/modules/network/virtual-network/README.md +++ b/modules/network/virtual-network/README.md @@ -51,7 +51,7 @@ This module deploys a Virtual Network (vNet). | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `peerings` | array | `[]` | | Virtual Network Peerings configurations. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `subnets` | _[subnets](subnets/README.md)_ array | `[]` | | An Array of subnets to deploy to the Virtual Network. | +| `subnets` | array | `[]` | | An Array of subnets to deploy to the Virtual Network. | | `tags` | object | `{object}` | | Tags of the resource. | | `vnetEncryption` | bool | `False` | | Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. Requires the EnableVNetEncryption feature to be registered for the subscription and a supported region to use this property. | | `vnetEncryptionEnforcement` | string | `'AllowUnencrypted'` | `[AllowUnencrypted, DropUnencrypted]` | If the encrypted VNet allows VM that does not support encryption. Can only be used when vnetEncryption is enabled. | @@ -371,7 +371,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module virtualNetworks './network/virtual-network/main.bicep' = { +module virtualNetwork './network/virtual-network/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvncom' params: { // Required parameters @@ -588,7 +588,7 @@ module virtualNetworks './network/virtual-network/main.bicep' = { via Bicep module ```bicep -module virtualNetworks './network/virtual-network/main.bicep' = { +module virtualNetwork './network/virtual-network/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvnmin' params: { // Required parameters @@ -641,7 +641,7 @@ module virtualNetworks './network/virtual-network/main.bicep' = { via Bicep module ```bicep -module virtualNetworks './network/virtual-network/main.bicep' = { +module virtualNetwork './network/virtual-network/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvnpeer' params: { // Required parameters diff --git a/modules/network/virtual-wan/README.md b/modules/network/virtual-wan/README.md index d47fa76072..a12d773711 100644 --- a/modules/network/virtual-wan/README.md +++ b/modules/network/virtual-wan/README.md @@ -168,7 +168,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module virtualWans './network/virtual-wan/main.bicep' = { +module virtualWan './network/virtual-wan/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvwcom' params: { // Required parameters @@ -263,7 +263,7 @@ module virtualWans './network/virtual-wan/main.bicep' = { via Bicep module ```bicep -module virtualWans './network/virtual-wan/main.bicep' = { +module virtualWan './network/virtual-wan/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvwmin' params: { // Required parameters diff --git a/modules/network/vpn-gateway/README.md b/modules/network/vpn-gateway/README.md index df079b1d61..28809fbc81 100644 --- a/modules/network/vpn-gateway/README.md +++ b/modules/network/vpn-gateway/README.md @@ -38,9 +38,9 @@ This module deploys a VPN Gateway. | `isRoutingPreferenceInternet` | bool | `False` | | Enable routing preference property for the public IP interface of the VPN gateway. | | `location` | string | `[resourceGroup().location]` | | Location where all resources will be created. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | -| `natRules` | _[natRules](nat-rules/README.md)_ array | `[]` | | List of all the NAT Rules to associate with the gateway. | +| `natRules` | array | `[]` | | List of all the NAT Rules to associate with the gateway. | | `tags` | object | `{object}` | | Tags of the resource. | -| `vpnConnections` | _[vpnConnections](vpn-connections/README.md)_ array | `[]` | | The VPN connections to create in the VPN gateway. | +| `vpnConnections` | array | `[]` | | The VPN connections to create in the VPN gateway. | | `vpnGatewayScaleUnit` | int | `2` | | The scale unit for this VPN gateway. | @@ -189,7 +189,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module vpnGateways './network/vpn-gateway/main.bicep' = { +module vpnGateway './network/vpn-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvgcom' params: { // Required parameters @@ -328,7 +328,7 @@ module vpnGateways './network/vpn-gateway/main.bicep' = { via Bicep module ```bicep -module vpnGateways './network/vpn-gateway/main.bicep' = { +module vpnGateway './network/vpn-gateway/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvgmin' params: { // Required parameters diff --git a/modules/network/vpn-site/README.md b/modules/network/vpn-site/README.md index 4256a3f85c..0365e2b321 100644 --- a/modules/network/vpn-site/README.md +++ b/modules/network/vpn-site/README.md @@ -342,7 +342,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module vpnSites './network/vpn-site/main.bicep' = { +module vpnSite './network/vpn-site/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvscom' params: { // Required parameters @@ -511,7 +511,7 @@ module vpnSites './network/vpn-site/main.bicep' = { via Bicep module ```bicep -module vpnSites './network/vpn-site/main.bicep' = { +module vpnSite './network/vpn-site/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-nvsmin' params: { // Required parameters diff --git a/modules/operational-insights/workspace/README.md b/modules/operational-insights/workspace/README.md index 4050f8cc46..dfc11de711 100644 --- a/modules/operational-insights/workspace/README.md +++ b/modules/operational-insights/workspace/README.md @@ -39,16 +39,16 @@ This module deploys a Log Analytics Workspace. | Parameter Name | Type | Description | | :-- | :-- | :-- | -| `linkedStorageAccounts` | _[linkedStorageAccounts](linked-storage-accounts/README.md)_ array | List of Storage Accounts to be linked. Required if 'forceCmkForQuery' is set to 'true' and 'savedSearches' is not empty. | +| `linkedStorageAccounts` | array | List of Storage Accounts to be linked. Required if 'forceCmkForQuery' is set to 'true' and 'savedSearches' is not empty. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `dailyQuotaGb` | int | `-1` | | The workspace daily quota for ingestion. | -| `dataExports` | _[dataExports](data-exports/README.md)_ array | `[]` | | LAW data export instances to be deployed. | +| `dataExports` | array | `[]` | | LAW data export instances to be deployed. | | `dataRetention` | int | `365` | | Number of days data will be retained for. | -| `dataSources` | _[dataSources](data-sources/README.md)_ array | `[]` | | LAW data sources to configure. | +| `dataSources` | array | `[]` | | LAW data sources to configure. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | | `diagnosticLogCategoriesToEnable` | array | `[allLogs]` | `['', allLogs, Audit]` | The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to '' to disable log collection. | @@ -60,18 +60,18 @@ This module deploys a Log Analytics Workspace. | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `forceCmkForQuery` | bool | `True` | | Indicates whether customer managed storage is mandatory for query management. | | `gallerySolutions` | array | `[]` | | List of gallerySolutions to be created in the log analytics workspace. | -| `linkedServices` | _[linkedServices](linked-services/README.md)_ array | `[]` | | List of services to be linked. | +| `linkedServices` | array | `[]` | | List of services to be linked. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `publicNetworkAccessForIngestion` | string | `'Enabled'` | `[Disabled, Enabled]` | The network access type for accessing Log Analytics ingestion. | | `publicNetworkAccessForQuery` | string | `'Enabled'` | `[Disabled, Enabled]` | The network access type for accessing Log Analytics query. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `savedSearches` | _[savedSearches](saved-searches/README.md)_ array | `[]` | | Kusto Query Language searches to save. | +| `savedSearches` | array | `[]` | | Kusto Query Language searches to save. | | `skuCapacityReservationLevel` | int | `100` | | The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. Must be in increments of 100 between 100 and 5000. | | `skuName` | string | `'PerGB2018'` | `[CapacityReservation, Free, LACluster, PerGB2018, PerNode, Premium, Standalone, Standard]` | The name of the SKU. | | `storageInsightsConfigs` | array | `[]` | | List of storage accounts to be read by the workspace. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | -| `tables` | _[tables](tables/README.md)_ array | `[]` | | LAW custom tables to be deployed. | +| `tables` | array | `[]` | | LAW custom tables to be deployed. | | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | | `useResourcePermissions` | bool | `False` | | Set to 'true' to use resource or workspace permissions and 'false' (or leave empty) to require workspace permissions. | @@ -496,7 +496,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `operations-management/solutions` | Local reference | +| `operations-management/solution` | Local reference | ## Deployment examples @@ -512,7 +512,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module workspaces './operational-insights/workspace/main.bicep' = { +module workspace './operational-insights/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-oiwadv' params: { // Required parameters @@ -1043,7 +1043,7 @@ module workspaces './operational-insights/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './operational-insights/workspace/main.bicep' = { +module workspace './operational-insights/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-oiwcom' params: { // Required parameters @@ -1430,7 +1430,7 @@ module workspaces './operational-insights/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './operational-insights/workspace/main.bicep' = { +module workspace './operational-insights/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-oiwmin' params: { // Required parameters diff --git a/modules/operations-management/solution/README.md b/modules/operations-management/solution/README.md index b73ab544c5..bb0ffe8148 100644 --- a/modules/operations-management/solution/README.md +++ b/modules/operations-management/solution/README.md @@ -62,7 +62,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module solutions './operations-management/solution/main.bicep' = { +module solution './operations-management/solution/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-omsmin' params: { // Required parameters @@ -111,7 +111,7 @@ module solutions './operations-management/solution/main.bicep' = { via Bicep module ```bicep -module solutions './operations-management/solution/main.bicep' = { +module solution './operations-management/solution/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-omsms' params: { // Required parameters @@ -168,7 +168,7 @@ module solutions './operations-management/solution/main.bicep' = { via Bicep module ```bicep -module solutions './operations-management/solution/main.bicep' = { +module solution './operations-management/solution/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-omsnonms' params: { // Required parameters diff --git a/modules/policy-insights/remediation/README.md b/modules/policy-insights/remediation/README.md index 8613748593..b99ddb0e37 100644 --- a/modules/policy-insights/remediation/README.md +++ b/modules/policy-insights/remediation/README.md @@ -180,7 +180,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module remediations './policy-insights/remediation/main.bicep' = { +module remediation './policy-insights/remediation/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-pirmgcom' params: { // Required parameters @@ -261,7 +261,7 @@ module remediations './policy-insights/remediation/main.bicep' = { via Bicep module ```bicep -module remediations './policy-insights/remediation/main.bicep' = { +module remediation './policy-insights/remediation/main.bicep' = { name: '${uniqueString(deployment().name)}-test-pirmgmin' params: { // Required parameters @@ -310,7 +310,7 @@ module remediations './policy-insights/remediation/main.bicep' = { via Bicep module ```bicep -module remediations './policy-insights/remediation/main.bicep' = { +module remediation './policy-insights/remediation/main.bicep' = { name: '${uniqueString(deployment().name)}-test-pirrgcom' params: { // Required parameters @@ -391,7 +391,7 @@ module remediations './policy-insights/remediation/main.bicep' = { via Bicep module ```bicep -module remediations './policy-insights/remediation/main.bicep' = { +module remediation './policy-insights/remediation/main.bicep' = { name: '${uniqueString(deployment().name)}-test-pirrgmin' params: { // Required parameters @@ -440,7 +440,7 @@ module remediations './policy-insights/remediation/main.bicep' = { via Bicep module ```bicep -module remediations './policy-insights/remediation/main.bicep' = { +module remediation './policy-insights/remediation/main.bicep' = { name: '${uniqueString(deployment().name)}-test-pirsubcom' params: { // Required parameters @@ -521,7 +521,7 @@ module remediations './policy-insights/remediation/main.bicep' = { via Bicep module ```bicep -module remediations './policy-insights/remediation/main.bicep' = { +module remediation './policy-insights/remediation/main.bicep' = { name: '${uniqueString(deployment().name)}-test-pirsubmin' params: { // Required parameters diff --git a/modules/power-bi-dedicated/capacity/README.md b/modules/power-bi-dedicated/capacity/README.md index e164aba223..6545afbebe 100644 --- a/modules/power-bi-dedicated/capacity/README.md +++ b/modules/power-bi-dedicated/capacity/README.md @@ -169,7 +169,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module capacities './power-bi-dedicated/capacity/main.bicep' = { +module capacity './power-bi-dedicated/capacity/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-pbdcapcom' params: { // Required parameters @@ -260,7 +260,7 @@ module capacities './power-bi-dedicated/capacity/main.bicep' = { via Bicep module ```bicep -module capacities './power-bi-dedicated/capacity/main.bicep' = { +module capacity './power-bi-dedicated/capacity/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-pbdcapmin' params: { // Required parameters diff --git a/modules/purview/account/README.md b/modules/purview/account/README.md index 6b99de3ce0..00e1aed6f0 100644 --- a/modules/purview/account/README.md +++ b/modules/purview/account/README.md @@ -209,7 +209,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -225,7 +225,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module accounts './purview/account/main.bicep' = { +module account './purview/account/main.bicep' = { name: '${uniqueString(deployment().name)}-test-pvacom' params: { // Required parameters @@ -520,7 +520,7 @@ module accounts './purview/account/main.bicep' = { via Bicep module ```bicep -module accounts './purview/account/main.bicep' = { +module account './purview/account/main.bicep' = { name: '${uniqueString(deployment().name)}-test-pvamin' params: { // Required parameters diff --git a/modules/recovery-services/vault/README.md b/modules/recovery-services/vault/README.md index 7461aaf002..d1e3ff99a9 100644 --- a/modules/recovery-services/vault/README.md +++ b/modules/recovery-services/vault/README.md @@ -44,7 +44,7 @@ This module deploys a Recovery Services Vault. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `backupConfig` | _[backupConfig](backup-config/README.md)_ object | `{object}` | | The backup configuration. | -| `backupPolicies` | _[backupPolicies](backup-policies/README.md)_ array | `[]` | | List of all backup policies. | +| `backupPolicies` | array | `[]` | | List of all backup policies. | | `backupStorageConfig` | _[backupStorageConfig](backup-storage-config/README.md)_ object | `{object}` | | The storage configuration for the Azure Recovery Service Vault. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | @@ -61,9 +61,9 @@ This module deploys a Recovery Services Vault. | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | | `protectionContainers` | array | `[]` | | List of all protection containers. | | `publicNetworkAccess` | string | `'Disabled'` | `[Disabled, Enabled]` | Whether or not public network access is allowed for this resource. For security reasons it should be disabled. | -| `replicationAlertSettings` | _[replicationAlertSettings](replication-alert-settings/README.md)_ object | `{object}` | | Replication alert settings. | -| `replicationFabrics` | _[replicationFabrics](replication-fabrics/README.md)_ array | `[]` | | List of all replication fabrics. | -| `replicationPolicies` | _[replicationPolicies](replication-policies/README.md)_ array | `[]` | | List of all replication policies. | +| `replicationAlertSettings` | object | `{object}` | | Replication alert settings. | +| `replicationFabrics` | array | `[]` | | List of all replication fabrics. | +| `replicationPolicies` | array | `[]` | | List of all replication policies. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `securitySettings` | object | `{object}` | | Security Settings of the vault. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | @@ -928,7 +928,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -944,7 +944,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module vaults './recovery-services/vault/main.bicep' = { +module vault './recovery-services/vault/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rsvcom' params: { // Required parameters @@ -1603,7 +1603,7 @@ module vaults './recovery-services/vault/main.bicep' = { via Bicep module ```bicep -module vaults './recovery-services/vault/main.bicep' = { +module vault './recovery-services/vault/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rsvdr' params: { // Required parameters @@ -1772,7 +1772,7 @@ module vaults './recovery-services/vault/main.bicep' = { via Bicep module ```bicep -module vaults './recovery-services/vault/main.bicep' = { +module vault './recovery-services/vault/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rsvmin' params: { // Required parameters diff --git a/modules/recovery-services/vault/backup-fabric/protection-container/README.md b/modules/recovery-services/vault/backup-fabric/protection-container/README.md index 0d10961176..5c39aced8b 100644 --- a/modules/recovery-services/vault/backup-fabric/protection-container/README.md +++ b/modules/recovery-services/vault/backup-fabric/protection-container/README.md @@ -39,7 +39,7 @@ This module deploys a Recovery Services Vault Protection Container. | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `friendlyName` | string | `''` | | Friendly name of the Protection Container. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | -| `protectedItems` | _[protectedItems](protected-items/README.md)_ array | `[]` | | Protected items to register in the container. | +| `protectedItems` | array | `[]` | | Protected items to register in the container. | | `sourceResourceId` | string | `''` | | Resource ID of the target resource for the Protection Container. | diff --git a/modules/relay/namespace/README.md b/modules/relay/namespace/README.md index 1b19542f1d..e241f834b9 100644 --- a/modules/relay/namespace/README.md +++ b/modules/relay/namespace/README.md @@ -39,7 +39,7 @@ This module deploys a Relay Namespace | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `authorizationRules` | _[authorizationRules](authorization-rules/README.md)_ array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Relay namespace. | +| `authorizationRules` | array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Relay namespace. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | | `diagnosticLogCategoriesToEnable` | array | `[allLogs, hybridConnectionsEvent]` | `['', allLogs, hybridConnectionsEvent, OperationalLogs]` | The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to '' to disable log collection. | @@ -49,15 +49,15 @@ This module deploys a Relay Namespace | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of the diagnostic log analytics workspace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `hybridConnections` | _[hybridConnections](hybrid-connections/README.md)_ array | `[]` | | The hybrid connections to create in the relay namespace. | +| `hybridConnections` | array | `[]` | | The hybrid connections to create in the relay namespace. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | -| `networkRuleSets` | _[networkRuleSets](network-rule-sets/README.md)_ object | `{object}` | | Configure networking options for Relay. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. | +| `networkRuleSets` | object | `{object}` | | Configure networking options for Relay. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `skuName` | string | `'Standard'` | `[Standard]` | Name of this SKU. | | `tags` | object | `{object}` | | Tags of the resource. | -| `wcfRelays` | _[wcfRelays](wcf-relays/README.md)_ array | `[]` | | The wcf relays to create in the relay namespace. | +| `wcfRelays` | array | `[]` | | The wcf relays to create in the relay namespace. | ### Parameter Usage: `roleAssignments` @@ -275,7 +275,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -291,7 +291,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module namespaces './relay/namespace/main.bicep' = { +module namespace './relay/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rncom' params: { // Required parameters @@ -572,7 +572,7 @@ module namespaces './relay/namespace/main.bicep' = { via Bicep module ```bicep -module namespaces './relay/namespace/main.bicep' = { +module namespace './relay/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rnmin' params: { // Required parameters @@ -617,7 +617,7 @@ module namespaces './relay/namespace/main.bicep' = { via Bicep module ```bicep -module namespaces './relay/namespace/main.bicep' = { +module namespace './relay/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rnpe' params: { // Required parameters diff --git a/modules/relay/namespace/hybrid-connection/README.md b/modules/relay/namespace/hybrid-connection/README.md index 6b0c0fd16d..a45ba19aae 100644 --- a/modules/relay/namespace/hybrid-connection/README.md +++ b/modules/relay/namespace/hybrid-connection/README.md @@ -37,7 +37,7 @@ This module deploys a Relay Namespace Hybrid Connection. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `authorizationRules` | _[authorizationRules](authorization-rules/README.md)_ array | `[System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Relay Hybrid Connection. | +| `authorizationRules` | array | `[System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Relay Hybrid Connection. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `requiresClientAuthorization` | bool | `True` | | A value indicating if this hybrid connection requires client authorization. | diff --git a/modules/relay/namespace/wcf-relay/README.md b/modules/relay/namespace/wcf-relay/README.md index 495e2f4fa2..07ca91cea0 100644 --- a/modules/relay/namespace/wcf-relay/README.md +++ b/modules/relay/namespace/wcf-relay/README.md @@ -37,7 +37,7 @@ This module deploys a Relay Namespace WCF Relay. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `authorizationRules` | _[authorizationRules](authorization-rules/README.md)_ array | `[System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the WCF Relay. | +| `authorizationRules` | array | `[System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the WCF Relay. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `requiresClientAuthorization` | bool | `True` | | A value indicating if this relay requires client authorization. | diff --git a/modules/resources/deployment-script/README.md b/modules/resources/deployment-script/README.md index d26d86e922..b5c81dcbeb 100644 --- a/modules/resources/deployment-script/README.md +++ b/modules/resources/deployment-script/README.md @@ -163,7 +163,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module deploymentScripts './resources/deployment-script/main.bicep' = { +module deploymentScript './resources/deployment-script/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rdscli' params: { // Required parameters @@ -284,7 +284,7 @@ module deploymentScripts './resources/deployment-script/main.bicep' = { via Bicep module ```bicep -module deploymentScripts './resources/deployment-script/main.bicep' = { +module deploymentScript './resources/deployment-script/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rdsps' params: { // Required parameters diff --git a/modules/resources/resource-group/README.md b/modules/resources/resource-group/README.md index 70f7addf64..b1150f03af 100644 --- a/modules/resources/resource-group/README.md +++ b/modules/resources/resource-group/README.md @@ -157,7 +157,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `authorization/locks/resource-group` | Local reference | +| `authorization/lock/resource-group` | Local reference | ## Deployment examples @@ -173,7 +173,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module resourceGroups './resources/resource-group/main.bicep' = { +module resourceGroup './resources/resource-group/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-rrgcom' params: { // Required parameters @@ -252,7 +252,7 @@ module resourceGroups './resources/resource-group/main.bicep' = { via Bicep module ```bicep -module resourceGroups './resources/resource-group/main.bicep' = { +module resourceGroup './resources/resource-group/main.bicep' = { name: '${uniqueString(deployment().name)}-test-rrgmin' params: { // Required parameters diff --git a/modules/service-bus/namespace/README.md b/modules/service-bus/namespace/README.md index eec2dfb5e4..2be3efbc55 100644 --- a/modules/service-bus/namespace/README.md +++ b/modules/service-bus/namespace/README.md @@ -47,7 +47,7 @@ This module deploys a Service Bus Namespace. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `authorizationRules` | _[authorizationRules](authorization-rules/README.md)_ array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Service Bus namespace. | +| `authorizationRules` | array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Service Bus namespace. | | `cMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption. If not provided, encryption is automatically enabled with a Microsoft-managed key. | | `cMKKeyVersion` | string | `''` | | The version of the customer managed key to reference for encryption. If not provided, the latest key version is used. | | `cMKUserAssignedIdentityResourceId` | string | `''` | | User assigned identity to use when fetching the customer managed key. If not provided, a system-assigned identity can be used - but must be given access to the referenced key vault first. | @@ -59,20 +59,20 @@ This module deploys a Service Bus Namespace. | `diagnosticSettingsName` | string | `''` | | The name of the diagnostic setting, if deployed. If left empty, it defaults to "-diagnosticSettings". | | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of the diagnostic log analytics workspace. | -| `disasterRecoveryConfigs` | _[disasterRecoveryConfigs](disaster-recovery-configs/README.md)_ object | `{object}` | | The disaster recovery configuration. | +| `disasterRecoveryConfigs` | object | `{object}` | | The disaster recovery configuration. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | -| `migrationConfigurations` | _[migrationConfigurations](migration-configurations/README.md)_ object | `{object}` | | The migration configuration. | -| `networkRuleSets` | _[networkRuleSets](network-rule-sets/README.md)_ object | `{object}` | | Configure networking options for Premium SKU Service Bus. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. | +| `migrationConfigurations` | object | `{object}` | | The migration configuration. | +| `networkRuleSets` | object | `{object}` | | Configure networking options for Premium SKU Service Bus. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | -| `queues` | _[queues](queues/README.md)_ array | `[]` | | The queues to create in the service bus namespace. | +| `queues` | array | `[]` | | The queues to create in the service bus namespace. | | `requireInfrastructureEncryption` | bool | `True` | | Enable infrastructure encryption (double encryption). Note, this setting requires the configuration of Customer-Managed-Keys (CMK) via the corresponding module parameters. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `skuName` | string | `'Basic'` | `[Basic, Premium, Standard]` | Name of this SKU. - Basic, Standard, Premium. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | | `tags` | object | `{object}` | | Tags of the resource. | -| `topics` | _[topics](topics/README.md)_ array | `[]` | | The topics to create in the service bus namespace. | +| `topics` | array | `[]` | | The topics to create in the service bus namespace. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | | `zoneRedundant` | bool | `False` | | Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. | @@ -362,7 +362,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -378,7 +378,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module namespaces './service-bus/namespace/main.bicep' = { +module namespace './service-bus/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sbncom' params: { // Required parameters @@ -731,7 +731,7 @@ module namespaces './service-bus/namespace/main.bicep' = { via Bicep module ```bicep -module namespaces './service-bus/namespace/main.bicep' = { +module namespace './service-bus/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sbnencr' params: { // Required parameters @@ -912,7 +912,7 @@ module namespaces './service-bus/namespace/main.bicep' = { via Bicep module ```bicep -module namespaces './service-bus/namespace/main.bicep' = { +module namespace './service-bus/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sbnmin' params: { // Required parameters @@ -957,7 +957,7 @@ module namespaces './service-bus/namespace/main.bicep' = { via Bicep module ```bicep -module namespaces './service-bus/namespace/main.bicep' = { +module namespace './service-bus/namespace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sbnpe' params: { // Required parameters diff --git a/modules/service-bus/namespace/queue/README.md b/modules/service-bus/namespace/queue/README.md index f3c9fa5995..d819c6b7bb 100644 --- a/modules/service-bus/namespace/queue/README.md +++ b/modules/service-bus/namespace/queue/README.md @@ -36,7 +36,7 @@ This module deploys a Service Bus Namespace Queue. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `authorizationRules` | _[authorizationRules](authorization-rules/README.md)_ array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Service Bus Queue. | +| `authorizationRules` | array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Service Bus Queue. | | `deadLetteringOnMessageExpiration` | bool | `True` | | A value that indicates whether this queue has dead letter support when a message expires. | | `defaultMessageTimeToLive` | string | `'P14D'` | | ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. | | `duplicateDetectionHistoryTimeWindow` | string | `'PT10M'` | | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | diff --git a/modules/service-bus/namespace/topic/README.md b/modules/service-bus/namespace/topic/README.md index 647cf8f054..a79f39f841 100644 --- a/modules/service-bus/namespace/topic/README.md +++ b/modules/service-bus/namespace/topic/README.md @@ -36,7 +36,7 @@ This module deploys a Service Bus Namespace Topic. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `authorizationRules` | _[authorizationRules](authorization-rules/README.md)_ array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Service Bus Topic. | +| `authorizationRules` | array | `[System.Management.Automation.OrderedHashtable]` | | Authorization Rules for the Service Bus Topic. | | `autoDeleteOnIdle` | string | `'PT5M'` | | ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | | `defaultMessageTimeToLive` | string | `'P14D'` | | ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. | | `duplicateDetectionHistoryTimeWindow` | string | `'PT10M'` | | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | diff --git a/modules/service-fabric/cluster/README.md b/modules/service-fabric/cluster/README.md index 4f9af070d5..91960ead85 100644 --- a/modules/service-fabric/cluster/README.md +++ b/modules/service-fabric/cluster/README.md @@ -35,7 +35,7 @@ This module deploys a Service Fabric Cluster. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `addOnFeatures` | array | `[]` | `[BackupRestoreService, DnsService, RepairManager, ResourceMonitorService]` | The list of add-on features to enable in the cluster. | -| `applicationTypes` | _[applicationTypes](application-types/README.md)_ array | `[]` | | Array of Service Fabric cluster application types. | +| `applicationTypes` | array | `[]` | | Array of Service Fabric cluster application types. | | `azureActiveDirectory` | object | `{object}` | | The settings to enable AAD authentication on the cluster. | | `certificate` | object | `{object}` | | Describes the certificate details like thumbprint of the primary certificate, thumbprint of the secondary certificate and the local certificate store location. | | `certificateCommonNames` | object | `{object}` | | Describes a list of server certificates referenced by common name that are used to secure the cluster. | @@ -247,7 +247,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module clusters './service-fabric/cluster/main.bicep' = { +module cluster './service-fabric/cluster/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sfccer' params: { // Required parameters @@ -356,7 +356,7 @@ module clusters './service-fabric/cluster/main.bicep' = { via Bicep module ```bicep -module clusters './service-fabric/cluster/main.bicep' = { +module cluster './service-fabric/cluster/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sfccom' params: { // Required parameters @@ -763,7 +763,7 @@ module clusters './service-fabric/cluster/main.bicep' = { via Bicep module ```bicep -module clusters './service-fabric/cluster/main.bicep' = { +module cluster './service-fabric/cluster/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sfcmin' params: { // Required parameters diff --git a/modules/signal-r-service/signal-r/README.md b/modules/signal-r-service/signal-r/README.md index f54ba9c158..48e46391ea 100644 --- a/modules/signal-r-service/signal-r/README.md +++ b/modules/signal-r-service/signal-r/README.md @@ -268,7 +268,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples diff --git a/modules/signal-r-service/web-pub-sub/README.md b/modules/signal-r-service/web-pub-sub/README.md index 0a52c0a891..115c84bf4a 100644 --- a/modules/signal-r-service/web-pub-sub/README.md +++ b/modules/signal-r-service/web-pub-sub/README.md @@ -374,7 +374,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples diff --git a/modules/sql/managed-instance/README.md b/modules/sql/managed-instance/README.md index 1755589268..8c731ac3e0 100644 --- a/modules/sql/managed-instance/README.md +++ b/modules/sql/managed-instance/README.md @@ -60,9 +60,9 @@ SQL MI allows for Azure AD Authentication via an [Azure AD Admin](https://learn. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `administratorsObj` | _[administrators](administrators/README.md)_ object | `{object}` | | The administrator configuration. | +| `administratorsObj` | object | `{object}` | | The administrator configuration. | | `collation` | string | `'SQL_Latin1_General_CP1_CI_AS'` | | Collation of the managed instance. | -| `databases` | _[databases](databases/README.md)_ array | `[]` | | Databases to create in this server. | +| `databases` | array | `[]` | | Databases to create in this server. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | | `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. | | `diagnosticLogCategoriesToEnable` | array | `[allLogs]` | `['', allLogs, ResourceUsageStats, SQLSecurityAuditEvents]` | The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to '' to disable log collection. | @@ -76,7 +76,7 @@ SQL MI allows for Azure AD Authentication via an [Azure AD Admin](https://learn. | `encryptionProtectorObj` | _[encryptionProtector](encryption-protector/README.md)_ object | `{object}` | | The encryption protection configuration. | | `hardwareFamily` | string | `'Gen5'` | | If the service has different generations of hardware, for the same SKU, then that can be captured here. | | `instancePoolResourceId` | string | `''` | | The resource ID of the instance pool this managed server belongs to. | -| `keys` | _[keys](keys/README.md)_ array | `[]` | | The keys to configure. | +| `keys` | array | `[]` | | The keys to configure. | | `licenseType` | string | `'LicenseIncluded'` | `[BasePrice, LicenseIncluded]` | The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | @@ -87,7 +87,7 @@ SQL MI allows for Azure AD Authentication via an [Azure AD Admin](https://learn. | `requestedBackupStorageRedundancy` | string | `'Geo'` | `[Geo, GeoZone, Local, Zone]` | The storage account type used to store backups for this database. | | `restorePointInTime` | string | `''` | | Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `securityAlertPoliciesObj` | _[securityAlertPolicies](security-alert-policies/README.md)_ object | `{object}` | | The security alert policy configuration. | +| `securityAlertPoliciesObj` | object | `{object}` | | The security alert policy configuration. | | `servicePrincipal` | string | `'None'` | `[None, SystemAssigned]` | Service principal type. If using AD Authentication and applying Admin, must be set to `SystemAssigned`. Then Global Admin must allow Reader access to Azure AD for the Service Principal. | | `skuName` | string | `'GP_Gen5'` | | The name of the SKU, typically, a letter + Number code, e.g. P3. | | `skuTier` | string | `'GeneralPurpose'` | | The tier or edition of the particular SKU, e.g. Basic, Premium. | @@ -98,7 +98,7 @@ SQL MI allows for Azure AD Authentication via an [Azure AD Admin](https://learn. | `timezoneId` | string | `'UTC'` | | ID of the timezone. Allowed values are timezones supported by Windows. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | | `vCores` | int | `4` | | The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. | -| `vulnerabilityAssessmentsObj` | _[vulnerabilityAssessments](vulnerability-assessments/README.md)_ object | `{object}` | | The vulnerability assessment configuration. | +| `vulnerabilityAssessmentsObj` | object | `{object}` | | The vulnerability assessment configuration. | | `zoneRedundant` | bool | `False` | | Whether or not multi-az is enabled. | @@ -295,7 +295,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module managedInstances './sql/managed-instance/main.bicep' = { +module managedInstance './sql/managed-instance/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sqlmicom' params: { administratorLogin: 'adminUserName' @@ -546,7 +546,7 @@ module managedInstances './sql/managed-instance/main.bicep' = { via Bicep module ```bicep -module managedInstances './sql/managed-instance/main.bicep' = { +module managedInstance './sql/managed-instance/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sqlmimin' params: { // Required parameters diff --git a/modules/sql/managed-instance/database/README.md b/modules/sql/managed-instance/database/README.md index ec543135e7..f8928e44cb 100644 --- a/modules/sql/managed-instance/database/README.md +++ b/modules/sql/managed-instance/database/README.md @@ -47,8 +47,8 @@ The SQL Managed Instance Database is deployed on a SQL Managed Instance. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `backupLongTermRetentionPoliciesObj` | _[backupLongTermRetentionPolicies](backup-long-term-retention-policies/README.md)_ object | `{object}` | | The configuration for the backup long term retention policy definition. | -| `backupShortTermRetentionPoliciesObj` | _[backupShortTermRetentionPolicies](backup-short-term-retention-policies/README.md)_ object | `{object}` | | The configuration for the backup short term retention policy definition. | +| `backupLongTermRetentionPoliciesObj` | object | `{object}` | | The configuration for the backup long term retention policy definition. | +| `backupShortTermRetentionPoliciesObj` | object | `{object}` | | The configuration for the backup short term retention policy definition. | | `catalogCollation` | string | `'SQL_Latin1_General_CP1_CI_AS'` | | Collation of the managed instance. | | `collation` | string | `'SQL_Latin1_General_CP1_CI_AS'` | | Collation of the managed instance database. | | `createMode` | string | `'Default'` | `[Default, PointInTimeRestore, Recovery, RestoreExternalBackup, RestoreLongTermRetentionBackup]` | Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). | diff --git a/modules/sql/server/README.md b/modules/sql/server/README.md index 82a7827752..9bfc041983 100644 --- a/modules/sql/server/README.md +++ b/modules/sql/server/README.md @@ -52,12 +52,12 @@ This module deploys an Azure SQL Server. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `databases` | _[databases](databases/README.md)_ array | `[]` | | The databases to create in the server. | -| `elasticPools` | _[elasticPools](elastic-pools/README.md)_ array | `[]` | | The Elastic Pools to create in the server. | +| `databases` | array | `[]` | | The databases to create in the server. | +| `elasticPools` | array | `[]` | | The Elastic Pools to create in the server. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `encryptionProtectorObj` | _[encryptionProtector](encryption-protector/README.md)_ object | `{object}` | | The encryption protection configuration. | -| `firewallRules` | _[firewallRules](firewall-rules/README.md)_ array | `[]` | | The firewall rules to create in the server. | -| `keys` | _[keys](keys/README.md)_ array | `[]` | | The keys to configure. | +| `firewallRules` | array | `[]` | | The firewall rules to create in the server. | +| `keys` | array | `[]` | | The keys to configure. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `minimalTlsVersion` | string | `'1.2'` | `[1.0, 1.1, 1.2]` | Minimal TLS version allowed. | @@ -65,12 +65,12 @@ This module deploys an Azure SQL Server. | `publicNetworkAccess` | string | `''` | `['', Disabled, Enabled]` | Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set and neither firewall rules nor virtual network rules are set. | | `restrictOutboundNetworkAccess` | string | `''` | `['', Disabled, Enabled]` | Whether or not to restrict outbound network access for this server. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| `securityAlertPolicies` | _[securityAlertPolicies](security-alert-policies/README.md)_ array | `[]` | | The security alert policies to create in the server. | +| `securityAlertPolicies` | array | `[]` | | The security alert policies to create in the server. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | -| `virtualNetworkRules` | _[virtualNetworkRules](virtual-network-rules/README.md)_ array | `[]` | | The virtual network rules to create in the server. | -| `vulnerabilityAssessmentsObj` | _[vulnerabilityAssessments](vulnerability-assessments/README.md)_ object | `{object}` | | The vulnerability assessment configuration. | +| `virtualNetworkRules` | array | `[]` | | The virtual network rules to create in the server. | +| `vulnerabilityAssessmentsObj` | object | `{object}` | | The vulnerability assessment configuration. | ### Parameter Usage: `roleAssignments` @@ -362,7 +362,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -378,7 +378,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module servers './sql/server/main.bicep' = { +module server './sql/server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sqlsadmin' params: { // Required parameters @@ -439,7 +439,7 @@ module servers './sql/server/main.bicep' = { via Bicep module ```bicep -module servers './sql/server/main.bicep' = { +module server './sql/server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sqlscom' params: { name: 'sqlscom' @@ -740,7 +740,7 @@ module servers './sql/server/main.bicep' = { via Bicep module ```bicep -module servers './sql/server/main.bicep' = { +module server './sql/server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sqlspe' params: { // Required parameters @@ -835,7 +835,7 @@ module servers './sql/server/main.bicep' = { via Bicep module ```bicep -module servers './sql/server/main.bicep' = { +module server './sql/server/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-sqlsec' params: { // Required parameters diff --git a/modules/sql/server/database/README.md b/modules/sql/server/database/README.md index c4bed4354a..27851faa12 100644 --- a/modules/sql/server/database/README.md +++ b/modules/sql/server/database/README.md @@ -37,8 +37,8 @@ This module deploys an Azure SQL Server Database. | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `autoPauseDelay` | int | `0` | | Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled. | -| `backupLongTermRetentionPolicy` | object | `{object}` | | The long term backup retention policy to create for the database. | -| `backupShortTermRetentionPolicy` | object | `{object}` | | The short term backup retention policy to create for the database. | +| `backupLongTermRetentionPolicy` | _[backupLongTermRetentionPolicy](backup-long-term-retention-policy/README.md)_ object | `{object}` | | The long term backup retention policy to create for the database. | +| `backupShortTermRetentionPolicy` | _[backupShortTermRetentionPolicy](backup-short-term-retention-policy/README.md)_ object | `{object}` | | The short term backup retention policy to create for the database. | | `collation` | string | `'SQL_Latin1_General_CP1_CI_AS'` | | The collation of the database. | | `createMode` | string | `'Default'` | `[Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreLongTermRetentionBackup, Secondary]` | Specifies the mode of database creation. | | `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. | diff --git a/modules/storage/storage-account/README.md b/modules/storage/storage-account/README.md index 9c8f14ea9f..bbd996d2fc 100644 --- a/modules/storage/storage-account/README.md +++ b/modules/storage/storage-account/README.md @@ -59,7 +59,7 @@ This module deploys a Storage Account. | `allowedCopyScope` | string | `''` | `['', AAD, PrivateLink]` | Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. | | `allowSharedKeyAccess` | bool | `True` | | Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true. | | `azureFilesIdentityBasedAuthentication` | object | `{object}` | | Provides the identity based authentication settings for Azure Files. | -| `blobServices` | _[blobServices](blob-services/README.md)_ object | `{object}` | | Blob service and containers to deploy. | +| `blobServices` | object | `{object}` | | Blob service and containers to deploy. | | `cMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption. Cannot be deployed together with the parameter 'systemAssignedIdentity' enabled. | | `cMKKeyVersion` | string | `''` | | The version of the customer managed key to reference for encryption. If not provided, latest is used. | | `customDomainName` | string | `''` | | Sets the custom domain name assigned to the storage account. Name is the CNAME source. | @@ -76,11 +76,11 @@ This module deploys a Storage Account. | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `enableNfsV3` | bool | `False` | | If true, enables NFS 3.0 support for the storage account. Requires enableHierarchicalNamespace to be true. | | `enableSftp` | bool | `False` | | If true, enables Secure File Transfer Protocol for the storage account. Requires enableHierarchicalNamespace to be true. | -| `fileServices` | _[fileServices](file-services/README.md)_ object | `{object}` | | File service and shares to deploy. | +| `fileServices` | object | `{object}` | | File service and shares to deploy. | | `isLocalUserEnabled` | bool | `False` | | Enables local users feature, if set to true. | | `kind` | string | `'StorageV2'` | `[BlobStorage, BlockBlobStorage, FileStorage, Storage, StorageV2]` | Type of Storage Account to create. | | `largeFileSharesState` | string | `'Disabled'` | `[Disabled, Enabled]` | Allow large file shares if sets to 'Enabled'. It cannot be disabled once it is enabled. Only supported on locally redundant and zone redundant file shares. It cannot be set on FileStorage storage accounts (storage accounts for premium file shares). | -| `localUsers` | _[localUsers](local-users/README.md)_ array | `[]` | | Local users to deploy for SFTP authentication. | +| `localUsers` | array | `[]` | | Local users to deploy for SFTP authentication. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `managementPolicyRules` | array | `[]` | | The Storage Account ManagementPolicies Rules. | @@ -88,14 +88,14 @@ This module deploys a Storage Account. | `networkAcls` | object | `{object}` | | Networks ACLs, this value contains IPs to whitelist and/or Subnet information. For security reasons, it is recommended to set the DefaultAction Deny. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. | | `publicNetworkAccess` | string | `''` | `['', Disabled, Enabled]` | Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set and networkAcls are not set. | -| `queueServices` | _[queueServices](queue-services/README.md)_ object | `{object}` | | Queue service and queues to create. | +| `queueServices` | object | `{object}` | | Queue service and queues to create. | | `requireInfrastructureEncryption` | bool | `True` | | A Boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. For security reasons, it is recommended to set it to true. | | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `sasExpirationPeriod` | string | `''` | | The SAS expiration period. DD.HH:MM:SS. | | `skuName` | string | `'Standard_GRS'` | `[Premium_LRS, Premium_ZRS, Standard_GRS, Standard_GZRS, Standard_LRS, Standard_RAGRS, Standard_RAGZRS, Standard_ZRS]` | Storage Account Sku Name. | | `supportsHttpsTrafficOnly` | bool | `True` | | Allows HTTPS traffic only to storage service if sets to true. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | -| `tableServices` | _[tableServices](table-services/README.md)_ object | `{object}` | | Table service and tables to create. | +| `tableServices` | object | `{object}` | | Table service and tables to create. | | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | @@ -410,7 +410,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -426,7 +426,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module storageAccounts './storage/storage-account/main.bicep' = { +module storageAccount './storage/storage-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ssacom' params: { // Required parameters @@ -891,7 +891,7 @@ module storageAccounts './storage/storage-account/main.bicep' = { via Bicep module ```bicep -module storageAccounts './storage/storage-account/main.bicep' = { +module storageAccount './storage/storage-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ssaencr' params: { // Required parameters @@ -1058,7 +1058,7 @@ module storageAccounts './storage/storage-account/main.bicep' = { via Bicep module ```bicep -module storageAccounts './storage/storage-account/main.bicep' = { +module storageAccount './storage/storage-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ssamin' params: { // Required parameters @@ -1107,7 +1107,7 @@ module storageAccounts './storage/storage-account/main.bicep' = { via Bicep module ```bicep -module storageAccounts './storage/storage-account/main.bicep' = { +module storageAccount './storage/storage-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ssanfs' params: { // Required parameters @@ -1252,7 +1252,7 @@ module storageAccounts './storage/storage-account/main.bicep' = { via Bicep module ```bicep -module storageAccounts './storage/storage-account/main.bicep' = { +module storageAccount './storage/storage-account/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-ssav1' params: { // Required parameters diff --git a/modules/storage/storage-account/blob-service/README.md b/modules/storage/storage-account/blob-service/README.md index 2a344f3fc2..4a2cd4ae63 100644 --- a/modules/storage/storage-account/blob-service/README.md +++ b/modules/storage/storage-account/blob-service/README.md @@ -37,7 +37,7 @@ This module deploys a Storage Account Blob Service. | `containerDeleteRetentionPolicyAllowPermanentDelete` | bool | `False` | | This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used with blob restore policy. This property only applies to blob service and does not apply to containers or file share. | | `containerDeleteRetentionPolicyDays` | int | `7` | | Indicates the number of days that the deleted item should be retained. | | `containerDeleteRetentionPolicyEnabled` | bool | `True` | | The blob service properties for container soft delete. Indicates whether DeleteRetentionPolicy is enabled. | -| `containers` | _[containers](containers/README.md)_ array | `[]` | | Blob containers to create. | +| `containers` | array | `[]` | | Blob containers to create. | | `corsRules` | array | `[]` | | Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. | | `defaultServiceVersion` | string | `''` | | Indicates the default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions. | | `deleteRetentionPolicyAllowPermanentDelete` | bool | `False` | | This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used with blob restore policy. This property only applies to blob service and does not apply to containers or file share. | diff --git a/modules/storage/storage-account/file-service/README.md b/modules/storage/storage-account/file-service/README.md index c6bc3ae6d6..a85bba06bf 100644 --- a/modules/storage/storage-account/file-service/README.md +++ b/modules/storage/storage-account/file-service/README.md @@ -42,7 +42,7 @@ This module deploys a Storage Account File Share Service. | `name` | string | `'default'` | | The name of the file service. | | `protocolSettings` | object | `{object}` | | Protocol settings for file service. | | `shareDeleteRetentionPolicy` | object | `{object}` | | The service properties for soft delete. | -| `shares` | _[shares](shares/README.md)_ array | `[]` | | File shares to create. | +| `shares` | array | `[]` | | File shares to create. | ## Outputs diff --git a/modules/storage/storage-account/queue-service/README.md b/modules/storage/storage-account/queue-service/README.md index d1a44feaba..f0410dd6f9 100644 --- a/modules/storage/storage-account/queue-service/README.md +++ b/modules/storage/storage-account/queue-service/README.md @@ -39,7 +39,7 @@ This module deploys a Storage Account Queue Service. | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of a log analytics workspace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `queues` | _[queues](queues/README.md)_ array | `[]` | | Queues to create. | +| `queues` | array | `[]` | | Queues to create. | ## Outputs diff --git a/modules/storage/storage-account/table-service/README.md b/modules/storage/storage-account/table-service/README.md index c6f0b867e5..ef4e9243f6 100644 --- a/modules/storage/storage-account/table-service/README.md +++ b/modules/storage/storage-account/table-service/README.md @@ -38,7 +38,7 @@ This module deploys a Storage Account Table Service. | `diagnosticStorageAccountId` | string | `''` | | Resource ID of the diagnostic storage account. | | `diagnosticWorkspaceId` | string | `''` | | Resource ID of a log analytics workspace. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | -| `tables` | _[tables](tables/README.md)_ array | `[]` | | tables to create. | +| `tables` | array | `[]` | | tables to create. | ## Outputs diff --git a/modules/synapse/private-link-hub/README.md b/modules/synapse/private-link-hub/README.md index e65e912a6f..5a39499cf2 100644 --- a/modules/synapse/private-link-hub/README.md +++ b/modules/synapse/private-link-hub/README.md @@ -255,7 +255,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -271,7 +271,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module privateLinkHubs './synapse/private-link-hub/main.bicep' = { +module privateLinkHub './synapse/private-link-hub/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-splhcom' params: { // Required parameters @@ -394,7 +394,7 @@ module privateLinkHubs './synapse/private-link-hub/main.bicep' = { via Bicep module ```bicep -module privateLinkHubs './synapse/private-link-hub/main.bicep' = { +module privateLinkHub './synapse/private-link-hub/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-splhmin' params: { // Required parameters diff --git a/modules/synapse/workspace/README.md b/modules/synapse/workspace/README.md index 6f490ef722..41c1cbda90 100644 --- a/modules/synapse/workspace/README.md +++ b/modules/synapse/workspace/README.md @@ -62,7 +62,7 @@ This module deploys a Synapse Workspace. | `encryption` | bool | `False` | | Double encryption using a customer-managed key. | | `encryptionActivateWorkspace` | bool | `False` | | Activate workspace by adding the system managed identity in the KeyVault containing the customer managed key and activating the workspace. | | `initialWorkspaceAdminObjectID` | string | `''` | | AAD object ID of initial workspace admin. | -| `integrationRuntimes` | _[integrationRuntimes](integration-runtimes/README.md)_ array | `[]` | | The Integration Runtimes to create. | +| `integrationRuntimes` | array | `[]` | | The Integration Runtimes to create. | | `linkedAccessCheckOnTargetResource` | bool | `False` | | Linked Access Check On Target Resource. | | `location` | string | `[resourceGroup().location]` | | The geo-location where the resource lives. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | @@ -329,7 +329,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -345,7 +345,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module workspaces './synapse/workspace/main.bicep' = { +module workspace './synapse/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-swcom' params: { // Required parameters @@ -524,7 +524,7 @@ module workspaces './synapse/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './synapse/workspace/main.bicep' = { +module workspace './synapse/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-swensa' params: { // Required parameters @@ -601,7 +601,7 @@ module workspaces './synapse/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './synapse/workspace/main.bicep' = { +module workspace './synapse/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-swenua' params: { // Required parameters @@ -684,7 +684,7 @@ module workspaces './synapse/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './synapse/workspace/main.bicep' = { +module workspace './synapse/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-swmanv' params: { // Required parameters @@ -767,7 +767,7 @@ module workspaces './synapse/workspace/main.bicep' = { via Bicep module ```bicep -module workspaces './synapse/workspace/main.bicep' = { +module workspace './synapse/workspace/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-swmin' params: { // Required parameters diff --git a/modules/virtual-machine-images/image-template/README.md b/modules/virtual-machine-images/image-template/README.md index 8d22e189c2..1fec02183a 100644 --- a/modules/virtual-machine-images/image-template/README.md +++ b/modules/virtual-machine-images/image-template/README.md @@ -352,7 +352,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module imageTemplates './virtual-machine-images/image-template/main.bicep' = { +module imageTemplate './virtual-machine-images/image-template/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-vmiitcom' params: { // Required parameters @@ -517,7 +517,7 @@ module imageTemplates './virtual-machine-images/image-template/main.bicep' = { via Bicep module ```bicep -module imageTemplates './virtual-machine-images/image-template/main.bicep' = { +module imageTemplate './virtual-machine-images/image-template/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-vmiitmin' params: { // Required parameters diff --git a/modules/web/connection/README.md b/modules/web/connection/README.md index 0fe03ac2e2..c98e28f322 100644 --- a/modules/web/connection/README.md +++ b/modules/web/connection/README.md @@ -171,7 +171,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module connections './web/connection/main.bicep' = { +module connection './web/connection/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-wccom' params: { // Required parameters diff --git a/modules/web/hosting-environment/README.md b/modules/web/hosting-environment/README.md index e925ccdcc4..942d442db9 100644 --- a/modules/web/hosting-environment/README.md +++ b/modules/web/hosting-environment/README.md @@ -267,7 +267,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module hostingEnvironments './web/hosting-environment/main.bicep' = { +module hostingEnvironment './web/hosting-environment/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-whasev2' params: { // Required parameters @@ -412,7 +412,7 @@ module hostingEnvironments './web/hosting-environment/main.bicep' = { via Bicep module ```bicep -module hostingEnvironments './web/hosting-environment/main.bicep' = { +module hostingEnvironment './web/hosting-environment/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-whasev3' params: { // Required parameters diff --git a/modules/web/serverfarm/README.md b/modules/web/serverfarm/README.md index 0d9e6a4bb9..91bbd57e2f 100644 --- a/modules/web/serverfarm/README.md +++ b/modules/web/serverfarm/README.md @@ -218,7 +218,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module serverfarms './web/serverfarm/main.bicep' = { +module serverfarm './web/serverfarm/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-wsfcom' params: { // Required parameters diff --git a/modules/web/site/README.md b/modules/web/site/README.md index abec3912a0..d76222d28a 100644 --- a/modules/web/site/README.md +++ b/modules/web/site/README.md @@ -47,7 +47,7 @@ This module deploys a Web or Function App. | `appServiceEnvironmentResourceId` | string | `''` | | The resource ID of the app service environment to use for this resource. | | `appSettingsKeyValuePairs` | object | `{object}` | | The app settings-value pairs except for AzureWebJobsStorage, AzureWebJobsDashboard, APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING. | | `authSettingV2Configuration` | object | `{object}` | | The auth settings V2 configuration. | -| `basicPublishingCredentialsPolicies` | _[basicPublishingCredentialsPolicies](basic-publishing-credentials-policies/README.md)_ array | `[]` | | The site publishing credential policy names which are associated with the sites. | +| `basicPublishingCredentialsPolicies` | array | `[]` | | The site publishing credential policy names which are associated with the sites. | | `clientAffinityEnabled` | bool | `True` | | If client affinity is enabled. | | `clientCertEnabled` | bool | `False` | | To enable client certificate authentication (TLS mutual authentication). | | `clientCertExclusionPaths` | string | `''` | | Client certificate authentication comma-separated exclusion paths. | @@ -78,7 +78,7 @@ This module deploys a Web or Function App. | `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | | `setAzureWebJobsDashboard` | bool | `[if(contains(parameters('kind'), 'functionapp'), true(), false())]` | | For function apps. If true the app settings "AzureWebJobsDashboard" will be set. If false not. In case you use Application Insights it can make sense to not set it for performance reasons. | | `siteConfig` | object | `{object}` | | The site config object. | -| `slots` | _[slots](slots/README.md)_ array | `[]` | | Configuration for deployment slots for an app. | +| `slots` | array | `[]` | | Configuration for deployment slots for an app. | | `storageAccountRequired` | bool | `False` | | Checks if Customer provided storage account is required. | | `storageAccountResourceId` | string | `''` | | Required if app of kind functionapp. Resource ID of the storage account to manage triggers and logging function executions. | | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | @@ -440,7 +440,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -456,7 +456,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module sites './web/site/main.bicep' = { +module site './web/site/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-wsfacom' params: { // Required parameters @@ -777,7 +777,7 @@ module sites './web/site/main.bicep' = { via Bicep module ```bicep -module sites './web/site/main.bicep' = { +module site './web/site/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-wsfamin' params: { // Required parameters @@ -838,7 +838,7 @@ module sites './web/site/main.bicep' = { via Bicep module ```bicep -module sites './web/site/main.bicep' = { +module site './web/site/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-wswa' params: { // Required parameters @@ -1137,7 +1137,7 @@ module sites './web/site/main.bicep' = { via Bicep module ```bicep -module sites './web/site/main.bicep' = { +module site './web/site/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-wswamin' params: { // Required parameters diff --git a/modules/web/static-site/README.md b/modules/web/static-site/README.md index a0c1ec292a..5c552478a4 100644 --- a/modules/web/static-site/README.md +++ b/modules/web/static-site/README.md @@ -39,11 +39,11 @@ This module deploys a Static Web App. | `appSettings` | object | `{object}` | | Static site app settings. | | `branch` | string | `''` | | The branch name of the GitHub repository. | | `buildProperties` | object | `{object}` | | Build properties for the static site. | -| `customDomains` | _[customDomains](custom-domains/README.md)_ array | `[]` | | The custom domains associated with this static site. The deployment will fail as long as the validation records are not present. | +| `customDomains` | array | `[]` | | The custom domains associated with this static site. The deployment will fail as long as the validation records are not present. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). | | `enterpriseGradeCdnStatus` | string | `'Disabled'` | `[Disabled, Disabling, Enabled, Enabling]` | State indicating the status of the enterprise grade CDN serving traffic to the static web app. | | `functionAppSettings` | object | `{object}` | | Function app settings. | -| `linkedBackend` | object | `{object}` | | Object with "resourceId" and "location" of the a user defined function app. | +| `linkedBackend` | _[linkedBackend](linked-backend/README.md)_ object | `{object}` | | Object with "resourceId" and "location" of the a user defined function app. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. | | `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. Note, requires the 'sku' to be 'Standard'. | @@ -342,7 +342,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | -| `network/private-endpoints` | Local reference | +| `network/private-endpoint` | Local reference | ## Deployment examples @@ -358,7 +358,7 @@ The following module usage examples are retrieved from the content of the files via Bicep module ```bicep -module staticSites './web/static-site/main.bicep' = { +module staticSite './web/static-site/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-wsscom' params: { // Required parameters @@ -525,7 +525,7 @@ module staticSites './web/static-site/main.bicep' = { via Bicep module ```bicep -module staticSites './web/static-site/main.bicep' = { +module staticSite './web/static-site/main.bicep' = { name: '${uniqueString(deployment().name, location)}-test-wssmin' params: { // Required parameters