Skip to content

Commit dff75dc

Browse files
fix: Fixed metadata fix & values across modules (#3615)
## Description - Common-Types: Fixed incorrect parameter description: The FQDN parameter is optional, yet the description said it was required. - Diverse: Fixed metadata descriptions - Fixed static test validating parameter descriptions - It checked for a line that looke like ('Required. even though the value of the $description variable at the time only has the description's value, that is Required. - Added test that tests the reverse, that is, that a parameter's description starts with Required. in its title if it is required > Linked to Azure/Azure-Verified-Modules#1591 ## Pipeline Reference | Pipeline | | -------- | [![avm.ptn.ai-platform.baseline](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.ai-platform.baseline.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.ai-platform.baseline.yml) [![avm.ptn.lz.sub-vending](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.lz.sub-vending.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.lz.sub-vending.yml) [![avm.ptn.virtual-machine-images.azure-image-builder](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.virtual-machine-images.azure-image-builder.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.virtual-machine-images.azure-image-builder.yml) [![avm.res.app-configuration.configuration-store](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.app-configuration.configuration-store.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.app-configuration.configuration-store.yml) [![avm.res.app.job](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.app.job.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.app.job.yml) [![avm.res.batch.batch-account](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.batch.batch-account.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.batch.batch-account.yml) [![avm.res.cache.redis](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.cache.redis.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.cache.redis.yml) [![avm.res.cdn.profile](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.cdn.profile.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.cdn.profile.yml) [![avm.res.cognitive-services.account](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.cognitive-services.account.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.cognitive-services.account.yml) [![avm.res.consumption.budget](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.consumption.budget.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.consumption.budget.yml) [![avm.res.container-registry.registry](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.container-registry.registry.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.container-registry.registry.yml) [![avm.res.container-service.managed-cluster](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.container-service.managed-cluster.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.container-service.managed-cluster.yml) [![avm.res.data-factory.factory](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.data-factory.factory.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.data-factory.factory.yml) [![avm.res.databricks.workspace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.databricks.workspace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.databricks.workspace.yml) [![avm.res.desktop-virtualization.host-pool](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.host-pool.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.host-pool.yml) [![avm.res.desktop-virtualization.workspace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.workspace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.workspace.yml) [![avm.res.digital-twins.digital-twins-instance](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.digital-twins.digital-twins-instance.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.digital-twins.digital-twins-instance.yml) [![avm.res.document-db.database-account](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.document-db.database-account.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.document-db.database-account.yml) [![avm.res.document-db.mongo-cluster](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.document-db.mongo-cluster.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.document-db.mongo-cluster.yml) [![avm.res.event-grid.domain](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.event-grid.domain.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.event-grid.domain.yml) [![avm.res.event-grid.namespace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.event-grid.namespace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.event-grid.namespace.yml) [![avm.res.event-grid.topic](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.event-grid.topic.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.event-grid.topic.yml) [![avm.res.event-hub.namespace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.event-hub.namespace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.event-hub.namespace.yml) [![avm.res.healthcare-apis.workspace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.healthcare-apis.workspace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.healthcare-apis.workspace.yml) [![avm.res.insights.private-link-scope](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.insights.private-link-scope.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.insights.private-link-scope.yml) [![avm.res.key-vault.vault](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml) [![avm.res.kusto.cluster](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.kusto.cluster.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.kusto.cluster.yml) [![avm.res.machine-learning-services.workspace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.machine-learning-services.workspace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.machine-learning-services.workspace.yml) [![avm.res.net-app.net-app-account](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.net-app.net-app-account.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.net-app.net-app-account.yml) [![avm.res.network.application-gateway](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.network.application-gateway.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.network.application-gateway.yml) [![avm.res.network.private-endpoint](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml) [![avm.res.operational-insights.workspace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.operational-insights.workspace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.operational-insights.workspace.yml) [![avm.res.purview.account](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.purview.account.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.purview.account.yml) [![avm.res.recovery-services.vault](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.recovery-services.vault.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.recovery-services.vault.yml) [![avm.res.relay.namespace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.relay.namespace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.relay.namespace.yml) [![avm.res.search.search-service](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.search.search-service.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.search.search-service.yml) [![avm.res.service-bus.namespace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.service-bus.namespace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.service-bus.namespace.yml) [![avm.res.signal-r-service.signal-r](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.signal-r-service.signal-r.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.signal-r-service.signal-r.yml) [![avm.res.signal-r-service.web-pub-sub](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.signal-r-service.web-pub-sub.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.signal-r-service.web-pub-sub.yml) [![avm.res.sql.server](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.sql.server.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.sql.server.yml) [![avm.res.storage.storage-account](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.storage.storage-account.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.storage.storage-account.yml) [![avm.res.synapse.private-link-hub](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.synapse.private-link-hub.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.synapse.private-link-hub.yml) [![avm.res.synapse.workspace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.synapse.workspace.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.synapse.workspace.yml) [![avm.res.web.site](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.web.site.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.web.site.yml) [![avm.res.web.static-site](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.web.static-site.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.web.static-site.yml) [![avm.utl.types.avm-common-types](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.utl.types.avm-common-types.yml/badge.svg?branch=users%2Falsehr%2FmetaDataFix&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.utl.types.avm-common-types.yml) ## Type of Change - [x] Update to CI Environment or utilities (Non-module affecting changes) - [ ] Azure Verified Module updates: - [x] Bugfix containing backwards-compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in `version.json`: - [ ] Someone has opened a bug report issue, and I have included "Closes #{bug_report_issue_number}" in the PR description. - [ ] The bug was found by the module author, and no one has opened an issue to report it yet. - [ ] Feature update backwards compatible feature updates, and I have bumped the MINOR version in `version.json`. - [ ] Breaking changes and I have bumped the MAJOR version in `version.json`. - [ ] Update to documentation --------- Co-authored-by: Erika Gressi <[email protected]>
1 parent 16c96cc commit dff75dc

File tree

220 files changed

+2272
-2028
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

220 files changed

+2272
-2028
lines changed

avm/ptn/ai-platform/baseline/main.bicep

+1-1
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ type virtualMachineConfigurationType = {
798798
@description('Optional. The availability zone of the virtual machine. If set to 0, no availability zone is used (default).')
799799
zone: 0 | 1 | 2 | 3?
800800

801-
@description('Required. The virtual machine size. Defaults to \'Standard_D2s_v3\'.')
801+
@description('Optional. The virtual machine size. Defaults to \'Standard_D2s_v3\'.')
802802
size: string?
803803

804804
@description('Conditional. The username for the administrator account on the virtual machine. Required if a virtual machine is created as part of the module.')

avm/ptn/ai-platform/baseline/main.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"_generator": {
77
"name": "bicep",
88
"version": "0.30.23.60470",
9-
"templateHash": "14190804454906731332"
9+
"templateHash": "8118431971207259255"
1010
},
1111
"name": "AI Platform Baseline",
1212
"description": "This module provides a secure and scalable environment for deploying AI applications on Azure.\nThe module encompasses all essential components required for building, managing, and observing AI solutions, including a machine learning workspace, observability tools, and necessary data management services.\nBy integrating with Microsoft Entra ID for secure identity management and utilizing private endpoints for services like Key Vault and Blob Storage, the module ensures secure communication and data access.",
@@ -470,7 +470,7 @@
470470
"type": "string",
471471
"nullable": true,
472472
"metadata": {
473-
"description": "Required. The virtual machine size. Defaults to 'Standard_D2s_v3'."
473+
"description": "Optional. The virtual machine size. Defaults to 'Standard_D2s_v3'."
474474
}
475475
},
476476
"adminUsername": {

avm/ptn/lz/sub-vending/README.md

+8-13
Original file line numberDiff line numberDiff line change
@@ -1046,25 +1046,13 @@ The condition for the role assignment.
10461046
- Required: No
10471047
- Type: object
10481048

1049-
**Required parameters**
1050-
1051-
| Parameter | Type | Description |
1052-
| :-- | :-- | :-- |
1053-
| [`roleConditionType`](#parameter-roleassignmentsroleassignmentconditionroleconditiontype) | object | The type of template for the role assignment condition. |
1054-
10551049
**Optional parameters**
10561050

10571051
| Parameter | Type | Description |
10581052
| :-- | :-- | :-- |
10591053
| [`conditionVersion`](#parameter-roleassignmentsroleassignmentconditionconditionversion) | string | The version of the condition template. |
10601054
| [`delegationCode`](#parameter-roleassignmentsroleassignmentconditiondelegationcode) | string | The code for a custom condition if no template is used. The user should supply their own custom code if the available templates are not matching their requirements. If a value is provided, this will overwrite any added template. All single quotes needs to be skipped using '. |
1061-
1062-
### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType`
1063-
1064-
The type of template for the role assignment condition.
1065-
1066-
- Required: No
1067-
- Type: object
1055+
| [`roleConditionType`](#parameter-roleassignmentsroleassignmentconditionroleconditiontype) | object | The type of template for the role assignment condition. |
10681056

10691057
### Parameter: `roleAssignments.roleAssignmentCondition.conditionVersion`
10701058

@@ -1086,6 +1074,13 @@ The code for a custom condition if no template is used. The user should supply t
10861074
- Required: No
10871075
- Type: string
10881076

1077+
### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType`
1078+
1079+
The type of template for the role assignment condition.
1080+
1081+
- Required: No
1082+
- Type: object
1083+
10891084
### Parameter: `subscriptionAliasEnabled`
10901085

10911086
Whether to create a new Subscription using the Subscription Alias resource. If `false`, supply an existing Subscription''s ID in the parameter named `existingSubscriptionId` instead to deploy resources to an existing Subscription.

avm/ptn/lz/sub-vending/main.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"_generator": {
77
"name": "bicep",
88
"version": "0.30.23.60470",
9-
"templateHash": "7041333731896478717"
9+
"templateHash": "15801074137418249415"
1010
},
1111
"name": "Sub-vending",
1212
"description": "This module deploys a subscription to accelerate deployment of landing zones. For more information on how to use it, please visit this [Wiki](https://github.com/Azure/bicep-lz-vending/wiki).",
@@ -163,7 +163,7 @@
163163
"$ref": "#/definitions/_1.constrainedDelegationTemplatesType",
164164
"nullable": true,
165165
"metadata": {
166-
"description": "Required. The type of template for the role assignment condition."
166+
"description": "Optional. The type of template for the role assignment condition."
167167
}
168168
},
169169
"conditionVersion": {
@@ -881,7 +881,7 @@
881881
"_generator": {
882882
"name": "bicep",
883883
"version": "0.30.23.60470",
884-
"templateHash": "1508834239626613483"
884+
"templateHash": "17058377789394467622"
885885
},
886886
"name": "`/subResourcesWrapper/deploy.bicep` Parameters",
887887
"description": "This module is used by the [`bicep-lz-vending`](https://aka.ms/sub-vending/bicep) module to help orchestrate the deployment",
@@ -1063,7 +1063,7 @@
10631063
"$ref": "#/definitions/constrainedDelegationTemplatesType",
10641064
"nullable": true,
10651065
"metadata": {
1066-
"description": "Required. The type of template for the role assignment condition."
1066+
"description": "Optional. The type of template for the role assignment condition."
10671067
}
10681068
},
10691069
"conditionVersion": {

avm/ptn/lz/sub-vending/modules/subResourceWrapper.bicep

+1-1
Original file line numberDiff line numberDiff line change
@@ -767,7 +767,7 @@ type constrainedDelegationTemplatesType =
767767
// Role Assignment Condition type
768768
@export()
769769
type roleAssignmentConditionType = {
770-
@description('Required. The type of template for the role assignment condition.')
770+
@description('Optional. The type of template for the role assignment condition.')
771771
roleConditionType: constrainedDelegationTemplatesType?
772772

773773
@description('Optional. The version of the condition template.')

avm/ptn/virtual-machine-images/azure-image-builder/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -1180,6 +1180,11 @@ The files to upload to the Assets Storage Account.
11801180
| Parameter | Type | Description |
11811181
| :-- | :-- | :-- |
11821182
| [`name`](#parameter-storageaccountfilestouploadname) | string | The name of the environment variable. |
1183+
1184+
**Optional parameters**
1185+
1186+
| Parameter | Type | Description |
1187+
| :-- | :-- | :-- |
11831188
| [`secureValue`](#parameter-storageaccountfilestouploadsecurevalue) | securestring | The value of the secure environment variable. |
11841189
| [`value`](#parameter-storageaccountfilestouploadvalue) | string | The value of the environment variable. |
11851190

avm/ptn/virtual-machine-images/azure-image-builder/main.bicep

+2-2
Original file line numberDiff line numberDiff line change
@@ -597,10 +597,10 @@ type storageAccountFilesToUploadType = {
597597
@description('Required. The name of the environment variable.')
598598
name: string
599599

600-
@description('Required. The value of the secure environment variable.')
600+
@description('Optional. The value of the secure environment variable.')
601601
@secure()
602602
secureValue: string?
603603

604-
@description('Required. The value of the environment variable.')
604+
@description('Optional. The value of the environment variable.')
605605
value: string?
606606
}

avm/ptn/virtual-machine-images/azure-image-builder/main.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"_generator": {
77
"name": "bicep",
88
"version": "0.30.23.60470",
9-
"templateHash": "4580919221810730076"
9+
"templateHash": "9111396630441610187"
1010
},
1111
"name": "Custom Images using Azure Image Builder",
1212
"description": "This module provides you with a packaged solution to create custom images using the Azure Image Builder service publishing to an Azure Compute Gallery.",
@@ -26,14 +26,14 @@
2626
"type": "securestring",
2727
"nullable": true,
2828
"metadata": {
29-
"description": "Required. The value of the secure environment variable."
29+
"description": "Optional. The value of the secure environment variable."
3030
}
3131
},
3232
"value": {
3333
"type": "string",
3434
"nullable": true,
3535
"metadata": {
36-
"description": "Required. The value of the environment variable."
36+
"description": "Optional. The value of the environment variable."
3737
}
3838
}
3939
},

avm/res/app-configuration/configuration-store/README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -1324,15 +1324,13 @@ Custom DNS configurations.
13241324

13251325
| Parameter | Type | Description |
13261326
| :-- | :-- | :-- |
1327-
| [`fqdn`](#parameter-privateendpointscustomdnsconfigsfqdn) | string | Fqdn that resolves to private endpoint IP address. |
13281327
| [`ipAddresses`](#parameter-privateendpointscustomdnsconfigsipaddresses) | array | A list of private IP addresses of the private endpoint. |
13291328

1330-
### Parameter: `privateEndpoints.customDnsConfigs.fqdn`
1331-
1332-
Fqdn that resolves to private endpoint IP address.
1329+
**Optional parameters**
13331330

1334-
- Required: No
1335-
- Type: string
1331+
| Parameter | Type | Description |
1332+
| :-- | :-- | :-- |
1333+
| [`fqdn`](#parameter-privateendpointscustomdnsconfigsfqdn) | string | FQDN that resolves to private endpoint IP address. |
13361334

13371335
### Parameter: `privateEndpoints.customDnsConfigs.ipAddresses`
13381336

@@ -1341,6 +1339,13 @@ A list of private IP addresses of the private endpoint.
13411339
- Required: Yes
13421340
- Type: array
13431341

1342+
### Parameter: `privateEndpoints.customDnsConfigs.fqdn`
1343+
1344+
FQDN that resolves to private endpoint IP address.
1345+
1346+
- Required: No
1347+
- Type: string
1348+
13441349
### Parameter: `privateEndpoints.customNetworkInterfaceName`
13451350

13461351
The custom name of the network interface attached to the private endpoint.

avm/res/app-configuration/configuration-store/main.bicep

+1-1
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ type privateEndpointType = {
447447

448448
@description('Optional. Custom DNS configurations.')
449449
customDnsConfigs: {
450-
@description('Required. Fqdn that resolves to private endpoint IP address.')
450+
@description('Optional. FQDN that resolves to private endpoint IP address.')
451451
fqdn: string?
452452

453453
@description('Required. A list of private IP addresses of the private endpoint.')

avm/res/app-configuration/configuration-store/main.json

+9-9
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"metadata": {
66
"_generator": {
77
"name": "bicep",
8-
"version": "0.29.47.4906",
9-
"templateHash": "12024958859514872959"
8+
"version": "0.30.23.60470",
9+
"templateHash": "1061724596337882078"
1010
},
1111
"name": "App Configuration Stores",
1212
"description": "This module deploys an App Configuration Store.",
@@ -237,7 +237,7 @@
237237
"type": "string",
238238
"nullable": true,
239239
"metadata": {
240-
"description": "Required. Fqdn that resolves to private endpoint IP address."
240+
"description": "Optional. FQDN that resolves to private endpoint IP address."
241241
}
242242
},
243243
"ipAddresses": {
@@ -838,8 +838,8 @@
838838
"metadata": {
839839
"_generator": {
840840
"name": "bicep",
841-
"version": "0.29.47.4906",
842-
"templateHash": "11258786733278014615"
841+
"version": "0.30.23.60470",
842+
"templateHash": "7176115037834080970"
843843
},
844844
"name": "App Configuration Stores Key Values",
845845
"description": "This module deploys an App Configuration Store Key Value.",
@@ -959,8 +959,8 @@
959959
"metadata": {
960960
"_generator": {
961961
"name": "bicep",
962-
"version": "0.29.47.4906",
963-
"templateHash": "12501157551760596905"
962+
"version": "0.30.23.60470",
963+
"templateHash": "7558745915280433021"
964964
},
965965
"name": "App Configuration Replicas",
966966
"description": "This module deploys an App Configuration Replica.",
@@ -976,13 +976,13 @@
976976
"appConfigurationName": {
977977
"type": "string",
978978
"metadata": {
979-
"description": "Optional. The name of the parent app configuration store."
979+
"description": "Conditional. The name of the parent app configuration store. Required if the template is used in a standalone deployment."
980980
}
981981
},
982982
"replicaLocation": {
983983
"type": "string",
984984
"metadata": {
985-
"description": "Optional. Location of the replica."
985+
"description": "Required. Location of the replica."
986986
}
987987
}
988988
},

avm/res/app-configuration/configuration-store/replicas/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ This module deploys an App Configuration Replica.
2121
| Parameter | Type | Description |
2222
| :-- | :-- | :-- |
2323
| [`name`](#parameter-name) | string | Name of the replica. |
24+
| [`replicaLocation`](#parameter-replicalocation) | string | Location of the replica. |
2425

25-
**Optional parameters**
26+
**Conditional parameters**
2627

2728
| Parameter | Type | Description |
2829
| :-- | :-- | :-- |
29-
| [`appConfigurationName`](#parameter-appconfigurationname) | string | The name of the parent app configuration store. |
30-
| [`replicaLocation`](#parameter-replicalocation) | string | Location of the replica. |
30+
| [`appConfigurationName`](#parameter-appconfigurationname) | string | The name of the parent app configuration store. Required if the template is used in a standalone deployment. |
3131

3232
### Parameter: `name`
3333

@@ -36,16 +36,16 @@ Name of the replica.
3636
- Required: Yes
3737
- Type: string
3838

39-
### Parameter: `appConfigurationName`
39+
### Parameter: `replicaLocation`
4040

41-
The name of the parent app configuration store.
41+
Location of the replica.
4242

4343
- Required: Yes
4444
- Type: string
4545

46-
### Parameter: `replicaLocation`
46+
### Parameter: `appConfigurationName`
4747

48-
Location of the replica.
48+
The name of the parent app configuration store. Required if the template is used in a standalone deployment.
4949

5050
- Required: Yes
5151
- Type: string

avm/res/app-configuration/configuration-store/replicas/main.bicep

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ metadata owner = 'Azure/module-maintainers'
55
@description('Required. Name of the replica.')
66
param name string
77

8-
@description('Optional. The name of the parent app configuration store.')
8+
@description('Conditional. The name of the parent app configuration store. Required if the template is used in a standalone deployment.')
99
param appConfigurationName string
1010

11-
@description('Optional. Location of the replica.')
11+
@description('Required. Location of the replica.')
1212
param replicaLocation string
1313

1414
resource appConfiguration 'Microsoft.AppConfiguration/configurationStores@2023-03-01' existing = {

avm/res/app-configuration/configuration-store/replicas/main.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"metadata": {
55
"_generator": {
66
"name": "bicep",
7-
"version": "0.29.47.4906",
8-
"templateHash": "12501157551760596905"
7+
"version": "0.30.23.60470",
8+
"templateHash": "7558745915280433021"
99
},
1010
"name": "App Configuration Replicas",
1111
"description": "This module deploys an App Configuration Replica.",
@@ -21,13 +21,13 @@
2121
"appConfigurationName": {
2222
"type": "string",
2323
"metadata": {
24-
"description": "Optional. The name of the parent app configuration store."
24+
"description": "Conditional. The name of the parent app configuration store. Required if the template is used in a standalone deployment."
2525
}
2626
},
2727
"replicaLocation": {
2828
"type": "string",
2929
"metadata": {
30-
"description": "Optional. Location of the replica."
30+
"description": "Required. Location of the replica."
3131
}
3232
}
3333
},

0 commit comments

Comments
 (0)