diff --git a/modules/Microsoft.AppConfiguration/configurationStores/readme.md b/modules/Microsoft.AppConfiguration/configurationStores/readme.md index c4171e3ee4..1b2d427f61 100644 --- a/modules/Microsoft.AppConfiguration/configurationStores/readme.md +++ b/modules/Microsoft.AppConfiguration/configurationStores/readme.md @@ -58,6 +58,7 @@ This module deploys an App Configuration Store. | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | + ### Parameter Usage: `tags` Tag names and tag values can be provided as needed. A tag can be left without a value. diff --git a/modules/Microsoft.Automation/automationAccounts/readme.md b/modules/Microsoft.Automation/automationAccounts/readme.md index 4e27eaf6c9..a26473280a 100644 --- a/modules/Microsoft.Automation/automationAccounts/readme.md +++ b/modules/Microsoft.Automation/automationAccounts/readme.md @@ -78,6 +78,7 @@ This module deploys an Azure Automation Account. | `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. | + ### Parameter Usage: `encryption` Prerequisites: diff --git a/modules/Microsoft.Batch/batchAccounts/readme.md b/modules/Microsoft.Batch/batchAccounts/readme.md index d400d363f4..3e3d2d70a2 100644 --- a/modules/Microsoft.Batch/batchAccounts/readme.md +++ b/modules/Microsoft.Batch/batchAccounts/readme.md @@ -64,6 +64,7 @@ | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | + ### Parameter Usage: `tags` Tag names and tag values can be provided as needed. A tag can be left without a value. diff --git a/modules/Microsoft.Cache/redis/readme.md b/modules/Microsoft.Cache/redis/readme.md index 8a21fca10b..b507ac871c 100644 --- a/modules/Microsoft.Cache/redis/readme.md +++ b/modules/Microsoft.Cache/redis/readme.md @@ -63,6 +63,7 @@ This module deploys a Redis Cache service. | `tenantSettings` | object | `{object}` | | A dictionary of tenant settings. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | + ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. diff --git a/modules/Microsoft.CognitiveServices/accounts/readme.md b/modules/Microsoft.CognitiveServices/accounts/readme.md index 7fd9958377..6110ac5793 100644 --- a/modules/Microsoft.CognitiveServices/accounts/readme.md +++ b/modules/Microsoft.CognitiveServices/accounts/readme.md @@ -73,6 +73,7 @@ This module deploys different kinds of cognitive services resources | `tags` | object | `{object}` | | Tags of the resource. | | `userOwnedStorage` | array | `[]` | | The storage accounts for this resource. | + ### Parameter Usage: `privateEndpoints` To use Private Endpoint the following dependencies must be deployed: diff --git a/modules/Microsoft.ContainerInstance/containerGroups/readme.md b/modules/Microsoft.ContainerInstance/containerGroups/readme.md index 2f18d16a88..a2025bb808 100644 --- a/modules/Microsoft.ContainerInstance/containerGroups/readme.md +++ b/modules/Microsoft.ContainerInstance/containerGroups/readme.md @@ -311,7 +311,7 @@ module containerGroups './Microsoft.ContainerInstance/containerGroups/deploy.bic // Required parameters containers: [ { - name: 'jpe-az-aci-x-001' + name: '<>-az-aci-x-001' properties: { command: [] environmentVariables: [] @@ -335,7 +335,7 @@ module containerGroups './Microsoft.ContainerInstance/containerGroups/deploy.bic } } { - name: 'jpe-az-aci-x-002' + name: '<>-az-aci-x-002' properties: { command: [] environmentVariables: [] @@ -355,7 +355,7 @@ module containerGroups './Microsoft.ContainerInstance/containerGroups/deploy.bic } } ] - name: 'jpecicgcom001' + name: '<>cicgcom001' // Non-required parameters enableDefaultTelemetry: '' ipAddressPorts: [ @@ -393,7 +393,7 @@ module containerGroups './Microsoft.ContainerInstance/containerGroups/deploy.bic "containers": { "value": [ { - "name": "jpe-az-aci-x-001", + "name": "<>-az-aci-x-001", "properties": { "command": [], "environmentVariables": [], @@ -417,7 +417,7 @@ module containerGroups './Microsoft.ContainerInstance/containerGroups/deploy.bic } }, { - "name": "jpe-az-aci-x-002", + "name": "<>-az-aci-x-002", "properties": { "command": [], "environmentVariables": [], @@ -439,7 +439,7 @@ module containerGroups './Microsoft.ContainerInstance/containerGroups/deploy.bic ] }, "name": { - "value": "jpecicgcom001" + "value": "<>cicgcom001" }, // Non-required parameters "enableDefaultTelemetry": { diff --git a/modules/Microsoft.ContainerRegistry/registries/readme.md b/modules/Microsoft.ContainerRegistry/registries/readme.md index cc3c4bad6a..d0c3ff817a 100644 --- a/modules/Microsoft.ContainerRegistry/registries/readme.md +++ b/modules/Microsoft.ContainerRegistry/registries/readme.md @@ -80,6 +80,7 @@ Azure Container Registry is a managed, private Docker registry service based on | `webhooks` | _[webhooks](webhooks/readme.md)_ array | `[]` | | All webhooks to create. | | `zoneRedundancy` | string | `'Disabled'` | `[Disabled, Enabled]` | Whether or not zone redundancy is enabled for this container registry. | + ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. diff --git a/modules/Microsoft.DataFactory/factories/readme.md b/modules/Microsoft.DataFactory/factories/readme.md index e9ee9ac78b..e9217c8ddf 100644 --- a/modules/Microsoft.DataFactory/factories/readme.md +++ b/modules/Microsoft.DataFactory/factories/readme.md @@ -71,6 +71,7 @@ | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | + ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. diff --git a/modules/Microsoft.EventGrid/topics/readme.md b/modules/Microsoft.EventGrid/topics/readme.md index 85eaefa089..114b019ac9 100644 --- a/modules/Microsoft.EventGrid/topics/readme.md +++ b/modules/Microsoft.EventGrid/topics/readme.md @@ -50,6 +50,7 @@ This module deploys an event grid topic. | `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. | + ### Parameter Usage: `privateEndpoints` To use Private Endpoint the following dependencies must be deployed: diff --git a/modules/Microsoft.EventHub/namespaces/readme.md b/modules/Microsoft.EventHub/namespaces/readme.md index 27418cac61..4dba17e344 100644 --- a/modules/Microsoft.EventHub/namespaces/readme.md +++ b/modules/Microsoft.EventHub/namespaces/readme.md @@ -65,6 +65,7 @@ This module deploys an event hub namespace. | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | | `zoneRedundant` | bool | `False` | | Switch to make the Event Hub Namespace zone redundant. | + ### Parameter Usage: `privateEndpoints` To use Private Endpoint the following dependencies must be deployed: diff --git a/modules/Microsoft.Insights/privateLinkScopes/readme.md b/modules/Microsoft.Insights/privateLinkScopes/readme.md index c53d0eec7e..e6944e4d3a 100644 --- a/modules/Microsoft.Insights/privateLinkScopes/readme.md +++ b/modules/Microsoft.Insights/privateLinkScopes/readme.md @@ -41,6 +41,7 @@ This module deploys an Azure Monitor Private Link Scope. | `scopedResources` | _[scopedResources](scopedResources/readme.md)_ array | `[]` | | Configuration details for Azure Monitor Resources. | | `tags` | object | `{object}` | | Resource tags. | + ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. diff --git a/modules/Microsoft.KeyVault/vaults/readme.md b/modules/Microsoft.KeyVault/vaults/readme.md index e29434491b..d2bdbf95ad 100644 --- a/modules/Microsoft.KeyVault/vaults/readme.md +++ b/modules/Microsoft.KeyVault/vaults/readme.md @@ -65,6 +65,7 @@ This module deploys a key vault and its child resources. | `tags` | object | `{object}` | | Resource tags. | | `vaultSku` | string | `'premium'` | `[premium, standard]` | Specifies the SKU for the vault. | + ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. diff --git a/modules/Microsoft.RecoveryServices/vaults/readme.md b/modules/Microsoft.RecoveryServices/vaults/readme.md index 660c739c83..87bdb94898 100644 --- a/modules/Microsoft.RecoveryServices/vaults/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/readme.md @@ -69,6 +69,7 @@ This module deploys a recovery service vault. | `tags` | object | `{object}` | | Tags of the Recovery Service Vault resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | + ### Parameter Usage: `backupStorageConfig`
diff --git a/modules/Microsoft.ServiceBus/namespaces/readme.md b/modules/Microsoft.ServiceBus/namespaces/readme.md index ed7da1fcbe..8f710c6b03 100644 --- a/modules/Microsoft.ServiceBus/namespaces/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/readme.md @@ -76,6 +76,7 @@ This module deploys a service bus namespace resource. | `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. | + ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. diff --git a/modules/Microsoft.SignalRService/webPubSub/readme.md b/modules/Microsoft.SignalRService/webPubSub/readme.md index f992dbe631..2ea995aaa2 100644 --- a/modules/Microsoft.SignalRService/webPubSub/readme.md +++ b/modules/Microsoft.SignalRService/webPubSub/readme.md @@ -49,6 +49,7 @@ This module deploys a Web PubSub Service resource. | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | + ### Parameter Usage: `privateEndpoints` To use Private Endpoint the following dependencies must be deployed: diff --git a/modules/Microsoft.Sql/servers/readme.md b/modules/Microsoft.Sql/servers/readme.md index 210af89f97..52a49ab27b 100644 --- a/modules/Microsoft.Sql/servers/readme.md +++ b/modules/Microsoft.Sql/servers/readme.md @@ -67,6 +67,7 @@ This module deploys a SQL server. | `virtualNetworkRules` | _[virtualNetworkRules](virtualNetworkRules/readme.md)_ array | `[]` | | The virtual network rules to create in the server. | | `vulnerabilityAssessmentsObj` | _[vulnerabilityAssessments](vulnerabilityAssessments/readme.md)_ object | `{object}` | | The vulnerability assessment configuration. | + ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. diff --git a/modules/Microsoft.Storage/storageAccounts/readme.md b/modules/Microsoft.Storage/storageAccounts/readme.md index 7a9d43f9ff..d7b1e917af 100644 --- a/modules/Microsoft.Storage/storageAccounts/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/readme.md @@ -85,6 +85,7 @@ This module is used to deploy a storage account, with the ability to deploy 1 or | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | + ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. diff --git a/modules/Microsoft.Synapse/privateLinkHubs/readme.md b/modules/Microsoft.Synapse/privateLinkHubs/readme.md index beb7ed693f..38db5bc6e2 100644 --- a/modules/Microsoft.Synapse/privateLinkHubs/readme.md +++ b/modules/Microsoft.Synapse/privateLinkHubs/readme.md @@ -39,6 +39,7 @@ This module deploys Azure Synapse Analytics (private link hubs). | `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. | + ### Parameter Usage: `privateEndpoints` To use Private Endpoint the following dependencies must be deployed: diff --git a/modules/Microsoft.Synapse/workspaces/readme.md b/modules/Microsoft.Synapse/workspaces/readme.md index 312b5c862b..e9255c1d02 100644 --- a/modules/Microsoft.Synapse/workspaces/readme.md +++ b/modules/Microsoft.Synapse/workspaces/readme.md @@ -75,6 +75,7 @@ This module deploys a Synapse Workspace. | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | + ### Parameter Usage: `privateEndpoints` To use Private Endpoint the following dependencies must be deployed: diff --git a/modules/Microsoft.Web/sites/readme.md b/modules/Microsoft.Web/sites/readme.md index f9808817c8..490fe059df 100644 --- a/modules/Microsoft.Web/sites/readme.md +++ b/modules/Microsoft.Web/sites/readme.md @@ -65,6 +65,7 @@ This module deploys a web or function app. | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | | `virtualNetworkSubnetId` | string | `''` | | Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. | + ### Parameter Usage: `appSettingsKeyValuePairs` AzureWebJobsStorage, AzureWebJobsDashboard, APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING are set separately (check parameters storageAccountId, setAzureWebJobsDashboard, appInsightId). diff --git a/utilities/src/apiSpecsList.json b/utilities/src/apiSpecsList.json index 29b36e43d4..c8079cddd2 100644 --- a/utilities/src/apiSpecsList.json +++ b/utilities/src/apiSpecsList.json @@ -2046,7 +2046,7 @@ ] }, "Microsoft.Cdn": { - "CdnWebApplicationFirewallPolicies": [ + "cdnWebApplicationFirewallPolicies": [ "2019-06-15", "2019-06-15-preview", "2020-03-31", @@ -3882,7 +3882,7 @@ "2018-06-01-privatepreview" ] }, - "Microsoft.DBforMySQL": { + "Microsoft.DBForMySql": { "flexibleServers": [ "2020-07-01-preview", "2020-07-01-privatepreview", @@ -3919,7 +3919,7 @@ "2017-12-01-preview", "2018-06-01-privatepreview" ], - "servers/Administrators": [ + "servers/administrators": [ "2017-12-01", "2017-12-01-preview", "2018-06-01-privatepreview" @@ -6040,7 +6040,7 @@ "2016-05-01" ] }, - "microsoft.insights": { + "Microsoft.Insights": { "actionGroups": [ "2017-04-01", "2018-03-01", @@ -7966,7 +7966,7 @@ "2020-04-01-preview", "2022-07-01" ], - "dnszones": [ + "dnsZones": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -7974,7 +7974,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/A": [ + "dnsZones/A": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -7982,7 +7982,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/AAAA": [ + "dnsZones/AAAA": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -7996,7 +7996,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/CNAME": [ + "dnsZones/CNAME": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -8004,7 +8004,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/MX": [ + "dnsZones/MX": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -8012,7 +8012,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/NS": [ + "dnsZones/NS": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -8020,7 +8020,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/PTR": [ + "dnsZones/PTR": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -8028,7 +8028,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/SOA": [ + "dnsZones/SOA": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -8036,7 +8036,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/SRV": [ + "dnsZones/SRV": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -8044,7 +8044,7 @@ "2018-03-01-preview", "2018-05-01" ], - "dnszones/TXT": [ + "dnsZones/TXT": [ "2015-05-04-preview", "2016-04-01", "2017-09-01", @@ -11218,17 +11218,17 @@ "2018-01-01-preview", "2021-11-01" ], - "namespaces/authorizationRules": [ + "namespaces/AuthorizationRules": [ "2016-07-01", "2017-04-01", "2021-11-01" ], - "namespaces/hybridConnections": [ + "namespaces/HybridConnections": [ "2016-07-01", "2017-04-01", "2021-11-01" ], - "namespaces/hybridConnections/authorizationRules": [ + "namespaces/HybridConnections/authorizationRules": [ "2016-07-01", "2017-04-01", "2021-11-01" @@ -11241,12 +11241,12 @@ "2018-01-01-preview", "2021-11-01" ], - "namespaces/wcfRelays": [ + "namespaces/WcfRelays": [ "2016-07-01", "2017-04-01", "2021-11-01" ], - "namespaces/wcfRelays/authorizationRules": [ + "namespaces/WcfRelays/authorizationRules": [ "2016-07-01", "2017-04-01", "2021-11-01"