Skip to content

Commit cd5bc7c

Browse files
mswantek68mswantek68
authored
Merge pull request #35 from microsoft/param-desc-updates
Infra - param desc cleanup
2 parents 4b177c2 + 3079653 commit cd5bc7c

2 files changed

Lines changed: 23 additions & 23 deletions

File tree

‎infra/main.bicep‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@ targetScope = 'resourceGroup'
22

33
@minLength(3)
44
@maxLength(12)
5-
@description('The name of the environment/application.')
5+
@description('The name of the environment/application. Use alphanumeric characters only.')
66
param name string
77

8-
@description('Specifies the location for all the Azure resources.')
8+
@description('Specifies the location for all the Azure resources. Defaults to the location of the resource group.')
99
param location string = resourceGroup().location
1010

11-
@description('Specifies the connections to be created for the Azure AI Hub workspace. The connections are used to connect to other Azure resources and services.')
11+
@description('Optional. Specifies the connections to be created for the Azure AI Hub workspace. The connections are used to connect to other Azure resources and services.')
1212
param connections connectionType[] = []
1313

14-
@description('Specifies the OpenAI deployments to create.')
14+
@description('Optional. Specifies the OpenAI deployments to create.')
1515
param aiModelDeployments deploymentsType[] = []
1616

17-
@description('Specifies whether creating the Azure Container Registry.')
17+
@description('Specifies whether creating an Azure Container Registry.')
1818
param acrEnabled bool = false
1919

20-
@description('Specifies the size of the virtual machine.')
20+
@description('Specifies the size of the jump-box Virtual Machine.')
2121
param vmSize string = 'Standard_DS4_v2'
2222

2323
@minLength(3)
@@ -31,7 +31,7 @@ param vmAdminUsername string = '${name}vmuser'
3131
@secure()
3232
param vmAdminPasswordOrKey string
3333

34-
@description('Specifies the resource tags for all the resoources.')
34+
@description('Optional. Specifies the resource tags for all the resoources. Tag "zad-env-name" is automatically added to all resources.')
3535
param tags object = {}
3636

3737
@description('Specifies the object id of a Microsoft Entra ID user. In general, this the object id of the system administrator who deploys the Azure resources. This defaults to the deploying user.')
@@ -46,16 +46,16 @@ param apiManagementPublisherEmail string = 'admin@${name}.com'
4646
@description('Specifies whether network isolation is enabled. When true, Foundry and related components will be deployed, network access parameters will be set to Disabled.')
4747
param networkIsolation bool = true
4848

49-
@description('Whether to include Cosmos DB in the deployment')
49+
@description('Whether to include Cosmos DB in the deployment.')
5050
param cosmosDbEnabled bool = false
5151

52-
@description('Optional list of Cosmos DB databases to deploy')
52+
@description('Optional. List of Cosmos DB databases to deploy.')
5353
param cosmosDatabases sqlDatabaseType[] = []
5454

55-
@description('Whether to include SQL Server in the deployment')
55+
@description('Whether to include SQL Server in the deployment.')
5656
param sqlServerEnabled bool = false
5757

58-
@description('Optional list of SQL Server databases to deploy')
58+
@description('Optional. List of SQL Server databases to deploy.')
5959
param sqlServerDatabases databasePropertyType[] = []
6060

6161
var defaultTags = {

‎infra/main.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"_generator": {
77
"name": "bicep",
88
"version": "0.33.93.31351",
9-
"templateHash": "10384721894949341887"
9+
"templateHash": "3622909770680254042"
1010
}
1111
},
1212
"definitions": {
@@ -1629,14 +1629,14 @@
16291629
"minLength": 3,
16301630
"maxLength": 12,
16311631
"metadata": {
1632-
"description": "The name of the environment/application."
1632+
"description": "The name of the environment/application. Use alphanumeric characters only."
16331633
}
16341634
},
16351635
"location": {
16361636
"type": "string",
16371637
"defaultValue": "[resourceGroup().location]",
16381638
"metadata": {
1639-
"description": "Specifies the location for all the Azure resources."
1639+
"description": "Specifies the location for all the Azure resources. Defaults to the location of the resource group."
16401640
}
16411641
},
16421642
"connections": {
@@ -1646,7 +1646,7 @@
16461646
},
16471647
"defaultValue": [],
16481648
"metadata": {
1649-
"description": "Specifies the connections to be created for the Azure AI Hub workspace. The connections are used to connect to other Azure resources and services."
1649+
"description": "Optional. Specifies the connections to be created for the Azure AI Hub workspace. The connections are used to connect to other Azure resources and services."
16501650
}
16511651
},
16521652
"aiModelDeployments": {
@@ -1656,21 +1656,21 @@
16561656
},
16571657
"defaultValue": [],
16581658
"metadata": {
1659-
"description": "Specifies the OpenAI deployments to create."
1659+
"description": "Optional. Specifies the OpenAI deployments to create."
16601660
}
16611661
},
16621662
"acrEnabled": {
16631663
"type": "bool",
16641664
"defaultValue": false,
16651665
"metadata": {
1666-
"description": "Specifies whether creating the Azure Container Registry."
1666+
"description": "Specifies whether creating an Azure Container Registry."
16671667
}
16681668
},
16691669
"vmSize": {
16701670
"type": "string",
16711671
"defaultValue": "Standard_DS4_v2",
16721672
"metadata": {
1673-
"description": "Specifies the size of the virtual machine."
1673+
"description": "Specifies the size of the jump-box Virtual Machine."
16741674
}
16751675
},
16761676
"vmAdminUsername": {
@@ -1694,7 +1694,7 @@
16941694
"type": "object",
16951695
"defaultValue": {},
16961696
"metadata": {
1697-
"description": "Specifies the resource tags for all the resoources."
1697+
"description": "Optional. Specifies the resource tags for all the resoources. Tag \"zad-env-name\" is automatically added to all resources."
16981698
}
16991699
},
17001700
"userObjectId": {
@@ -1729,7 +1729,7 @@
17291729
"type": "bool",
17301730
"defaultValue": false,
17311731
"metadata": {
1732-
"description": "Whether to include Cosmos DB in the deployment"
1732+
"description": "Whether to include Cosmos DB in the deployment."
17331733
}
17341734
},
17351735
"cosmosDatabases": {
@@ -1739,14 +1739,14 @@
17391739
},
17401740
"defaultValue": [],
17411741
"metadata": {
1742-
"description": "Optional list of Cosmos DB databases to deploy"
1742+
"description": "Optional. List of Cosmos DB databases to deploy."
17431743
}
17441744
},
17451745
"sqlServerEnabled": {
17461746
"type": "bool",
17471747
"defaultValue": false,
17481748
"metadata": {
1749-
"description": "Whether to include SQL Server in the deployment"
1749+
"description": "Whether to include SQL Server in the deployment."
17501750
}
17511751
},
17521752
"sqlServerDatabases": {
@@ -1756,7 +1756,7 @@
17561756
},
17571757
"defaultValue": [],
17581758
"metadata": {
1759-
"description": "Optional list of SQL Server databases to deploy"
1759+
"description": "Optional. List of SQL Server databases to deploy."
17601760
}
17611761
}
17621762
},

0 commit comments

Comments
 (0)