From bd46303b2192b61dd0c19979fcc7e304223728b6 Mon Sep 17 00:00:00 2001 From: Ahmad Abdalla <28486158+ahmadabdalla@users.noreply.github.com> Date: Thu, 22 Sep 2022 23:46:46 +0000 Subject: [PATCH 1/2] updated documentation --- .../roleDefinitions/managementGroup/readme.md | 2 ++ modules/Microsoft.Authorization/roleDefinitions/readme.md | 2 ++ .../roleDefinitions/resourceGroup/readme.md | 2 ++ .../roleDefinitions/subscription/readme.md | 2 ++ 4 files changed, 8 insertions(+) diff --git a/modules/Microsoft.Authorization/roleDefinitions/managementGroup/readme.md b/modules/Microsoft.Authorization/roleDefinitions/managementGroup/readme.md index 3fe9fd2d51..84a426e28b 100644 --- a/modules/Microsoft.Authorization/roleDefinitions/managementGroup/readme.md +++ b/modules/Microsoft.Authorization/roleDefinitions/managementGroup/readme.md @@ -18,11 +18,13 @@ With this module you can create role definitions on a management group level ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `roleName` | string | Name of the custom RBAC role to be created. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | List of allowed actions. | diff --git a/modules/Microsoft.Authorization/roleDefinitions/readme.md b/modules/Microsoft.Authorization/roleDefinitions/readme.md index 8104220f46..33cda82bf6 100644 --- a/modules/Microsoft.Authorization/roleDefinitions/readme.md +++ b/modules/Microsoft.Authorization/roleDefinitions/readme.md @@ -21,11 +21,13 @@ This module deploys custom RBAC Role Definitions across the management group, su ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `roleName` | string | Name of the custom RBAC role to be created. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | List of allowed actions. | diff --git a/modules/Microsoft.Authorization/roleDefinitions/resourceGroup/readme.md b/modules/Microsoft.Authorization/roleDefinitions/resourceGroup/readme.md index f761762d86..601e1fcb9c 100644 --- a/modules/Microsoft.Authorization/roleDefinitions/resourceGroup/readme.md +++ b/modules/Microsoft.Authorization/roleDefinitions/resourceGroup/readme.md @@ -18,11 +18,13 @@ With this module you can create role definitions on a resource group level ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `roleName` | string | Name of the custom RBAC role to be created. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | List of allowed actions. | diff --git a/modules/Microsoft.Authorization/roleDefinitions/subscription/readme.md b/modules/Microsoft.Authorization/roleDefinitions/subscription/readme.md index 35da0c7a9d..d9722fa89c 100644 --- a/modules/Microsoft.Authorization/roleDefinitions/subscription/readme.md +++ b/modules/Microsoft.Authorization/roleDefinitions/subscription/readme.md @@ -18,11 +18,13 @@ With this module you can create role definitions on a subscription level ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `roleName` | string | Name of the custom RBAC role to be created. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | List of allowed actions. | From 6d56e70a8166ab18fd80dcf09f88d015d79ced4d Mon Sep 17 00:00:00 2001 From: Ahmad Abdalla <28486158+ahmadabdalla@users.noreply.github.com> Date: Sat, 24 Sep 2022 13:30:53 +0000 Subject: [PATCH 2/2] Updated readme files for all modules --- modules/Microsoft.AAD/DomainServices/readme.md | 3 +++ modules/Microsoft.AnalysisServices/servers/readme.md | 2 ++ .../Microsoft.ApiManagement/service/apiVersionSets/readme.md | 2 ++ .../Microsoft.ApiManagement/service/apis/policies/readme.md | 3 +++ modules/Microsoft.ApiManagement/service/apis/readme.md | 3 +++ .../service/authorizationServers/readme.md | 3 +++ modules/Microsoft.ApiManagement/service/backends/readme.md | 3 +++ modules/Microsoft.ApiManagement/service/caches/readme.md | 3 +++ .../service/identityProviders/readme.md | 3 +++ modules/Microsoft.ApiManagement/service/namedValues/readme.md | 3 +++ modules/Microsoft.ApiManagement/service/policies/readme.md | 3 +++ .../Microsoft.ApiManagement/service/portalsettings/readme.md | 3 +++ .../Microsoft.ApiManagement/service/products/apis/readme.md | 3 +++ .../Microsoft.ApiManagement/service/products/groups/readme.md | 3 +++ modules/Microsoft.ApiManagement/service/products/readme.md | 3 +++ modules/Microsoft.ApiManagement/service/readme.md | 2 ++ .../Microsoft.ApiManagement/service/subscriptions/readme.md | 3 +++ .../configurationStores/keyValues/readme.md | 3 +++ .../Microsoft.AppConfiguration/configurationStores/readme.md | 2 ++ modules/Microsoft.Authorization/locks/readme.md | 2 ++ modules/Microsoft.Authorization/locks/resourceGroup/readme.md | 2 ++ modules/Microsoft.Authorization/locks/subscription/readme.md | 2 ++ .../policyAssignments/managementGroup/readme.md | 2 ++ modules/Microsoft.Authorization/policyAssignments/readme.md | 2 ++ .../policyAssignments/resourceGroup/readme.md | 2 ++ .../policyAssignments/subscription/readme.md | 2 ++ .../policyDefinitions/managementGroup/readme.md | 2 ++ modules/Microsoft.Authorization/policyDefinitions/readme.md | 2 ++ .../policyDefinitions/subscription/readme.md | 2 ++ .../policyExemptions/managementGroup/readme.md | 2 ++ modules/Microsoft.Authorization/policyExemptions/readme.md | 2 ++ .../policyExemptions/resourceGroup/readme.md | 2 ++ .../policyExemptions/subscription/readme.md | 2 ++ .../policySetDefinitions/managementGroup/readme.md | 2 ++ .../Microsoft.Authorization/policySetDefinitions/readme.md | 2 ++ .../policySetDefinitions/subscription/readme.md | 2 ++ .../roleAssignments/managementGroup/readme.md | 2 ++ modules/Microsoft.Authorization/roleAssignments/readme.md | 2 ++ .../roleAssignments/resourceGroup/readme.md | 2 ++ .../roleAssignments/subscription/readme.md | 2 ++ .../automationAccounts/jobSchedules/readme.md | 4 ++++ .../Microsoft.Automation/automationAccounts/modules/readme.md | 3 +++ modules/Microsoft.Automation/automationAccounts/readme.md | 2 ++ .../automationAccounts/runbooks/readme.md | 4 ++++ .../automationAccounts/schedules/readme.md | 4 ++++ .../automationAccounts/softwareUpdateConfigurations/readme.md | 4 ++++ .../automationAccounts/variables/readme.md | 3 +++ modules/Microsoft.Batch/batchAccounts/readme.md | 3 +++ modules/Microsoft.Cache/redis/readme.md | 2 ++ modules/Microsoft.CognitiveServices/accounts/readme.md | 3 +++ modules/Microsoft.Compute/availabilitySets/readme.md | 2 ++ modules/Microsoft.Compute/diskEncryptionSets/readme.md | 2 ++ modules/Microsoft.Compute/disks/readme.md | 2 ++ modules/Microsoft.Compute/galleries/images/readme.md | 3 +++ modules/Microsoft.Compute/galleries/readme.md | 2 ++ modules/Microsoft.Compute/images/readme.md | 2 ++ modules/Microsoft.Compute/proximityPlacementGroups/readme.md | 2 ++ .../virtualMachineScaleSets/extensions/readme.md | 3 +++ modules/Microsoft.Compute/virtualMachineScaleSets/readme.md | 3 +++ .../Microsoft.Compute/virtualMachines/extensions/readme.md | 3 +++ modules/Microsoft.Compute/virtualMachines/readme.md | 3 +++ modules/Microsoft.Consumption/budgets/readme.md | 2 ++ modules/Microsoft.ContainerInstance/containerGroups/readme.md | 2 ++ modules/Microsoft.ContainerRegistry/registries/readme.md | 3 +++ .../registries/replications/readme.md | 3 +++ .../Microsoft.ContainerRegistry/registries/webhooks/readme.md | 3 +++ .../managedClusters/agentPools/readme.md | 3 +++ modules/Microsoft.ContainerService/managedClusters/readme.md | 3 +++ .../flexibleServers/configurations/readme.md | 3 +++ .../flexibleServers/databases/readme.md | 3 +++ .../flexibleServers/firewallRules/readme.md | 3 +++ modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md | 2 ++ .../factories/integrationRuntimes/readme.md | 3 +++ .../managedVirtualNetworks/managedPrivateEndpoints/readme.md | 3 +++ .../factories/managedVirtualNetworks/readme.md | 3 +++ modules/Microsoft.DataFactory/factories/readme.md | 2 ++ .../backupVaults/backupPolicies/readme.md | 2 ++ modules/Microsoft.DataProtection/backupVaults/readme.md | 2 ++ modules/Microsoft.Databricks/workspaces/readme.md | 2 ++ .../applicationgroups/applications/readme.md | 3 +++ .../applicationgroups/readme.md | 2 ++ modules/Microsoft.DesktopVirtualization/hostpools/readme.md | 3 +++ .../Microsoft.DesktopVirtualization/scalingplans/readme.md | 2 ++ modules/Microsoft.DesktopVirtualization/workspaces/readme.md | 2 ++ .../databaseAccounts/gremlinDatabases/graphs/readme.md | 3 +++ .../databaseAccounts/gremlinDatabases/readme.md | 3 +++ .../databaseAccounts/mongodbDatabases/collections/readme.md | 3 +++ .../databaseAccounts/mongodbDatabases/readme.md | 3 +++ modules/Microsoft.DocumentDB/databaseAccounts/readme.md | 2 ++ .../databaseAccounts/sqlDatabases/containers/readme.md | 3 +++ .../databaseAccounts/sqlDatabases/readme.md | 3 +++ modules/Microsoft.EventGrid/systemTopics/readme.md | 2 ++ modules/Microsoft.EventGrid/topics/readme.md | 2 ++ .../namespaces/authorizationRules/readme.md | 3 +++ .../namespaces/disasterRecoveryConfigs/readme.md | 3 +++ .../namespaces/eventhubs/authorizationRules/readme.md | 3 +++ .../namespaces/eventhubs/consumergroups/readme.md | 3 +++ modules/Microsoft.EventHub/namespaces/eventhubs/readme.md | 3 +++ .../Microsoft.EventHub/namespaces/networkRuleSets/readme.md | 2 ++ modules/Microsoft.EventHub/namespaces/readme.md | 1 + modules/Microsoft.HealthBot/healthBots/readme.md | 2 ++ modules/Microsoft.Insights/actionGroups/readme.md | 2 ++ modules/Microsoft.Insights/activityLogAlerts/readme.md | 2 ++ modules/Microsoft.Insights/components/readme.md | 2 ++ modules/Microsoft.Insights/diagnosticSettings/readme.md | 1 + modules/Microsoft.Insights/metricAlerts/readme.md | 3 +++ modules/Microsoft.Insights/privateLinkScopes/readme.md | 2 ++ .../privateLinkScopes/scopedResources/readme.md | 3 +++ modules/Microsoft.Insights/scheduledQueryRules/readme.md | 2 ++ modules/Microsoft.KeyVault/vaults/accessPolicies/readme.md | 2 ++ modules/Microsoft.KeyVault/vaults/keys/readme.md | 3 +++ modules/Microsoft.KeyVault/vaults/readme.md | 2 ++ modules/Microsoft.KeyVault/vaults/secrets/readme.md | 3 +++ .../Microsoft.KubernetesConfiguration/extensions/readme.md | 2 ++ .../fluxConfigurations/readme.md | 2 ++ modules/Microsoft.Logic/workflows/readme.md | 2 ++ .../workspaces/computes/readme.md | 3 +++ .../Microsoft.MachineLearningServices/workspaces/readme.md | 3 +++ .../userAssignedIdentities/readme.md | 1 + .../registrationDefinitions/readme.md | 2 ++ modules/Microsoft.Management/managementGroups/readme.md | 2 ++ .../Microsoft.NetApp/netAppAccounts/capacityPools/readme.md | 3 +++ .../netAppAccounts/capacityPools/volumes/readme.md | 3 +++ modules/Microsoft.NetApp/netAppAccounts/readme.md | 2 ++ modules/Microsoft.Network/applicationGateways/readme.md | 2 ++ modules/Microsoft.Network/applicationSecurityGroups/readme.md | 2 ++ modules/Microsoft.Network/azureFirewalls/readme.md | 2 ++ modules/Microsoft.Network/bastionHosts/readme.md | 2 ++ modules/Microsoft.Network/connections/readme.md | 2 ++ modules/Microsoft.Network/ddosProtectionPlans/readme.md | 2 ++ modules/Microsoft.Network/expressRouteCircuits/readme.md | 2 ++ modules/Microsoft.Network/firewallPolicies/readme.md | 2 ++ .../firewallPolicies/ruleCollectionGroups/readme.md | 3 +++ modules/Microsoft.Network/frontDoors/readme.md | 2 ++ modules/Microsoft.Network/ipGroups/readme.md | 2 ++ .../loadBalancers/backendAddressPools/readme.md | 3 +++ .../Microsoft.Network/loadBalancers/inboundNatRules/readme.md | 3 +++ modules/Microsoft.Network/loadBalancers/readme.md | 2 ++ modules/Microsoft.Network/localNetworkGateways/readme.md | 2 ++ modules/Microsoft.Network/natGateways/readme.md | 2 ++ modules/Microsoft.Network/networkInterfaces/readme.md | 2 ++ modules/Microsoft.Network/networkSecurityGroups/readme.md | 2 ++ .../networkSecurityGroups/securityRules/readme.md | 3 +++ .../networkWatchers/connectionMonitors/readme.md | 2 ++ modules/Microsoft.Network/networkWatchers/flowLogs/readme.md | 2 ++ modules/Microsoft.Network/networkWatchers/readme.md | 1 + modules/Microsoft.Network/privateDnsZones/A/readme.md | 3 +++ modules/Microsoft.Network/privateDnsZones/AAAA/readme.md | 3 +++ modules/Microsoft.Network/privateDnsZones/CNAME/readme.md | 3 +++ modules/Microsoft.Network/privateDnsZones/MX/readme.md | 3 +++ modules/Microsoft.Network/privateDnsZones/PTR/readme.md | 3 +++ modules/Microsoft.Network/privateDnsZones/SOA/readme.md | 3 +++ modules/Microsoft.Network/privateDnsZones/SRV/readme.md | 3 +++ modules/Microsoft.Network/privateDnsZones/TXT/readme.md | 3 +++ modules/Microsoft.Network/privateDnsZones/readme.md | 2 ++ .../privateDnsZones/virtualNetworkLinks/readme.md | 3 +++ .../privateEndpoints/privateDnsZoneGroups/readme.md | 3 +++ modules/Microsoft.Network/privateEndpoints/readme.md | 2 ++ modules/Microsoft.Network/privateLinkServices/readme.md | 2 ++ modules/Microsoft.Network/publicIPAddresses/readme.md | 2 ++ modules/Microsoft.Network/publicIPPrefixes/readme.md | 2 ++ modules/Microsoft.Network/routeTables/readme.md | 2 ++ modules/Microsoft.Network/trafficmanagerprofiles/readme.md | 2 ++ .../Microsoft.Network/virtualHubs/hubRouteTables/readme.md | 3 +++ .../virtualHubs/hubVirtualNetworkConnections/readme.md | 3 +++ modules/Microsoft.Network/virtualHubs/readme.md | 2 ++ modules/Microsoft.Network/virtualNetworkGateways/readme.md | 2 ++ modules/Microsoft.Network/virtualNetworks/readme.md | 2 ++ modules/Microsoft.Network/virtualNetworks/subnets/readme.md | 3 +++ .../virtualNetworks/virtualNetworkPeerings/readme.md | 3 +++ modules/Microsoft.Network/virtualWans/readme.md | 2 ++ modules/Microsoft.Network/vpnGateways/connections/readme.md | 3 +++ modules/Microsoft.Network/vpnGateways/natRules/readme.md | 3 +++ modules/Microsoft.Network/vpnGateways/readme.md | 2 ++ modules/Microsoft.Network/vpnSites/readme.md | 2 ++ .../workspaces/dataSources/readme.md | 3 +++ .../workspaces/linkedServices/readme.md | 3 +++ .../workspaces/linkedStorageAccounts/readme.md | 3 +++ modules/Microsoft.OperationalInsights/workspaces/readme.md | 3 +++ .../workspaces/savedSearches/readme.md | 3 +++ .../workspaces/storageInsightConfigs/readme.md | 3 +++ modules/Microsoft.OperationsManagement/solutions/readme.md | 2 ++ modules/Microsoft.PowerBIDedicated/capacities/readme.md | 2 ++ .../Microsoft.RecoveryServices/vaults/backupConfig/readme.md | 2 ++ .../vaults/backupPolicies/readme.md | 3 +++ .../vaults/backupStorageConfig/readme.md | 2 ++ .../vaults/protectionContainers/protectedItems/readme.md | 3 +++ .../vaults/protectionContainers/readme.md | 3 +++ modules/Microsoft.RecoveryServices/vaults/readme.md | 2 ++ .../vaults/replicationFabrics/readme.md | 3 +++ .../replicationProtectionContainers/readme.md | 3 +++ .../replicationProtectionContainerMappings/readme.md | 2 ++ .../vaults/replicationPolicies/readme.md | 3 +++ modules/Microsoft.Resources/deploymentScripts/readme.md | 3 +++ modules/Microsoft.Resources/resourceGroups/readme.md | 2 ++ modules/Microsoft.Resources/tags/readme.md | 1 + modules/Microsoft.Resources/tags/resourceGroups/readme.md | 1 + modules/Microsoft.Resources/tags/subscriptions/readme.md | 1 + modules/Microsoft.Security/azureSecurityCenter/readme.md | 2 ++ .../namespaces/authorizationRules/readme.md | 3 +++ .../namespaces/disasterRecoveryConfigs/readme.md | 2 ++ .../namespaces/migrationConfigurations/readme.md | 3 +++ .../Microsoft.ServiceBus/namespaces/networkRuleSets/readme.md | 2 ++ .../namespaces/queues/authorizationRules/readme.md | 3 +++ modules/Microsoft.ServiceBus/namespaces/queues/readme.md | 3 +++ modules/Microsoft.ServiceBus/namespaces/readme.md | 2 ++ .../namespaces/topics/authorizationRules/readme.md | 3 +++ modules/Microsoft.ServiceBus/namespaces/topics/readme.md | 3 +++ .../clusters/applicationTypes/readme.md | 2 ++ modules/Microsoft.ServiceFabric/clusters/readme.md | 2 ++ modules/Microsoft.SignalRService/webPubSub/readme.md | 2 ++ .../Microsoft.Sql/managedInstances/administrators/readme.md | 3 +++ .../databases/backupLongTermRetentionPolicies/readme.md | 3 +++ .../databases/backupShortTermRetentionPolicies/readme.md | 3 +++ modules/Microsoft.Sql/managedInstances/databases/readme.md | 3 +++ .../managedInstances/encryptionProtector/readme.md | 3 +++ modules/Microsoft.Sql/managedInstances/keys/readme.md | 3 +++ modules/Microsoft.Sql/managedInstances/readme.md | 3 +++ .../managedInstances/securityAlertPolicies/readme.md | 3 +++ .../managedInstances/vulnerabilityAssessments/readme.md | 3 +++ modules/Microsoft.Sql/servers/databases/readme.md | 3 +++ modules/Microsoft.Sql/servers/firewallRules/readme.md | 3 +++ modules/Microsoft.Sql/servers/readme.md | 3 +++ modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md | 3 +++ modules/Microsoft.Sql/servers/virtualNetworkRules/readme.md | 3 +++ .../Microsoft.Sql/servers/vulnerabilityAssessments/readme.md | 2 ++ .../blobServices/containers/immutabilityPolicies/readme.md | 2 ++ .../storageAccounts/blobServices/containers/readme.md | 3 +++ .../Microsoft.Storage/storageAccounts/blobServices/readme.md | 2 ++ .../Microsoft.Storage/storageAccounts/fileServices/readme.md | 2 ++ .../storageAccounts/fileServices/shares/readme.md | 3 +++ .../storageAccounts/managementPolicies/readme.md | 3 +++ .../storageAccounts/queueServices/queues/readme.md | 3 +++ .../Microsoft.Storage/storageAccounts/queueServices/readme.md | 2 ++ modules/Microsoft.Storage/storageAccounts/readme.md | 3 +++ .../Microsoft.Storage/storageAccounts/tableServices/readme.md | 2 ++ .../storageAccounts/tableServices/tables/readme.md | 3 +++ modules/Microsoft.Synapse/privateLinkHubs/readme.md | 2 ++ modules/Microsoft.Synapse/workspaces/keys/readme.md | 3 +++ .../Microsoft.VirtualMachineImages/imageTemplates/readme.md | 3 +++ modules/Microsoft.Web/connections/readme.md | 2 ++ modules/Microsoft.Web/hostingEnvironments/readme.md | 2 ++ modules/Microsoft.Web/serverfarms/readme.md | 2 ++ modules/Microsoft.Web/sites/config-appsettings/readme.md | 3 +++ modules/Microsoft.Web/sites/config-authsettingsv2/readme.md | 3 +++ modules/Microsoft.Web/sites/readme.md | 2 ++ modules/Microsoft.Web/staticSites/readme.md | 2 ++ utilities/pipelines/staticValidation/module.tests.ps1 | 2 +- 248 files changed, 615 insertions(+), 1 deletion(-) diff --git a/modules/Microsoft.AAD/DomainServices/readme.md b/modules/Microsoft.AAD/DomainServices/readme.md index 45a51b9a13..676911ccf2 100644 --- a/modules/Microsoft.AAD/DomainServices/readme.md +++ b/modules/Microsoft.AAD/DomainServices/readme.md @@ -23,17 +23,20 @@ This template deploys Azure Active Directory Domain Services (AADDS). ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `domainName` | string | The domain name specific to the Azure ADDS service. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `pfxCertificate` | string | `''` | The certificate required to configure Secure LDAP. Should be a base64encoded representation of the certificate PFX file. Required if secure LDAP is enabled and must be valid more than 30 days. | | `pfxCertificatePassword` | secureString | `''` | The password to decrypt the provided Secure LDAP certificate PFX file. Required if secure LDAP is enabled. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `additionalRecipients` | array | `[]` | | The email recipient value to receive alerts. | diff --git a/modules/Microsoft.AnalysisServices/servers/readme.md b/modules/Microsoft.AnalysisServices/servers/readme.md index 92765a4a4c..981e5dc0ab 100644 --- a/modules/Microsoft.AnalysisServices/servers/readme.md +++ b/modules/Microsoft.AnalysisServices/servers/readme.md @@ -22,11 +22,13 @@ This module deploys an Analysis Services Server. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Azure Analysis Services server to create. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.ApiManagement/service/apiVersionSets/readme.md b/modules/Microsoft.ApiManagement/service/apiVersionSets/readme.md index e4e307bcac..2809751dcb 100644 --- a/modules/Microsoft.ApiManagement/service/apiVersionSets/readme.md +++ b/modules/Microsoft.ApiManagement/service/apiVersionSets/readme.md @@ -18,11 +18,13 @@ This module deploys API Management Service APIs Version Set. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ApiManagement/service/apis/policies/readme.md b/modules/Microsoft.ApiManagement/service/apis/policies/readme.md index 54683b2fca..a96a697738 100644 --- a/modules/Microsoft.ApiManagement/service/apis/policies/readme.md +++ b/modules/Microsoft.ApiManagement/service/apis/policies/readme.md @@ -18,17 +18,20 @@ This module deploys API Management Service APIs policies. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `value` | string | Contents of the Policy as defined by the format. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | | `apiName` | string | The name of the parent API. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ApiManagement/service/apis/readme.md b/modules/Microsoft.ApiManagement/service/apis/readme.md index a579195d3a..b22261e69b 100644 --- a/modules/Microsoft.ApiManagement/service/apis/readme.md +++ b/modules/Microsoft.ApiManagement/service/apis/readme.md @@ -19,6 +19,7 @@ This module deploys API Management Service APIs. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `displayName` | string | API name. Must be 1 to 300 characters long. | @@ -26,11 +27,13 @@ This module deploys API Management Service APIs. | `path` | string | Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `apiDescription` | string | `''` | | Description of the API. May include HTML formatting tags. | diff --git a/modules/Microsoft.ApiManagement/service/authorizationServers/readme.md b/modules/Microsoft.ApiManagement/service/authorizationServers/readme.md index 31b4c90241..f5858c4bcb 100644 --- a/modules/Microsoft.ApiManagement/service/authorizationServers/readme.md +++ b/modules/Microsoft.ApiManagement/service/authorizationServers/readme.md @@ -24,6 +24,7 @@ The following resources are required to be able to deploy this resource. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `authorizationEndpoint` | string | OAuth authorization endpoint. See . | @@ -33,11 +34,13 @@ The following resources are required to be able to deploy this resource. | `name` | string | Identifier of the authorization server. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `authorizationMethods` | array | `[GET]` | HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. - HEAD, OPTIONS, TRACE, GET, POST, PUT, PATCH, DELETE. | diff --git a/modules/Microsoft.ApiManagement/service/backends/readme.md b/modules/Microsoft.ApiManagement/service/backends/readme.md index 82877f3bda..2b8c9de815 100644 --- a/modules/Microsoft.ApiManagement/service/backends/readme.md +++ b/modules/Microsoft.ApiManagement/service/backends/readme.md @@ -24,17 +24,20 @@ The following resources are required to be able to deploy this resource. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Backend Name. | | `url` | string | Runtime URL of the Backend. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `backendDescription` | string | `''` | Backend Description. | diff --git a/modules/Microsoft.ApiManagement/service/caches/readme.md b/modules/Microsoft.ApiManagement/service/caches/readme.md index 2074610745..c2ee34121f 100644 --- a/modules/Microsoft.ApiManagement/service/caches/readme.md +++ b/modules/Microsoft.ApiManagement/service/caches/readme.md @@ -18,6 +18,7 @@ This module deploys an API Management Service Cache. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `connectionString` | string | Runtime connection string to cache. Can be referenced by a named value like so, {{}}. | @@ -25,11 +26,13 @@ This module deploys an API Management Service Cache. | `useFromLocation` | string | Location identifier to use cache from (should be either 'default' or valid Azure region identifier). | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `cacheDescription` | string | `''` | Cache description. | diff --git a/modules/Microsoft.ApiManagement/service/identityProviders/readme.md b/modules/Microsoft.ApiManagement/service/identityProviders/readme.md index b59df8ff20..7e1ede0ad2 100644 --- a/modules/Microsoft.ApiManagement/service/identityProviders/readme.md +++ b/modules/Microsoft.ApiManagement/service/identityProviders/readme.md @@ -18,11 +18,13 @@ This module deploys API Management Service Identity Provider. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Identity provider name. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `apiManagementServiceName` | string | | The name of the parent API Management service. Required if the template is used in a standalone deployment. | @@ -30,6 +32,7 @@ This module deploys API Management Service Identity Provider. | `identityProviderClientSecret` | secureString | `''` | Client secret of the Application in external Identity Provider, used to authenticate login request. Required if identity provider is used. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ApiManagement/service/namedValues/readme.md b/modules/Microsoft.ApiManagement/service/namedValues/readme.md index 378e0c06fb..8f5d349a70 100644 --- a/modules/Microsoft.ApiManagement/service/namedValues/readme.md +++ b/modules/Microsoft.ApiManagement/service/namedValues/readme.md @@ -18,17 +18,20 @@ This module deploys API Management Service Named Values. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `displayName` | string | Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. | | `name` | string | Named value Name. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `apiManagementServiceName` | string | `''` | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ApiManagement/service/policies/readme.md b/modules/Microsoft.ApiManagement/service/policies/readme.md index ba3dffde13..2616e5e1c0 100644 --- a/modules/Microsoft.ApiManagement/service/policies/readme.md +++ b/modules/Microsoft.ApiManagement/service/policies/readme.md @@ -18,16 +18,19 @@ This module deploys API Management Service Policy. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `value` | string | Contents of the Policy as defined by the format. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ApiManagement/service/portalsettings/readme.md b/modules/Microsoft.ApiManagement/service/portalsettings/readme.md index 4b16d03b38..a03a6e90b7 100644 --- a/modules/Microsoft.ApiManagement/service/portalsettings/readme.md +++ b/modules/Microsoft.ApiManagement/service/portalsettings/readme.md @@ -18,16 +18,19 @@ This module deploys API Management Service Portal Setting. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `name` | string | `[delegation, signin, signup]` | Portal setting name. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ApiManagement/service/products/apis/readme.md b/modules/Microsoft.ApiManagement/service/products/apis/readme.md index 9e490a40df..2155d0eb2e 100644 --- a/modules/Microsoft.ApiManagement/service/products/apis/readme.md +++ b/modules/Microsoft.ApiManagement/service/products/apis/readme.md @@ -18,17 +18,20 @@ This module deploys API Management Service Product APIs. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the product API. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | | `productName` | string | The name of the parent Product. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ApiManagement/service/products/groups/readme.md b/modules/Microsoft.ApiManagement/service/products/groups/readme.md index cc65365369..108e9be26f 100644 --- a/modules/Microsoft.ApiManagement/service/products/groups/readme.md +++ b/modules/Microsoft.ApiManagement/service/products/groups/readme.md @@ -18,17 +18,20 @@ This module deploys API Management Service Product Groups. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the product group. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | | `productName` | string | The name of the parent Product. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ApiManagement/service/products/readme.md b/modules/Microsoft.ApiManagement/service/products/readme.md index 68150e980f..8c0d216487 100644 --- a/modules/Microsoft.ApiManagement/service/products/readme.md +++ b/modules/Microsoft.ApiManagement/service/products/readme.md @@ -20,16 +20,19 @@ This module deploys API Management Service Products. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Product Name. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `apis` | _[apis](apis/readme.md)_ array | `[]` | Array of Product APIs. | diff --git a/modules/Microsoft.ApiManagement/service/readme.md b/modules/Microsoft.ApiManagement/service/readme.md index eced28f03e..e328a6bda4 100644 --- a/modules/Microsoft.ApiManagement/service/readme.md +++ b/modules/Microsoft.ApiManagement/service/readme.md @@ -37,6 +37,7 @@ This module deploys an API management service. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the API Management service. | @@ -44,6 +45,7 @@ This module deploys an API management service. | `publisherName` | string | The name of the owner of the service. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `additionalLocations` | array | `[]` | | Additional datacenter locations of the API Management service. | diff --git a/modules/Microsoft.ApiManagement/service/subscriptions/readme.md b/modules/Microsoft.ApiManagement/service/subscriptions/readme.md index 84219b1d6e..f3275d4ac1 100644 --- a/modules/Microsoft.ApiManagement/service/subscriptions/readme.md +++ b/modules/Microsoft.ApiManagement/service/subscriptions/readme.md @@ -18,16 +18,19 @@ This module deploys API Management Subscriptions. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Subscription name. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `allowTracing` | bool | `True` | Determines whether tracing can be enabled. | diff --git a/modules/Microsoft.AppConfiguration/configurationStores/keyValues/readme.md b/modules/Microsoft.AppConfiguration/configurationStores/keyValues/readme.md index 3a550854df..69086e864d 100644 --- a/modules/Microsoft.AppConfiguration/configurationStores/keyValues/readme.md +++ b/modules/Microsoft.AppConfiguration/configurationStores/keyValues/readme.md @@ -18,17 +18,20 @@ This module deploys an App Configuration Store. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the key. | | `value` | string | Name of the value. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `appConfigurationName` | string | The name of the parent app configuration store. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `contentType` | string | `''` | The content type of the key-values value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. | diff --git a/modules/Microsoft.AppConfiguration/configurationStores/readme.md b/modules/Microsoft.AppConfiguration/configurationStores/readme.md index f7934f0830..077ce20123 100644 --- a/modules/Microsoft.AppConfiguration/configurationStores/readme.md +++ b/modules/Microsoft.AppConfiguration/configurationStores/readme.md @@ -25,11 +25,13 @@ This module deploys an App Configuration Store. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Azure App Configuration. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `createMode` | string | `'Default'` | `[Default, Recover]` | Indicates whether the configuration store need to be recovered. | diff --git a/modules/Microsoft.Authorization/locks/readme.md b/modules/Microsoft.Authorization/locks/readme.md index a6e0adea95..b10649ceaf 100644 --- a/modules/Microsoft.Authorization/locks/readme.md +++ b/modules/Microsoft.Authorization/locks/readme.md @@ -19,11 +19,13 @@ This module deploys Authorization Locks. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `level` | string | `[CanNotDelete, ReadOnly]` | Set lock level. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Authorization/locks/resourceGroup/readme.md b/modules/Microsoft.Authorization/locks/resourceGroup/readme.md index 6453e76aa1..41f966d1e4 100644 --- a/modules/Microsoft.Authorization/locks/resourceGroup/readme.md +++ b/modules/Microsoft.Authorization/locks/resourceGroup/readme.md @@ -18,11 +18,13 @@ This module deploys Authorization Locks on Resource Group level. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `level` | string | `[CanNotDelete, ReadOnly]` | Set lock level. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Authorization/locks/subscription/readme.md b/modules/Microsoft.Authorization/locks/subscription/readme.md index e47ab8fe5d..80a8f63380 100644 --- a/modules/Microsoft.Authorization/locks/subscription/readme.md +++ b/modules/Microsoft.Authorization/locks/subscription/readme.md @@ -18,11 +18,13 @@ This module deploys Authorization Locks on Subscription level. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `level` | string | `[CanNotDelete, ReadOnly]` | Set lock level. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Authorization/policyAssignments/managementGroup/readme.md b/modules/Microsoft.Authorization/policyAssignments/managementGroup/readme.md index 1327e5a28b..dda45ee82d 100644 --- a/modules/Microsoft.Authorization/policyAssignments/managementGroup/readme.md +++ b/modules/Microsoft.Authorization/policyAssignments/managementGroup/readme.md @@ -19,12 +19,14 @@ With this module you can perform policy assignments on a management group level. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy assignment. Maximum length is 24 characters for management group scope. | | `policyDefinitionId` | string | Specifies the ID of the policy definition or policy set definition being assigned. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | This message will be part of response in case of policy violation. | diff --git a/modules/Microsoft.Authorization/policyAssignments/readme.md b/modules/Microsoft.Authorization/policyAssignments/readme.md index 4c8c9bd55f..adbc6881f1 100644 --- a/modules/Microsoft.Authorization/policyAssignments/readme.md +++ b/modules/Microsoft.Authorization/policyAssignments/readme.md @@ -21,12 +21,14 @@ With this module you can perform policy assignments across the management group, ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy assignment. Maximum length is 24 characters for management group scope, 64 characters for subscription and resource group scopes. | | `policyDefinitionId` | string | Specifies the ID of the policy definition or policy set definition being assigned. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | This message will be part of response in case of policy violation. | diff --git a/modules/Microsoft.Authorization/policyAssignments/resourceGroup/readme.md b/modules/Microsoft.Authorization/policyAssignments/resourceGroup/readme.md index ff605aaf17..14acc9139e 100644 --- a/modules/Microsoft.Authorization/policyAssignments/resourceGroup/readme.md +++ b/modules/Microsoft.Authorization/policyAssignments/resourceGroup/readme.md @@ -19,12 +19,14 @@ With this module you can perform policy assignments on a resource group level ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy assignment. Maximum length is 64 characters for resource group scope. | | `policyDefinitionId` | string | Specifies the ID of the policy definition or policy set definition being assigned. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | This message will be part of response in case of policy violation. | diff --git a/modules/Microsoft.Authorization/policyAssignments/subscription/readme.md b/modules/Microsoft.Authorization/policyAssignments/subscription/readme.md index bf845e7aa0..ccfba23f04 100644 --- a/modules/Microsoft.Authorization/policyAssignments/subscription/readme.md +++ b/modules/Microsoft.Authorization/policyAssignments/subscription/readme.md @@ -19,12 +19,14 @@ With this module you can perform policy assignments on a subscription level. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy assignment. Maximum length is 64 characters for subscription scope. | | `policyDefinitionId` | string | Specifies the ID of the policy definition or policy set definition being assigned. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | This message will be part of response in case of policy violation. | diff --git a/modules/Microsoft.Authorization/policyDefinitions/managementGroup/readme.md b/modules/Microsoft.Authorization/policyDefinitions/managementGroup/readme.md index 545dcea8f8..88a83f147d 100644 --- a/modules/Microsoft.Authorization/policyDefinitions/managementGroup/readme.md +++ b/modules/Microsoft.Authorization/policyDefinitions/managementGroup/readme.md @@ -18,12 +18,14 @@ With this module you can create policy definitions on a management group level. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy definition. Maximum length is 64 characters. | | `policyRule` | object | The Policy Rule details for the Policy Definition. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | The policy definition description. | diff --git a/modules/Microsoft.Authorization/policyDefinitions/readme.md b/modules/Microsoft.Authorization/policyDefinitions/readme.md index 260c2bc38d..81eb88aa92 100644 --- a/modules/Microsoft.Authorization/policyDefinitions/readme.md +++ b/modules/Microsoft.Authorization/policyDefinitions/readme.md @@ -20,12 +20,14 @@ With this module you can create policy definitions across the management group o ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy definition. Maximum length is 64 characters for management group scope and subscription scope. | | `policyRule` | object | The Policy Rule details for the Policy Definition. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | The policy definition description. | diff --git a/modules/Microsoft.Authorization/policyDefinitions/subscription/readme.md b/modules/Microsoft.Authorization/policyDefinitions/subscription/readme.md index c8791be2dc..79b16cf18e 100644 --- a/modules/Microsoft.Authorization/policyDefinitions/subscription/readme.md +++ b/modules/Microsoft.Authorization/policyDefinitions/subscription/readme.md @@ -18,12 +18,14 @@ With this module you can create policy definitions on a subscription level. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy definition. Maximum length is 64 characters. | | `policyRule` | object | The Policy Rule details for the Policy Definition. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | The policy definition description. | diff --git a/modules/Microsoft.Authorization/policyExemptions/managementGroup/readme.md b/modules/Microsoft.Authorization/policyExemptions/managementGroup/readme.md index 5cf530cafd..17f5e424d7 100644 --- a/modules/Microsoft.Authorization/policyExemptions/managementGroup/readme.md +++ b/modules/Microsoft.Authorization/policyExemptions/managementGroup/readme.md @@ -18,12 +18,14 @@ With this module you can create policy exemptions on a management group level. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy exemption. Maximum length is 64 characters for management group scope. | | `policyAssignmentId` | string | The resource ID of the policy assignment that is being exempted. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | The description of the policy exemption. | diff --git a/modules/Microsoft.Authorization/policyExemptions/readme.md b/modules/Microsoft.Authorization/policyExemptions/readme.md index 4b73e8ddd6..9252e99d1f 100644 --- a/modules/Microsoft.Authorization/policyExemptions/readme.md +++ b/modules/Microsoft.Authorization/policyExemptions/readme.md @@ -21,12 +21,14 @@ With this module you can create policy exemptions across the management group, s ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy exemption. Maximum length is 64 characters for management group, subscription and resource group scopes. | | `policyAssignmentId` | string | The resource ID of the policy assignment that is being exempted. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | The description of the policy exemption. | diff --git a/modules/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md b/modules/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md index 40c0f74d7d..6f10d69ef7 100644 --- a/modules/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md +++ b/modules/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md @@ -18,12 +18,14 @@ With this module you can create policy exemptions on a resource group level. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy exemption. Maximum length is 64 characters for resource group scope. | | `policyAssignmentId` | string | The resource ID of the policy assignment that is being exempted. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | The description of the policy exemption. | diff --git a/modules/Microsoft.Authorization/policyExemptions/subscription/readme.md b/modules/Microsoft.Authorization/policyExemptions/subscription/readme.md index d9da11696f..3a767018e4 100644 --- a/modules/Microsoft.Authorization/policyExemptions/subscription/readme.md +++ b/modules/Microsoft.Authorization/policyExemptions/subscription/readme.md @@ -18,12 +18,14 @@ With this module you can create policy exemptions on a subscription level. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy exemption. Maximum length is 64 characters for subscription scope. | | `policyAssignmentId` | string | The resource ID of the policy assignment that is being exempted. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `description` | string | `''` | | The description of the policy exemption. | diff --git a/modules/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md b/modules/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md index 7c145bdeb9..41bcc25f29 100644 --- a/modules/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md +++ b/modules/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md @@ -18,12 +18,14 @@ With this module you can create policy set definitions on a management group lev ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy Set Definition (Initiative). | | `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `description` | string | `''` | The description name of the Set Definition (Initiative). | diff --git a/modules/Microsoft.Authorization/policySetDefinitions/readme.md b/modules/Microsoft.Authorization/policySetDefinitions/readme.md index 1afe6bbac9..d2a50d51b2 100644 --- a/modules/Microsoft.Authorization/policySetDefinitions/readme.md +++ b/modules/Microsoft.Authorization/policySetDefinitions/readme.md @@ -21,12 +21,14 @@ With this module you can create policy set definitions across the management gro ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy Set Definition (Initiative). | | `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `description` | string | `''` | The description name of the Set Definition (Initiative). | diff --git a/modules/Microsoft.Authorization/policySetDefinitions/subscription/readme.md b/modules/Microsoft.Authorization/policySetDefinitions/subscription/readme.md index 6bb487bc14..1ecda2fd25 100644 --- a/modules/Microsoft.Authorization/policySetDefinitions/subscription/readme.md +++ b/modules/Microsoft.Authorization/policySetDefinitions/subscription/readme.md @@ -18,12 +18,14 @@ With this module you can create policy set definitions on a subscription level. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy Set Definition (Initiative). Maximum length is 64 characters for subscription scope. | | `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `description` | string | `''` | The description name of the Set Definition (Initiative). | diff --git a/modules/Microsoft.Authorization/roleAssignments/managementGroup/readme.md b/modules/Microsoft.Authorization/roleAssignments/managementGroup/readme.md index fc2bea5ba3..4a8626fd71 100644 --- a/modules/Microsoft.Authorization/roleAssignments/managementGroup/readme.md +++ b/modules/Microsoft.Authorization/roleAssignments/managementGroup/readme.md @@ -18,12 +18,14 @@ With this module you can perform role assignments on a management group level ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). | | `roleDefinitionIdOrName` | string | 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'. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to. | diff --git a/modules/Microsoft.Authorization/roleAssignments/readme.md b/modules/Microsoft.Authorization/roleAssignments/readme.md index 0caeec8267..476f7d9e30 100644 --- a/modules/Microsoft.Authorization/roleAssignments/readme.md +++ b/modules/Microsoft.Authorization/roleAssignments/readme.md @@ -21,12 +21,14 @@ This module deploys Role Assignments across the management group, subscription o ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). | | `roleDefinitionIdOrName` | string | 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'. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to. | diff --git a/modules/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md b/modules/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md index 83d55baa2a..c10c07dc7c 100644 --- a/modules/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md +++ b/modules/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md @@ -18,12 +18,14 @@ With this module you can perform role assignments on a resource group level ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). | | `roleDefinitionIdOrName` | string | 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'. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to. | diff --git a/modules/Microsoft.Authorization/roleAssignments/subscription/readme.md b/modules/Microsoft.Authorization/roleAssignments/subscription/readme.md index 7afec05bd1..577a4a60a1 100644 --- a/modules/Microsoft.Authorization/roleAssignments/subscription/readme.md +++ b/modules/Microsoft.Authorization/roleAssignments/subscription/readme.md @@ -18,12 +18,14 @@ With this module you can perform role assignments on a subscription level ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). | | `roleDefinitionIdOrName` | string | 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'. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to. | diff --git a/modules/Microsoft.Automation/automationAccounts/jobSchedules/readme.md b/modules/Microsoft.Automation/automationAccounts/jobSchedules/readme.md index f182483b79..28157fd924 100644 --- a/modules/Microsoft.Automation/automationAccounts/jobSchedules/readme.md +++ b/modules/Microsoft.Automation/automationAccounts/jobSchedules/readme.md @@ -18,17 +18,20 @@ This module deploys an Azure Automation Account Job Schedule. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `runbookName` | string | The runbook property associated with the entity. | | `scheduleName` | string | The schedule property associated with the entity. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | @@ -36,6 +39,7 @@ This module deploys an Azure Automation Account Job Schedule. | `runOn` | string | `''` | The hybrid worker group that the scheduled job should run on. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `name` | string | `[newGuid()]` | Name of the Automation Account job schedule. Must be a GUID and is autogenerated. No need to provide this value. | diff --git a/modules/Microsoft.Automation/automationAccounts/modules/readme.md b/modules/Microsoft.Automation/automationAccounts/modules/readme.md index 18989c4aa8..34d007025f 100644 --- a/modules/Microsoft.Automation/automationAccounts/modules/readme.md +++ b/modules/Microsoft.Automation/automationAccounts/modules/readme.md @@ -18,17 +18,20 @@ This module deploys an Azure Automation Account Module. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Automation Account module. | | `uri` | string | Module package URI, e.g. https://www.powershellgallery.com/api/v2/package. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Automation/automationAccounts/readme.md b/modules/Microsoft.Automation/automationAccounts/readme.md index 2aaee74c00..810c32b5fe 100644 --- a/modules/Microsoft.Automation/automationAccounts/readme.md +++ b/modules/Microsoft.Automation/automationAccounts/readme.md @@ -32,11 +32,13 @@ This module deploys an Azure Automation Account. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Automation Account. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `cMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption. | diff --git a/modules/Microsoft.Automation/automationAccounts/runbooks/readme.md b/modules/Microsoft.Automation/automationAccounts/runbooks/readme.md index 7428c08625..9809ee7c37 100644 --- a/modules/Microsoft.Automation/automationAccounts/runbooks/readme.md +++ b/modules/Microsoft.Automation/automationAccounts/runbooks/readme.md @@ -18,17 +18,20 @@ This module deploys an Azure Automation Account Runbook. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `name` | string | | Name of the Automation Account runbook. | | `runbookType` | string | `[Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow]` | The type of the runbook. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | @@ -41,6 +44,7 @@ This module deploys an Azure Automation Account Runbook. | `version` | string | `''` | The version of the runbook content. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `baseTime` | string | `[utcNow('u')]` | Time used as a basis for e.g. the schedule start date. | diff --git a/modules/Microsoft.Automation/automationAccounts/schedules/readme.md b/modules/Microsoft.Automation/automationAccounts/schedules/readme.md index afdcc9a0da..64e1927d41 100644 --- a/modules/Microsoft.Automation/automationAccounts/schedules/readme.md +++ b/modules/Microsoft.Automation/automationAccounts/schedules/readme.md @@ -18,16 +18,19 @@ This module deploys an Azure Automation Account Schedule. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Automation Account schedule. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `advancedSchedule` | object | `{object}` | | The properties of the create Advanced Schedule. | @@ -40,6 +43,7 @@ This module deploys an Azure Automation Account Schedule. | `timeZone` | string | `''` | | The time zone of the schedule. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `baseTime` | string | `[utcNow('u')]` | Time used as a basis for e.g. the schedule start date. | diff --git a/modules/Microsoft.Automation/automationAccounts/softwareUpdateConfigurations/readme.md b/modules/Microsoft.Automation/automationAccounts/softwareUpdateConfigurations/readme.md index 23808198ca..d64d769ea8 100644 --- a/modules/Microsoft.Automation/automationAccounts/softwareUpdateConfigurations/readme.md +++ b/modules/Microsoft.Automation/automationAccounts/softwareUpdateConfigurations/readme.md @@ -18,6 +18,7 @@ This module deploys an Azure Automation Account Software update Configuration. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `frequency` | string | `[Day, Hour, Month, OneTime, Week]` | The frequency of the deployment schedule. When using 'Hour', 'Day', 'Week' or 'Month', an interval needs to be provided. | @@ -26,11 +27,13 @@ This module deploys an Azure Automation Account Software update Configuration. | `rebootSetting` | string | `[Always, IfRequired, Never, RebootOnly]` | Reboot setting for the deployment schedule. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `azureVirtualMachines` | array | `[]` | | List of azure resource IDs for azure virtual machines in scope for the deployment schedule. | @@ -63,6 +66,7 @@ This module deploys an Azure Automation Account Software update Configuration. | `weekDays` | array | `[]` | `[Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday]` | Required when used with frequency 'Week'. Specified the day of the week to run the deployment schedule. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `baseTime` | string | `[utcNow('u')]` | Do not touch. Is used to provide the base time for time comparison for startTime. If startTime is specified in HH:MM format, baseTime is used to check if the provided startTime has passed, adding one day before setting the deployment schedule. | diff --git a/modules/Microsoft.Automation/automationAccounts/variables/readme.md b/modules/Microsoft.Automation/automationAccounts/variables/readme.md index 917c4d1875..1742bf1490 100644 --- a/modules/Microsoft.Automation/automationAccounts/variables/readme.md +++ b/modules/Microsoft.Automation/automationAccounts/variables/readme.md @@ -18,17 +18,20 @@ This module deploys a variable to an Azure Automation Account. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the variable. | | `value` | string | The value of the variable. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `description` | string | `''` | The description of the variable. | diff --git a/modules/Microsoft.Batch/batchAccounts/readme.md b/modules/Microsoft.Batch/batchAccounts/readme.md index 873632fa23..3c393c9835 100644 --- a/modules/Microsoft.Batch/batchAccounts/readme.md +++ b/modules/Microsoft.Batch/batchAccounts/readme.md @@ -22,17 +22,20 @@ ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Azure Batch. | | `storageAccountId` | string | The resource ID of the storage account to be used for auto-storage account. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `keyVaultReferenceResourceId` | string | `''` | The key vault to associate with the Batch account. Required if the 'poolAllocationMode' is set to 'UserSubscription' and requires the service principal 'Microsoft Azure Batch' to be granted contributor permissions on this key vault. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `allowedAuthenticationModes` | array | `[]` | `[AAD, SharedKey, TaskAuthenticationToken]` | List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. | diff --git a/modules/Microsoft.Cache/redis/readme.md b/modules/Microsoft.Cache/redis/readme.md index 94cc75db9d..cb02a69e61 100644 --- a/modules/Microsoft.Cache/redis/readme.md +++ b/modules/Microsoft.Cache/redis/readme.md @@ -24,11 +24,13 @@ This module deploys a Redis Cache service. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Redis cache resource. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `capacity` | int | `1` | `[0, 1, 2, 3, 4, 5, 6]` | The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4). | diff --git a/modules/Microsoft.CognitiveServices/accounts/readme.md b/modules/Microsoft.CognitiveServices/accounts/readme.md index 927de37730..35f8004d5e 100644 --- a/modules/Microsoft.CognitiveServices/accounts/readme.md +++ b/modules/Microsoft.CognitiveServices/accounts/readme.md @@ -25,18 +25,21 @@ This module deploys different kinds of cognitive services resources ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `kind` | string | `[AnomalyDetector, Bing.Autosuggest.v7, Bing.CustomSearch, Bing.EntitySearch, Bing.Search.v7, Bing.SpellCheck.v7, CognitiveServices, ComputerVision, ContentModerator, CustomVision.Prediction, CustomVision.Training, Face, FormRecognizer, ImmersiveReader, Internal.AllInOne, LUIS, LUIS.Authoring, Personalizer, QnAMaker, SpeechServices, TextAnalytics, TextTranslation]` | Kind of the Cognitive Services. Use 'Get-AzCognitiveServicesAccountSku' to determine a valid combinations of 'kind' and 'SKU' for your Azure region. | | `name` | string | | The name of Cognitive Services account. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `customSubDomainName` | string | `''` | Subdomain name used for token-based authentication. Required if 'networkAcls' or 'privateEndpoints' are set. | | `userAssignedIdentities` | object | `{object}` | The ID(s) to assign to the resource. Required if a user assigned identity is used for encryption. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `allowedFqdnList` | array | `[]` | | List of allowed FQDN. | diff --git a/modules/Microsoft.Compute/availabilitySets/readme.md b/modules/Microsoft.Compute/availabilitySets/readme.md index 57d35f2c3c..7eeb194277 100644 --- a/modules/Microsoft.Compute/availabilitySets/readme.md +++ b/modules/Microsoft.Compute/availabilitySets/readme.md @@ -21,11 +21,13 @@ This template deploys an availability set ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the availability set that is being created. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `availabilitySetFaultDomain` | int | `2` | | The number of fault domains to use. | diff --git a/modules/Microsoft.Compute/diskEncryptionSets/readme.md b/modules/Microsoft.Compute/diskEncryptionSets/readme.md index 09934b257e..1384d971bc 100644 --- a/modules/Microsoft.Compute/diskEncryptionSets/readme.md +++ b/modules/Microsoft.Compute/diskEncryptionSets/readme.md @@ -21,6 +21,7 @@ This template deploys a disk encryption set. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `keyName` | string | Key URL (with version) pointing to a key or secret in KeyVault. | @@ -28,6 +29,7 @@ This template deploys a disk encryption set. | `name` | string | The name of the disk encryption set that is being created. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Compute/disks/readme.md b/modules/Microsoft.Compute/disks/readme.md index d5c3698639..72dfd6d833 100644 --- a/modules/Microsoft.Compute/disks/readme.md +++ b/modules/Microsoft.Compute/disks/readme.md @@ -21,12 +21,14 @@ This template deploys a disk ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `name` | string | | The name of the disk that is being created. | | `sku` | string | `[Premium_LRS, Premium_ZRS, Premium_ZRS, Standard_LRS, StandardSSD_LRS, UltraSSD_LRS]` | The disks sku name. Can be . | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `acceleratedNetwork` | bool | `False` | | True if the image from which the OS disk is created supports accelerated networking. | diff --git a/modules/Microsoft.Compute/galleries/images/readme.md b/modules/Microsoft.Compute/galleries/images/readme.md index e380c9d710..a09f116691 100644 --- a/modules/Microsoft.Compute/galleries/images/readme.md +++ b/modules/Microsoft.Compute/galleries/images/readme.md @@ -19,16 +19,19 @@ This module deploys an Image Definition in a Shared Image Gallery. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the image definition. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `galleryName` | string | The name of the parent Azure Shared Image Gallery. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Compute/galleries/readme.md b/modules/Microsoft.Compute/galleries/readme.md index 9aadc157b6..31fe3d9802 100644 --- a/modules/Microsoft.Compute/galleries/readme.md +++ b/modules/Microsoft.Compute/galleries/readme.md @@ -22,11 +22,13 @@ This module deploys an Azure compute gallery (formerly known as shared image gal ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Azure Shared Image Gallery. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Compute/images/readme.md b/modules/Microsoft.Compute/images/readme.md index c2af93ba73..135c138519 100644 --- a/modules/Microsoft.Compute/images/readme.md +++ b/modules/Microsoft.Compute/images/readme.md @@ -20,6 +20,7 @@ This module deploys a compute image. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the image. | @@ -27,6 +28,7 @@ This module deploys a compute image. | `osType` | string | This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. - Windows or Linux. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Compute/proximityPlacementGroups/readme.md b/modules/Microsoft.Compute/proximityPlacementGroups/readme.md index 32d429e4a6..50d7942868 100644 --- a/modules/Microsoft.Compute/proximityPlacementGroups/readme.md +++ b/modules/Microsoft.Compute/proximityPlacementGroups/readme.md @@ -21,11 +21,13 @@ This template deploys a proximity placement group. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the proximity placement group that is being created. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Compute/virtualMachineScaleSets/extensions/readme.md b/modules/Microsoft.Compute/virtualMachineScaleSets/extensions/readme.md index 255536466b..1892dff803 100644 --- a/modules/Microsoft.Compute/virtualMachineScaleSets/extensions/readme.md +++ b/modules/Microsoft.Compute/virtualMachineScaleSets/extensions/readme.md @@ -18,6 +18,7 @@ This module deploys a virtual machine scale set extension. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `autoUpgradeMinorVersion` | bool | Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. | @@ -28,11 +29,13 @@ This module deploys a virtual machine scale set extension. | `typeHandlerVersion` | string | Specifies the version of the script handler. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `virtualMachineScaleSetName` | string | The name of the parent virtual machine scale set that extension is provisioned for. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Compute/virtualMachineScaleSets/readme.md b/modules/Microsoft.Compute/virtualMachineScaleSets/readme.md index bb5f97dde0..1e9021ff05 100644 --- a/modules/Microsoft.Compute/virtualMachineScaleSets/readme.md +++ b/modules/Microsoft.Compute/virtualMachineScaleSets/readme.md @@ -29,6 +29,7 @@ The following resources are required to be able to deploy this resource. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `adminUsername` | secureString | | Administrator username. | @@ -40,6 +41,7 @@ The following resources are required to be able to deploy this resource. | `skuName` | string | | The SKU size of the VMs. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `additionalUnattendContent` | array | `[]` | | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - AdditionalUnattendContent object. | @@ -113,6 +115,7 @@ The following resources are required to be able to deploy this resource. | `zoneBalance` | bool | `False` | | Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `baseTime` | string | `[utcNow('u')]` | Do not provide a value! This date value is used to generate a registration token. | diff --git a/modules/Microsoft.Compute/virtualMachines/extensions/readme.md b/modules/Microsoft.Compute/virtualMachines/extensions/readme.md index 06f4972691..7920ef7e64 100644 --- a/modules/Microsoft.Compute/virtualMachines/extensions/readme.md +++ b/modules/Microsoft.Compute/virtualMachines/extensions/readme.md @@ -18,6 +18,7 @@ This module deploys a virtual machine extension. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `autoUpgradeMinorVersion` | bool | Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. | @@ -28,11 +29,13 @@ This module deploys a virtual machine extension. | `typeHandlerVersion` | string | Specifies the version of the script handler. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `virtualMachineName` | string | The name of the parent virtual machine that extension is provisioned for. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Compute/virtualMachines/readme.md b/modules/Microsoft.Compute/virtualMachines/readme.md index b6b0270d4a..13e8736eaa 100644 --- a/modules/Microsoft.Compute/virtualMachines/readme.md +++ b/modules/Microsoft.Compute/virtualMachines/readme.md @@ -28,6 +28,7 @@ This module deploys one Virtual Machine with one or multiple nics and optionally ## Parameters **Required parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `adminUsername` | secureString | | | Administrator username. | @@ -39,6 +40,7 @@ This module deploys one Virtual Machine with one or multiple nics and optionally | `vmSize` | string | | | Specifies the size for the VMs. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `additionalUnattendContent` | array | `[]` | | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - AdditionalUnattendContent object. | @@ -107,6 +109,7 @@ This module deploys one Virtual Machine with one or multiple nics and optionally | `winRM` | object | `{object}` | | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - WinRMConfiguration object. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `baseTime` | string | `[utcNow('u')]` | Do not provide a value! This date value is used to generate a registration token. | diff --git a/modules/Microsoft.Consumption/budgets/readme.md b/modules/Microsoft.Consumption/budgets/readme.md index f88ecb0008..e37e765ccc 100644 --- a/modules/Microsoft.Consumption/budgets/readme.md +++ b/modules/Microsoft.Consumption/budgets/readme.md @@ -19,12 +19,14 @@ This module deploys budgets for subscriptions. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `amount` | int | The total amount of cost or usage to track with the budget. | | `name` | string | The name of the budget. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `actionGroups` | array | `[]` | | List of action group resource IDs that will receive the alert. | diff --git a/modules/Microsoft.ContainerInstance/containerGroups/readme.md b/modules/Microsoft.ContainerInstance/containerGroups/readme.md index 982cb4f2b9..b3d210ef95 100644 --- a/modules/Microsoft.ContainerInstance/containerGroups/readme.md +++ b/modules/Microsoft.ContainerInstance/containerGroups/readme.md @@ -22,6 +22,7 @@ The top-level resource in Azure Container Instances is the container group. A co ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `containername` | string | Name for the container. | @@ -29,6 +30,7 @@ The top-level resource in Azure Container Instances is the container group. A co | `name` | string | Name for the container group. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `cpuCores` | int | `2` | | The number of CPU cores to allocate to the container. | diff --git a/modules/Microsoft.ContainerRegistry/registries/readme.md b/modules/Microsoft.ContainerRegistry/registries/readme.md index 785a83e5bf..a517396d46 100644 --- a/modules/Microsoft.ContainerRegistry/registries/readme.md +++ b/modules/Microsoft.ContainerRegistry/registries/readme.md @@ -26,16 +26,19 @@ Azure Container Registry is a managed, private Docker registry service based on ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of your Azure container registry. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `cMKUserAssignedIdentityResourceId` | string | `''` | User assigned identity to use when fetching the customer managed key. Note, CMK requires the 'acrSku' to be 'Premium'. Required if 'cMKKeyName' is not empty. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `acrAdminUserEnabled` | bool | `False` | | Enable admin user that have push / pull permission to the registry. | diff --git a/modules/Microsoft.ContainerRegistry/registries/replications/readme.md b/modules/Microsoft.ContainerRegistry/registries/replications/readme.md index 425640b565..8de6eace50 100644 --- a/modules/Microsoft.ContainerRegistry/registries/replications/readme.md +++ b/modules/Microsoft.ContainerRegistry/registries/replications/readme.md @@ -18,16 +18,19 @@ This module deploys ContainerRegistry Registries Replications. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the replication. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `registryName` | string | The name of the parent registry. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ContainerRegistry/registries/webhooks/readme.md b/modules/Microsoft.ContainerRegistry/registries/webhooks/readme.md index d009a3e881..0b488f4757 100644 --- a/modules/Microsoft.ContainerRegistry/registries/webhooks/readme.md +++ b/modules/Microsoft.ContainerRegistry/registries/webhooks/readme.md @@ -18,16 +18,19 @@ This module deploys ContainerRegistry Registries Webhooks. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `serviceUri` | string | The service URI for the webhook to post notifications. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `registryName` | string | The name of the parent registry. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `action` | array | `[chart_delete, chart_push, delete, push, quarantine]` | | The list of actions that trigger the webhook to post notifications. | diff --git a/modules/Microsoft.ContainerService/managedClusters/agentPools/readme.md b/modules/Microsoft.ContainerService/managedClusters/agentPools/readme.md index e3961dda9b..378c9ce4bc 100644 --- a/modules/Microsoft.ContainerService/managedClusters/agentPools/readme.md +++ b/modules/Microsoft.ContainerService/managedClusters/agentPools/readme.md @@ -18,16 +18,19 @@ This module deploys an Agent Pool for a Container Service Managed Cluster ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the agent pool. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `managedClusterName` | string | The name of the parent managed cluster. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `availabilityZones` | array | `[]` | | The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is "VirtualMachineScaleSets". | diff --git a/modules/Microsoft.ContainerService/managedClusters/readme.md b/modules/Microsoft.ContainerService/managedClusters/readme.md index a74b4b9489..dcb2b291f9 100644 --- a/modules/Microsoft.ContainerService/managedClusters/readme.md +++ b/modules/Microsoft.ContainerService/managedClusters/readme.md @@ -23,17 +23,20 @@ This module deploys Azure Kubernetes Cluster (AKS). ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the AKS cluster. | | `primaryAgentPoolProfile` | array | Properties of the primary agent pool. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `appGatewayResourceId` | string | `''` | Specifies the resource ID of connected application gateway. Required if `ingressApplicationGatewayEnabled` is set to `true`. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `aadProfileAdminGroupObjectIDs` | array | `[]` | | Specifies the AAD group object IDs that will have admin role of the cluster. | diff --git a/modules/Microsoft.DBforPostgreSQL/flexibleServers/configurations/readme.md b/modules/Microsoft.DBforPostgreSQL/flexibleServers/configurations/readme.md index dc88d78fc9..488da42c6b 100644 --- a/modules/Microsoft.DBforPostgreSQL/flexibleServers/configurations/readme.md +++ b/modules/Microsoft.DBforPostgreSQL/flexibleServers/configurations/readme.md @@ -18,16 +18,19 @@ This module deploys DBforPostgreSQL FlexibleServers Configurations. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the configuration. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `flexibleServerName` | string | The name of the parent PostgreSQL flexible server. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DBforPostgreSQL/flexibleServers/databases/readme.md b/modules/Microsoft.DBforPostgreSQL/flexibleServers/databases/readme.md index 4969733a8a..10580f7244 100644 --- a/modules/Microsoft.DBforPostgreSQL/flexibleServers/databases/readme.md +++ b/modules/Microsoft.DBforPostgreSQL/flexibleServers/databases/readme.md @@ -18,16 +18,19 @@ This module deploys DBforPostgreSQL FlexibleServers Databases. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the database. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `flexibleServerName` | string | The name of the parent PostgreSQL flexible server. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `charset` | string | `''` | The charset of the database. | diff --git a/modules/Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/readme.md b/modules/Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/readme.md index 46039cd01a..be9d7de941 100644 --- a/modules/Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/readme.md +++ b/modules/Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/readme.md @@ -18,6 +18,7 @@ This module deploys DBforPostgreSQL FlexibleServers FirewallRules. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `endIpAddress` | string | The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses. | @@ -25,11 +26,13 @@ This module deploys DBforPostgreSQL FlexibleServers FirewallRules. | `startIpAddress` | string | The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `flexibleServerName` | string | The name of the parent PostgreSQL flexible server. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md b/modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md index 5ce32076ac..ab2b5cfa27 100644 --- a/modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md +++ b/modules/Microsoft.DBforPostgreSQL/flexibleServers/readme.md @@ -25,6 +25,7 @@ This module deploys DBforPostgreSQL FlexibleServers. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `administratorLogin` | string | | The administrator login name of a server. Can only be specified when the PostgreSQL server is being created. | @@ -34,6 +35,7 @@ This module deploys DBforPostgreSQL FlexibleServers. | `tier` | string | `[Burstable, GeneralPurpose, MemoryOptimized]` | The tier of the particular SKU. Tier must align with the "skuName" property. Example, tier cannot be "Burstable" if skuName is "Standard_D4s_v3". | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `availabilityZone` | string | `''` | `['', 1, 2, 3]` | Availability zone information of the server. Default will have no preference set. | diff --git a/modules/Microsoft.DataFactory/factories/integrationRuntimes/readme.md b/modules/Microsoft.DataFactory/factories/integrationRuntimes/readme.md index def1e6110b..a7a039455a 100644 --- a/modules/Microsoft.DataFactory/factories/integrationRuntimes/readme.md +++ b/modules/Microsoft.DataFactory/factories/integrationRuntimes/readme.md @@ -18,17 +18,20 @@ This module deploys a Managed or Self-Hosted Integration Runtime for an Azure Da ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `name` | string | | The name of the Integration Runtime. | | `type` | string | `[Managed, SelfHosted]` | The type of Integration Runtime. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `dataFactoryName` | string | The name of the parent Azure Data Factory. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints/readme.md b/modules/Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints/readme.md index b0ec7fe890..fc94aef323 100644 --- a/modules/Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints/readme.md +++ b/modules/Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints/readme.md @@ -18,6 +18,7 @@ This module deploys a Managed Private Endpoint in a Managed Virtual Network for ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `fqdns` | array | Fully qualified domain names. | @@ -27,11 +28,13 @@ This module deploys a Managed Private Endpoint in a Managed Virtual Network for | `privateLinkResourceId` | string | The ARM resource ID of the resource to which the managed private endpoint is created. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `dataFactoryName` | string | The name of the parent data factory. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DataFactory/factories/managedVirtualNetworks/readme.md b/modules/Microsoft.DataFactory/factories/managedVirtualNetworks/readme.md index e34d8c569a..f5187a6d32 100644 --- a/modules/Microsoft.DataFactory/factories/managedVirtualNetworks/readme.md +++ b/modules/Microsoft.DataFactory/factories/managedVirtualNetworks/readme.md @@ -19,16 +19,19 @@ This module deploys a Managed Virtual Network for an Azure Data Factory ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Managed Virtual Network. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `dataFactoryName` | string | The name of the parent Azure Data Factory. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DataFactory/factories/readme.md b/modules/Microsoft.DataFactory/factories/readme.md index 23efb9d806..72b54393e2 100644 --- a/modules/Microsoft.DataFactory/factories/readme.md +++ b/modules/Microsoft.DataFactory/factories/readme.md @@ -25,11 +25,13 @@ ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Azure Factory to create. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `cMKKeyName` | string | `''` | | The name of the customer managed key to use for encryption. | diff --git a/modules/Microsoft.DataProtection/backupVaults/backupPolicies/readme.md b/modules/Microsoft.DataProtection/backupVaults/backupPolicies/readme.md index cbb84de65b..e3e32eec9e 100644 --- a/modules/Microsoft.DataProtection/backupVaults/backupPolicies/readme.md +++ b/modules/Microsoft.DataProtection/backupVaults/backupPolicies/readme.md @@ -18,11 +18,13 @@ This module deploys DataProtection BackupVaults BackupPolicies. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `backupVaultName` | string | The name of the backup vault. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DataProtection/backupVaults/readme.md b/modules/Microsoft.DataProtection/backupVaults/readme.md index 342d50ccd1..3fcebad1d9 100644 --- a/modules/Microsoft.DataProtection/backupVaults/readme.md +++ b/modules/Microsoft.DataProtection/backupVaults/readme.md @@ -22,11 +22,13 @@ This module deploys DataProtection BackupVaults. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Backup Vault. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `backupPolicies` | _[backupPolicies](backupPolicies/readme.md)_ array | `[]` | | List of all backup policies. | diff --git a/modules/Microsoft.Databricks/workspaces/readme.md b/modules/Microsoft.Databricks/workspaces/readme.md index cec0ba1761..a58fe0ff3c 100644 --- a/modules/Microsoft.Databricks/workspaces/readme.md +++ b/modules/Microsoft.Databricks/workspaces/readme.md @@ -20,11 +20,13 @@ ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Azure Databricks workspace to create. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.DesktopVirtualization/applicationgroups/applications/readme.md b/modules/Microsoft.DesktopVirtualization/applicationgroups/applications/readme.md index d478d11d54..0e1c720c6a 100644 --- a/modules/Microsoft.DesktopVirtualization/applicationgroups/applications/readme.md +++ b/modules/Microsoft.DesktopVirtualization/applicationgroups/applications/readme.md @@ -18,6 +18,7 @@ This module deploys AVD Applications. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `filePath` | string | Specifies a path for the executable file for the application. | @@ -25,11 +26,13 @@ This module deploys AVD Applications. | `name` | string | Name of the Application to be created in the Application Group. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `appGroupName` | string | The name of the parent Application Group to create the application(s) in. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `commandLineArguments` | string | `''` | | Command-Line Arguments for Application. | diff --git a/modules/Microsoft.DesktopVirtualization/applicationgroups/readme.md b/modules/Microsoft.DesktopVirtualization/applicationgroups/readme.md index b1fe6a0f0c..f7982c4124 100644 --- a/modules/Microsoft.DesktopVirtualization/applicationgroups/readme.md +++ b/modules/Microsoft.DesktopVirtualization/applicationgroups/readme.md @@ -23,6 +23,7 @@ This module deploys an Azure virtual desktop application group. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `applicationGroupType` | string | `[Desktop, RemoteApp]` | The type of the Application Group to be created. Allowed values: RemoteApp or Desktop. | @@ -30,6 +31,7 @@ This module deploys an Azure virtual desktop application group. | `name` | string | | Name of the Application Group to create this application in. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `applications` | _[applications](applications/readme.md)_ array | `[]` | | List of applications to be created in the Application Group. | diff --git a/modules/Microsoft.DesktopVirtualization/hostpools/readme.md b/modules/Microsoft.DesktopVirtualization/hostpools/readme.md index eb05bc87f8..2ac813f4c3 100644 --- a/modules/Microsoft.DesktopVirtualization/hostpools/readme.md +++ b/modules/Microsoft.DesktopVirtualization/hostpools/readme.md @@ -22,11 +22,13 @@ This module deploys an Azure virtual desktop host pool. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Host Pool. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `customRdpProperty` | string | `'audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2;'` | | Host Pool RDP properties. | @@ -55,6 +57,7 @@ This module deploys an Azure virtual desktop host pool. | `vmTemplate` | object | `{object}` | | The necessary information for adding more VMs to this Host Pool. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `baseTime` | string | `[utcNow('u')]` | Do not provide a value! This date value is used to generate a registration token. | diff --git a/modules/Microsoft.DesktopVirtualization/scalingplans/readme.md b/modules/Microsoft.DesktopVirtualization/scalingplans/readme.md index b05a57f1c5..3f88355e16 100644 --- a/modules/Microsoft.DesktopVirtualization/scalingplans/readme.md +++ b/modules/Microsoft.DesktopVirtualization/scalingplans/readme.md @@ -21,11 +21,13 @@ This module deploys an AVD Scaling Plan. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the scaling plan. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.DesktopVirtualization/workspaces/readme.md b/modules/Microsoft.DesktopVirtualization/workspaces/readme.md index 35d2006816..c93260f1e0 100644 --- a/modules/Microsoft.DesktopVirtualization/workspaces/readme.md +++ b/modules/Microsoft.DesktopVirtualization/workspaces/readme.md @@ -22,12 +22,14 @@ This module deploys an Azure virtual desktop workspace. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `appGroupResourceIds` | array | Resource IDs for the existing Application groups this workspace will group together. | | `name` | string | The name of the workspace to be attach to new Application Group. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/readme.md b/modules/Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/readme.md index 3ae7440cae..532dadcb5c 100644 --- a/modules/Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/readme.md +++ b/modules/Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/readme.md @@ -18,17 +18,20 @@ This module deploys DocumentDB DatabaseAccounts GremlinDatabases Graphs. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the graph. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `databaseAccountName` | string | The name of the parent Database Account. Required if the template is used in a standalone deployment. | | `gremlinDatabaseName` | string | The name of the parent Gremlin Database. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `automaticIndexing` | bool | `True` | Indicates if the indexing policy is automatic. | diff --git a/modules/Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/readme.md b/modules/Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/readme.md index 525c7cb9aa..121a726e67 100644 --- a/modules/Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/readme.md +++ b/modules/Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/readme.md @@ -19,16 +19,19 @@ This module deploys a GremlinDB within a CosmosDB account. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Gremlin database. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `databaseAccountName` | string | The name of the parent Gremlin database. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/readme.md b/modules/Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/readme.md index e0305d7b44..e7a501e3c5 100644 --- a/modules/Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/readme.md +++ b/modules/Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/readme.md @@ -18,6 +18,7 @@ This module deploys a collection within a MongoDB. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `indexes` | array | Indexes for the collection. | @@ -25,12 +26,14 @@ This module deploys a collection within a MongoDB. | `shardKey` | object | ShardKey for the collection. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `databaseAccountName` | string | The name of the parent Cosmos DB database account. Required if the template is used in a standalone deployment. | | `mongodbDatabaseName` | string | The name of the parent mongodb database. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/readme.md b/modules/Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/readme.md index 8235b622e0..987092f5d8 100644 --- a/modules/Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/readme.md +++ b/modules/Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/readme.md @@ -19,16 +19,19 @@ This module deploys a MongoDB within a CosmosDB account. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the mongodb database. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `databaseAccountName` | string | The name of the parent Cosmos DB database account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `collections` | _[collections](collections/readme.md)_ array | `[]` | Collections in the mongodb database. | diff --git a/modules/Microsoft.DocumentDB/databaseAccounts/readme.md b/modules/Microsoft.DocumentDB/databaseAccounts/readme.md index 7c9c13b988..d398cc6162 100644 --- a/modules/Microsoft.DocumentDB/databaseAccounts/readme.md +++ b/modules/Microsoft.DocumentDB/databaseAccounts/readme.md @@ -28,12 +28,14 @@ This module deploys a DocumentDB database account and its child resources. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `locations` | array | Locations enabled for the Cosmos DB account. | | `name` | string | Name of the Database Account. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `automaticFailover` | bool | `True` | | Enable automatic failover for regions. | diff --git a/modules/Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/readme.md b/modules/Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/readme.md index 7d83d25872..dd964803ff 100644 --- a/modules/Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/readme.md +++ b/modules/Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/readme.md @@ -16,17 +16,20 @@ ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the container. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `databaseAccountName` | string | The name of the parent Database Account. Required if the template is used in a standalone deployment. | | `sqlDatabaseName` | string | The name of the parent SQL Database. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.DocumentDB/databaseAccounts/sqlDatabases/readme.md b/modules/Microsoft.DocumentDB/databaseAccounts/sqlDatabases/readme.md index e408338088..43e8fa6a98 100644 --- a/modules/Microsoft.DocumentDB/databaseAccounts/sqlDatabases/readme.md +++ b/modules/Microsoft.DocumentDB/databaseAccounts/sqlDatabases/readme.md @@ -17,16 +17,19 @@ ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the SQL database . | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `databaseAccountName` | string | The name of the parent Database Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `containers` | _[containers](containers/readme.md)_ array | `[]` | Array of containers to deploy in the SQL database. | diff --git a/modules/Microsoft.EventGrid/systemTopics/readme.md b/modules/Microsoft.EventGrid/systemTopics/readme.md index 2dc595c041..3cb21098b1 100644 --- a/modules/Microsoft.EventGrid/systemTopics/readme.md +++ b/modules/Microsoft.EventGrid/systemTopics/readme.md @@ -22,6 +22,7 @@ This module deploys an Event Grid System Topic. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Event Grid Topic. | @@ -29,6 +30,7 @@ This module deploys an Event Grid System Topic. | `topicType` | string | TopicType for the system topic. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.EventGrid/topics/readme.md b/modules/Microsoft.EventGrid/topics/readme.md index 1e1514a405..785c5cac2d 100644 --- a/modules/Microsoft.EventGrid/topics/readme.md +++ b/modules/Microsoft.EventGrid/topics/readme.md @@ -24,11 +24,13 @@ This module deploys an event grid topic. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Event Grid Topic. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.EventHub/namespaces/authorizationRules/readme.md b/modules/Microsoft.EventHub/namespaces/authorizationRules/readme.md index 677fc327d6..652cbd27cf 100644 --- a/modules/Microsoft.EventHub/namespaces/authorizationRules/readme.md +++ b/modules/Microsoft.EventHub/namespaces/authorizationRules/readme.md @@ -18,16 +18,19 @@ This module deploys an EventHub Namespace Authorization Rule ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the authorization rule. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent event hub namespace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.EventHub/namespaces/disasterRecoveryConfigs/readme.md b/modules/Microsoft.EventHub/namespaces/disasterRecoveryConfigs/readme.md index fad16d02b2..01c53e0d89 100644 --- a/modules/Microsoft.EventHub/namespaces/disasterRecoveryConfigs/readme.md +++ b/modules/Microsoft.EventHub/namespaces/disasterRecoveryConfigs/readme.md @@ -18,16 +18,19 @@ This module deploys an EventHub Namespace Disaster Recovery Config ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the disaster recovery config. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent event hub namespace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.EventHub/namespaces/eventhubs/authorizationRules/readme.md b/modules/Microsoft.EventHub/namespaces/eventhubs/authorizationRules/readme.md index c9308aaf14..1dc767e0e0 100644 --- a/modules/Microsoft.EventHub/namespaces/eventhubs/authorizationRules/readme.md +++ b/modules/Microsoft.EventHub/namespaces/eventhubs/authorizationRules/readme.md @@ -18,17 +18,20 @@ This module deploys an EventHub Namespace EventHubs Authorization Rule ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the authorization rule. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `eventHubName` | string | The name of the parent event hub namespace event hub. Required if the template is used in a standalone deployment. | | `namespaceName` | string | The name of the parent event hub namespace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.EventHub/namespaces/eventhubs/consumergroups/readme.md b/modules/Microsoft.EventHub/namespaces/eventhubs/consumergroups/readme.md index 6509a18b2b..c13580fa7f 100644 --- a/modules/Microsoft.EventHub/namespaces/eventhubs/consumergroups/readme.md +++ b/modules/Microsoft.EventHub/namespaces/eventhubs/consumergroups/readme.md @@ -18,17 +18,20 @@ This module deploys an EventHub Namespace EventHubs Consumer Group ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the consumer group. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `eventHubName` | string | The name of the parent event hub namespace event hub. Required if the template is used in a standalone deployment. | | `namespaceName` | string | The name of the parent event hub namespace. Required if the template is used in a standalone deployment.s. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.EventHub/namespaces/eventhubs/readme.md b/modules/Microsoft.EventHub/namespaces/eventhubs/readme.md index 3989e18040..a6c8dbf23e 100644 --- a/modules/Microsoft.EventHub/namespaces/eventhubs/readme.md +++ b/modules/Microsoft.EventHub/namespaces/eventhubs/readme.md @@ -22,16 +22,19 @@ This module deploys an Event Hub. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the event hub. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent event hub namespace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `authorizationRules` | _[authorizationRules](authorizationRules/readme.md)_ array | `[System.Collections.Hashtable]` | | Authorization Rules for the event hub. | diff --git a/modules/Microsoft.EventHub/namespaces/networkRuleSets/readme.md b/modules/Microsoft.EventHub/namespaces/networkRuleSets/readme.md index 6e76bebcb6..8b1940963b 100644 --- a/modules/Microsoft.EventHub/namespaces/networkRuleSets/readme.md +++ b/modules/Microsoft.EventHub/namespaces/networkRuleSets/readme.md @@ -18,11 +18,13 @@ This module deploys EventHub Namespaces NetworkRuleSets. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent event hub namespace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `defaultAction` | string | `'Allow'` | `[Allow, Deny]` | Default Action for Network Rule Set. Default is "Allow". It will not be set if publicNetworkAccess is "Disabled". Otherwise, it will be set to "Deny" if ipRules or virtualNetworkRules are being used. | diff --git a/modules/Microsoft.EventHub/namespaces/readme.md b/modules/Microsoft.EventHub/namespaces/readme.md index 0db1a666d3..c57e1e330a 100644 --- a/modules/Microsoft.EventHub/namespaces/readme.md +++ b/modules/Microsoft.EventHub/namespaces/readme.md @@ -30,6 +30,7 @@ This module deploys an event hub namespace. ## Parameters **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `authorizationRules` | _[authorizationRules](authorizationRules/readme.md)_ array | `[System.Collections.Hashtable]` | | Authorization Rules for the Event Hub namespace. | diff --git a/modules/Microsoft.HealthBot/healthBots/readme.md b/modules/Microsoft.HealthBot/healthBots/readme.md index b6321201fd..dfd791ad66 100644 --- a/modules/Microsoft.HealthBot/healthBots/readme.md +++ b/modules/Microsoft.HealthBot/healthBots/readme.md @@ -21,11 +21,13 @@ This module deploys an Azure Health Bot. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the resource. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Insights/actionGroups/readme.md b/modules/Microsoft.Insights/actionGroups/readme.md index 21b0ddd97f..513cd09170 100644 --- a/modules/Microsoft.Insights/actionGroups/readme.md +++ b/modules/Microsoft.Insights/actionGroups/readme.md @@ -20,12 +20,14 @@ This module deploys an Action Group. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `groupShortName` | string | The short name of the action group. | | `name` | string | The name of the action group. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `armRoleReceivers` | array | `[]` | The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported. | diff --git a/modules/Microsoft.Insights/activityLogAlerts/readme.md b/modules/Microsoft.Insights/activityLogAlerts/readme.md index 718d660d24..2f94990f2d 100644 --- a/modules/Microsoft.Insights/activityLogAlerts/readme.md +++ b/modules/Microsoft.Insights/activityLogAlerts/readme.md @@ -20,12 +20,14 @@ This module deploys an Alert based on Activity Log. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `conditions` | array | The condition that will cause this alert to activate. Array of objects. | | `name` | string | The name of the alert. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | The list of actions to take when alert triggers. | diff --git a/modules/Microsoft.Insights/components/readme.md b/modules/Microsoft.Insights/components/readme.md index 6677bca0c8..c2976b232b 100644 --- a/modules/Microsoft.Insights/components/readme.md +++ b/modules/Microsoft.Insights/components/readme.md @@ -18,12 +18,14 @@ ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Application Insights. | | `workspaceResourceId` | string | Resource ID of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `appInsightsType` | string | `'web'` | `[other, web]` | Application type. | diff --git a/modules/Microsoft.Insights/diagnosticSettings/readme.md b/modules/Microsoft.Insights/diagnosticSettings/readme.md index 5ec7eb3251..94034f09b2 100644 --- a/modules/Microsoft.Insights/diagnosticSettings/readme.md +++ b/modules/Microsoft.Insights/diagnosticSettings/readme.md @@ -19,6 +19,7 @@ This module deploys a subscription wide export of the activity log. ## Parameters **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Insights/metricAlerts/readme.md b/modules/Microsoft.Insights/metricAlerts/readme.md index 48ec87d13e..1ab99d8aa7 100644 --- a/modules/Microsoft.Insights/metricAlerts/readme.md +++ b/modules/Microsoft.Insights/metricAlerts/readme.md @@ -20,18 +20,21 @@ This module deploys an alert based on metrics. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `criterias` | array | Criterias to trigger the alert. Array of 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' or 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' objects. | | `name` | string | The name of the alert. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `targetResourceRegion` | string | `''` | The region of the target resource(s) on which the alert is created/updated. Required if alertCriteriaType is MultipleResourceMultipleMetricCriteria. | | `targetResourceType` | string | `''` | The resource type of the target resource(s) on which the alert is created/updated. Required if alertCriteriaType is MultipleResourceMultipleMetricCriteria. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | | The list of actions to take when alert triggers. | diff --git a/modules/Microsoft.Insights/privateLinkScopes/readme.md b/modules/Microsoft.Insights/privateLinkScopes/readme.md index 2951b5322a..1fb8b497f0 100644 --- a/modules/Microsoft.Insights/privateLinkScopes/readme.md +++ b/modules/Microsoft.Insights/privateLinkScopes/readme.md @@ -24,11 +24,13 @@ This module deploys an Azure Monitor Private Link Scope. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the private link scope. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Insights/privateLinkScopes/scopedResources/readme.md b/modules/Microsoft.Insights/privateLinkScopes/scopedResources/readme.md index c8dafec8a1..1b4edc048f 100644 --- a/modules/Microsoft.Insights/privateLinkScopes/scopedResources/readme.md +++ b/modules/Microsoft.Insights/privateLinkScopes/scopedResources/readme.md @@ -18,17 +18,20 @@ This module deploys Insights PrivateLinkScopes ScopedResources. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `linkedResourceId` | string | The resource ID of the scoped Azure monitor resource. | | `name` | string | Name of the private link scoped resource. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateLinkScopeName` | string | The name of the parent private link scope. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Insights/scheduledQueryRules/readme.md b/modules/Microsoft.Insights/scheduledQueryRules/readme.md index e61facec11..047dd5974e 100644 --- a/modules/Microsoft.Insights/scheduledQueryRules/readme.md +++ b/modules/Microsoft.Insights/scheduledQueryRules/readme.md @@ -20,12 +20,14 @@ This module deploys a scheduled query rule. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Alert. | | `scopes` | array | The list of resource IDs that this scheduled query rule is scoped to. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | | Actions to invoke when the alert fires. | diff --git a/modules/Microsoft.KeyVault/vaults/accessPolicies/readme.md b/modules/Microsoft.KeyVault/vaults/accessPolicies/readme.md index a656d8d5d5..0397bc042b 100644 --- a/modules/Microsoft.KeyVault/vaults/accessPolicies/readme.md +++ b/modules/Microsoft.KeyVault/vaults/accessPolicies/readme.md @@ -18,11 +18,13 @@ This module deploys key vault access policies. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `keyVaultName` | string | The name of the parent key vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `accessPolicies` | array | `[]` | An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. | diff --git a/modules/Microsoft.KeyVault/vaults/keys/readme.md b/modules/Microsoft.KeyVault/vaults/keys/readme.md index 6d4770ec50..a5862977e9 100644 --- a/modules/Microsoft.KeyVault/vaults/keys/readme.md +++ b/modules/Microsoft.KeyVault/vaults/keys/readme.md @@ -19,16 +19,19 @@ This module deploys a key vault key. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the key. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `keyVaultName` | string | The name of the parent key vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `attributesEnabled` | bool | `True` | | Determines whether the object is enabled. | diff --git a/modules/Microsoft.KeyVault/vaults/readme.md b/modules/Microsoft.KeyVault/vaults/readme.md index 8b1366e5af..d3b2e45a79 100644 --- a/modules/Microsoft.KeyVault/vaults/readme.md +++ b/modules/Microsoft.KeyVault/vaults/readme.md @@ -27,11 +27,13 @@ This module deploys a key vault and its child resources. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Key Vault. Must be globally unique. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `accessPolicies` | _[accessPolicies](accessPolicies/readme.md)_ array | `[]` | | Array of access policies object. | diff --git a/modules/Microsoft.KeyVault/vaults/secrets/readme.md b/modules/Microsoft.KeyVault/vaults/secrets/readme.md index 7316a5f218..84bc58e6f8 100644 --- a/modules/Microsoft.KeyVault/vaults/secrets/readme.md +++ b/modules/Microsoft.KeyVault/vaults/secrets/readme.md @@ -19,17 +19,20 @@ This module deploys a key vault secret. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the secret. | | `value` | secureString | The value of the secret. NOTE: "value" will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `keyVaultName` | string | The name of the parent key vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `attributesEnabled` | bool | `True` | Determines whether the object is enabled. | diff --git a/modules/Microsoft.KubernetesConfiguration/extensions/readme.md b/modules/Microsoft.KubernetesConfiguration/extensions/readme.md index 46c3302e95..3cb077e39e 100644 --- a/modules/Microsoft.KubernetesConfiguration/extensions/readme.md +++ b/modules/Microsoft.KubernetesConfiguration/extensions/readme.md @@ -37,6 +37,7 @@ For Details see [Prerequisites](https://docs.microsoft.com/en-us/azure/azure-arc ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `clusterName` | string | The name of the AKS cluster that should be configured. | @@ -44,6 +45,7 @@ For Details see [Prerequisites](https://docs.microsoft.com/en-us/azure/azure-arc | `name` | string | The name of the Flux Configuration. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `configurationProtectedSettings` | object | `{object}` | Configuration settings that are sensitive, as name-value pairs for configuring this extension. | diff --git a/modules/Microsoft.KubernetesConfiguration/fluxConfigurations/readme.md b/modules/Microsoft.KubernetesConfiguration/fluxConfigurations/readme.md index ad3b68f34f..f23c60f6a4 100644 --- a/modules/Microsoft.KubernetesConfiguration/fluxConfigurations/readme.md +++ b/modules/Microsoft.KubernetesConfiguration/fluxConfigurations/readme.md @@ -38,6 +38,7 @@ For Details see [Prerequisites](https://docs.microsoft.com/en-us/azure/azure-arc ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `clusterName` | string | | The name of the AKS cluster that should be configured. | @@ -47,6 +48,7 @@ For Details see [Prerequisites](https://docs.microsoft.com/en-us/azure/azure-arc | `sourceKind` | string | `[Bucket, GitRepository]` | Source Kind to pull the configuration data from. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `bucket` | object | `{object}` | Parameters to reconcile to the GitRepository source kind type. | diff --git a/modules/Microsoft.Logic/workflows/readme.md b/modules/Microsoft.Logic/workflows/readme.md index 4ae0fffda5..a5a3f95f01 100644 --- a/modules/Microsoft.Logic/workflows/readme.md +++ b/modules/Microsoft.Logic/workflows/readme.md @@ -22,11 +22,13 @@ This module deploys a Logic App resource. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The logic app workflow name. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `actionsAccessControlConfiguration` | object | `{object}` | | The access control configuration for workflow actions. | diff --git a/modules/Microsoft.MachineLearningServices/workspaces/computes/readme.md b/modules/Microsoft.MachineLearningServices/workspaces/computes/readme.md index d6c19de007..b5e14f3b8f 100644 --- a/modules/Microsoft.MachineLearningServices/workspaces/computes/readme.md +++ b/modules/Microsoft.MachineLearningServices/workspaces/computes/readme.md @@ -19,17 +19,20 @@ Attaching a compute is not idempotent and will fail in case you try to redeploy ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `computeType` | string | `[AKS, AmlCompute, ComputeInstance, Databricks, DataFactory, DataLakeAnalytics, HDInsight, Kubernetes, SynapseSpark, VirtualMachine]` | Set the object type. | | `name` | string | | Name of the compute. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `machineLearningWorkspaceName` | string | The name of the parent Machine Learning Workspace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `computeLocation` | string | `[resourceGroup().location]` | | Location for the underlying compute. Ignored when attaching a compute resource, i.e. when you provide a resource ID. | diff --git a/modules/Microsoft.MachineLearningServices/workspaces/readme.md b/modules/Microsoft.MachineLearningServices/workspaces/readme.md index d39335cc68..6afe96733b 100644 --- a/modules/Microsoft.MachineLearningServices/workspaces/readme.md +++ b/modules/Microsoft.MachineLearningServices/workspaces/readme.md @@ -25,6 +25,7 @@ This module deploys a Machine Learning Services Workspace. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `associatedApplicationInsightsResourceId` | string | | The resource ID of the associated Application Insights. | @@ -34,6 +35,7 @@ This module deploys a Machine Learning Services Workspace. | `sku` | string | `[Basic, Enterprise]` | Specifies the SKU, also referred as 'edition' of the Azure Machine Learning workspace. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `primaryUserAssignedIdentity` | string | `''` | The user assigned identity resource ID that represents the workspace identity. Required if 'userAssignedIdentities' is not empty and may not be used if 'systemAssignedIdentity' is enabled. | @@ -41,6 +43,7 @@ This module deploys a Machine Learning Services Workspace. | `userAssignedIdentities` | object | `{object}` | The ID(s) to assign to the resource. Required if `systemAssignedIdentity` is set to false. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `allowPublicAccessWhenBehindVnet` | bool | `False` | | The flag to indicate whether to allow public access when behind VNet. | diff --git a/modules/Microsoft.ManagedIdentity/userAssignedIdentities/readme.md b/modules/Microsoft.ManagedIdentity/userAssignedIdentities/readme.md index cd2c769292..275e199387 100644 --- a/modules/Microsoft.ManagedIdentity/userAssignedIdentities/readme.md +++ b/modules/Microsoft.ManagedIdentity/userAssignedIdentities/readme.md @@ -21,6 +21,7 @@ This module deploys a user assigned identity. ## Parameters **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ManagedServices/registrationDefinitions/readme.md b/modules/Microsoft.ManagedServices/registrationDefinitions/readme.md index 93f7080a60..8104adde5d 100644 --- a/modules/Microsoft.ManagedServices/registrationDefinitions/readme.md +++ b/modules/Microsoft.ManagedServices/registrationDefinitions/readme.md @@ -25,6 +25,7 @@ remote/managing tenant. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `authorizations` | array | Specify an array of objects, containing object of Azure Active Directory principalId, a Azure roleDefinitionId, and an optional principalIdDisplayName. The roleDefinition specified is granted to the principalId in the provider's Active Directory and the principalIdDisplayName is visible to customers. | @@ -33,6 +34,7 @@ remote/managing tenant. | `registrationDescription` | string | Description of the offer/registration. i.e. 'Managed by '. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Management/managementGroups/readme.md b/modules/Microsoft.Management/managementGroups/readme.md index 258b1bcf95..c18e6976db 100644 --- a/modules/Microsoft.Management/managementGroups/readme.md +++ b/modules/Microsoft.Management/managementGroups/readme.md @@ -25,11 +25,13 @@ This module has some known **limitations**: ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The group ID of the Management group. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `displayName` | string | `''` | The friendly name of the management group. If no value is passed then this field will be set to the group ID. | diff --git a/modules/Microsoft.NetApp/netAppAccounts/capacityPools/readme.md b/modules/Microsoft.NetApp/netAppAccounts/capacityPools/readme.md index 6bb72ca1d1..bc962ef40c 100644 --- a/modules/Microsoft.NetApp/netAppAccounts/capacityPools/readme.md +++ b/modules/Microsoft.NetApp/netAppAccounts/capacityPools/readme.md @@ -20,17 +20,20 @@ This template deploys capacity pools in an Azure NetApp Files. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the capacity pool. | | `size` | int | Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `netAppAccountName` | string | The name of the parent NetApp account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `coolAccess` | bool | `False` | | If enabled (true) the pool can contain cool Access enabled volumes. | diff --git a/modules/Microsoft.NetApp/netAppAccounts/capacityPools/volumes/readme.md b/modules/Microsoft.NetApp/netAppAccounts/capacityPools/volumes/readme.md index 0b3465306b..0fb326bfa2 100644 --- a/modules/Microsoft.NetApp/netAppAccounts/capacityPools/volumes/readme.md +++ b/modules/Microsoft.NetApp/netAppAccounts/capacityPools/volumes/readme.md @@ -19,6 +19,7 @@ This template deploys volumes in a capacity pool of an Azure NetApp files. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the pool volume. | @@ -26,12 +27,14 @@ This template deploys volumes in a capacity pool of an Azure NetApp files. | `usageThreshold` | int | Maximum storage quota allowed for a file system in bytes. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `capacityPoolName` | string | The name of the parent capacity pool. Required if the template is used in a standalone deployment. | | `netAppAccountName` | string | The name of the parent NetApp account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `creationToken` | string | `[parameters('name')]` | | A unique file path for the volume. This is the name of the volume export. A volume is mounted using the export path. File path must start with an alphabetical character and be unique within the subscription. | diff --git a/modules/Microsoft.NetApp/netAppAccounts/readme.md b/modules/Microsoft.NetApp/netAppAccounts/readme.md index 72650e6b1b..3f686a819b 100644 --- a/modules/Microsoft.NetApp/netAppAccounts/readme.md +++ b/modules/Microsoft.NetApp/netAppAccounts/readme.md @@ -23,11 +23,13 @@ This template deploys Azure NetApp Files. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the NetApp account. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `capacityPools` | _[capacityPools](capacityPools/readme.md)_ array | `[]` | | Capacity pools to create. | diff --git a/modules/Microsoft.Network/applicationGateways/readme.md b/modules/Microsoft.Network/applicationGateways/readme.md index bb3e5889c4..f45995f498 100644 --- a/modules/Microsoft.Network/applicationGateways/readme.md +++ b/modules/Microsoft.Network/applicationGateways/readme.md @@ -22,11 +22,13 @@ This module deploys Network ApplicationGateways. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Application Gateway. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `authenticationCertificates` | array | `[]` | | Authentication certificates of the application gateway resource. | diff --git a/modules/Microsoft.Network/applicationSecurityGroups/readme.md b/modules/Microsoft.Network/applicationSecurityGroups/readme.md index 66b053aa02..b6477d2b05 100644 --- a/modules/Microsoft.Network/applicationSecurityGroups/readme.md +++ b/modules/Microsoft.Network/applicationSecurityGroups/readme.md @@ -21,11 +21,13 @@ This module deploys an application security group. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Application Security Group. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/azureFirewalls/readme.md b/modules/Microsoft.Network/azureFirewalls/readme.md index deb2c768d0..b993f1e062 100644 --- a/modules/Microsoft.Network/azureFirewalls/readme.md +++ b/modules/Microsoft.Network/azureFirewalls/readme.md @@ -24,12 +24,14 @@ This module deploys a firewall. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Azure Firewall. | | `vNetId` | string | Shared services Virtual Network resource ID. The virtual network ID containing AzureFirewallSubnet. If a public ip is not provided, then the public ip that is created as part of this module will be applied with the subnet provided in this variable. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `additionalPublicIpConfigurations` | array | `[]` | | This is to add any additional public ip configurations on top of the public ip with subnet ip configuration. | diff --git a/modules/Microsoft.Network/bastionHosts/readme.md b/modules/Microsoft.Network/bastionHosts/readme.md index 854f8cc84b..f5f8cf51ef 100644 --- a/modules/Microsoft.Network/bastionHosts/readme.md +++ b/modules/Microsoft.Network/bastionHosts/readme.md @@ -23,12 +23,14 @@ This module deploys a bastion host. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Azure Bastion resource. | | `vNetId` | string | Shared services Virtual Network resource identifier. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `azureBastionSubnetPublicIpId` | string | `''` | | The public ip resource ID to associate to the azureBastionSubnet. If empty, then the public ip that is created as part of this module will be applied to the azureBastionSubnet. | diff --git a/modules/Microsoft.Network/connections/readme.md b/modules/Microsoft.Network/connections/readme.md index 910668127d..8fc992059a 100644 --- a/modules/Microsoft.Network/connections/readme.md +++ b/modules/Microsoft.Network/connections/readme.md @@ -20,12 +20,14 @@ This template deploys a virtual network gateway connection. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Remote connection name. | | `virtualNetworkGateway1` | object | The primary Virtual Network Gateway. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `customIPSecPolicy` | object | `{object}` | | The IPSec Policies to be considered by this connection. | diff --git a/modules/Microsoft.Network/ddosProtectionPlans/readme.md b/modules/Microsoft.Network/ddosProtectionPlans/readme.md index 55fe2f2f01..9506379713 100644 --- a/modules/Microsoft.Network/ddosProtectionPlans/readme.md +++ b/modules/Microsoft.Network/ddosProtectionPlans/readme.md @@ -21,11 +21,13 @@ This template deploys a DDoS protection plan. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the DDoS protection plan to assign the VNET to. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/expressRouteCircuits/readme.md b/modules/Microsoft.Network/expressRouteCircuits/readme.md index 201f243334..0e2e2e99a4 100644 --- a/modules/Microsoft.Network/expressRouteCircuits/readme.md +++ b/modules/Microsoft.Network/expressRouteCircuits/readme.md @@ -22,6 +22,7 @@ This template deploys an express route circuit. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `bandwidthInMbps` | int | This is the bandwidth in Mbps of the circuit being created. It must exactly match one of the available bandwidth offers List ExpressRoute Service Providers API call. | @@ -30,6 +31,7 @@ This template deploys an express route circuit. | `serviceProviderName` | string | This is the name of the ExpressRoute Service Provider. It must exactly match one of the Service Providers from List ExpressRoute Service Providers API call. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Network/firewallPolicies/readme.md b/modules/Microsoft.Network/firewallPolicies/readme.md index cfc10fdf23..2bffd22402 100644 --- a/modules/Microsoft.Network/firewallPolicies/readme.md +++ b/modules/Microsoft.Network/firewallPolicies/readme.md @@ -20,11 +20,13 @@ This module deploys Firewall Policies. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Firewall Policy. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `basePolicyResourceId` | string | `''` | | Resource ID of the base policy. | diff --git a/modules/Microsoft.Network/firewallPolicies/ruleCollectionGroups/readme.md b/modules/Microsoft.Network/firewallPolicies/ruleCollectionGroups/readme.md index fdde3371a8..5646c641f5 100644 --- a/modules/Microsoft.Network/firewallPolicies/ruleCollectionGroups/readme.md +++ b/modules/Microsoft.Network/firewallPolicies/ruleCollectionGroups/readme.md @@ -18,17 +18,20 @@ This module deploys Network Firewall Policies Rule Collection Groups. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the rule collection group to deploy. | | `priority` | int | Priority of the Firewall Policy Rule Collection Group resource. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `firewallPolicyName` | string | The name of the parent Firewall Policy. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/frontDoors/readme.md b/modules/Microsoft.Network/frontDoors/readme.md index 05d36d46f4..002214e25e 100644 --- a/modules/Microsoft.Network/frontDoors/readme.md +++ b/modules/Microsoft.Network/frontDoors/readme.md @@ -23,11 +23,13 @@ This module deploys Front Doors. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the frontDoor. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `backendPools` | array | `[]` | | Backend address pool of the frontdoor resource. | diff --git a/modules/Microsoft.Network/ipGroups/readme.md b/modules/Microsoft.Network/ipGroups/readme.md index 799e5c7e15..f9a7ea097c 100644 --- a/modules/Microsoft.Network/ipGroups/readme.md +++ b/modules/Microsoft.Network/ipGroups/readme.md @@ -21,11 +21,13 @@ This module deploys an IP group. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the ipGroups. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/loadBalancers/backendAddressPools/readme.md b/modules/Microsoft.Network/loadBalancers/backendAddressPools/readme.md index feebf3343c..9f4b5aefdc 100644 --- a/modules/Microsoft.Network/loadBalancers/backendAddressPools/readme.md +++ b/modules/Microsoft.Network/loadBalancers/backendAddressPools/readme.md @@ -18,16 +18,19 @@ This module deploys load balancer backend address pools. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the backend address pool. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `loadBalancerName` | string | The name of the parent load balancer. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/loadBalancers/inboundNatRules/readme.md b/modules/Microsoft.Network/loadBalancers/inboundNatRules/readme.md index 83bc474485..7d494f15a1 100644 --- a/modules/Microsoft.Network/loadBalancers/inboundNatRules/readme.md +++ b/modules/Microsoft.Network/loadBalancers/inboundNatRules/readme.md @@ -18,6 +18,7 @@ This module deploys load balancers inbound NAT rules. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `frontendIPConfigurationName` | string | The name of the frontend IP address to set for the inbound NAT rule. | @@ -25,11 +26,13 @@ This module deploys load balancers inbound NAT rules. | `name` | string | The name of the inbound NAT rule. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `loadBalancerName` | string | The name of the parent load balancer. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `backendAddressPoolName` | string | `''` | | Name of the backend address pool. | diff --git a/modules/Microsoft.Network/loadBalancers/readme.md b/modules/Microsoft.Network/loadBalancers/readme.md index 1556a0cadd..57d4dd823e 100644 --- a/modules/Microsoft.Network/loadBalancers/readme.md +++ b/modules/Microsoft.Network/loadBalancers/readme.md @@ -24,12 +24,14 @@ This module deploys a load balancer. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `frontendIPConfigurations` | array | Array of objects containing all frontend IP configurations. | | `name` | string | The Proximity Placement Groups Name. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `backendAddressPools` | _[backendAddressPools](backendAddressPools/readme.md)_ array | `[]` | | Collection of backend address pools used by a load balancer. | diff --git a/modules/Microsoft.Network/localNetworkGateways/readme.md b/modules/Microsoft.Network/localNetworkGateways/readme.md index 6a078ec77e..1e541a19da 100644 --- a/modules/Microsoft.Network/localNetworkGateways/readme.md +++ b/modules/Microsoft.Network/localNetworkGateways/readme.md @@ -21,6 +21,7 @@ This module deploys a local network gateway. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `localAddressPrefixes` | array | List of the local (on-premises) IP address ranges. | @@ -28,6 +29,7 @@ This module deploys a local network gateway. | `name` | string | Name of the Local Network Gateway. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/natGateways/readme.md b/modules/Microsoft.Network/natGateways/readme.md index c91215ddd6..fcb6ede9f6 100644 --- a/modules/Microsoft.Network/natGateways/readme.md +++ b/modules/Microsoft.Network/natGateways/readme.md @@ -23,11 +23,13 @@ This module deploys a NAT gateway. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Azure Bastion resource. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Network/networkInterfaces/readme.md b/modules/Microsoft.Network/networkInterfaces/readme.md index d8c675db66..26e9493087 100644 --- a/modules/Microsoft.Network/networkInterfaces/readme.md +++ b/modules/Microsoft.Network/networkInterfaces/readme.md @@ -22,12 +22,14 @@ This module deploys Network Interfaces. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `ipConfigurations` | array | A list of IPConfigurations of the network interface. | | `name` | string | The name of the network interface. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Network/networkSecurityGroups/readme.md b/modules/Microsoft.Network/networkSecurityGroups/readme.md index fd8c232d9a..b7d695c058 100644 --- a/modules/Microsoft.Network/networkSecurityGroups/readme.md +++ b/modules/Microsoft.Network/networkSecurityGroups/readme.md @@ -23,11 +23,13 @@ This template deploys a network security group (NSG) with optional security rule ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Network Security Group. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Network/networkSecurityGroups/securityRules/readme.md b/modules/Microsoft.Network/networkSecurityGroups/securityRules/readme.md index f17dbaafca..dbcc9abd71 100644 --- a/modules/Microsoft.Network/networkSecurityGroups/securityRules/readme.md +++ b/modules/Microsoft.Network/networkSecurityGroups/securityRules/readme.md @@ -18,6 +18,7 @@ This module deploys Network Security Group Security Rules. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `direction` | string | `[Inbound, Outbound]` | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. | @@ -26,11 +27,13 @@ This module deploys Network Security Group Security Rules. | `protocol` | string | `[*, Ah, Esp, Icmp, Tcp, Udp]` | Network protocol this rule applies to. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `networkSecurityGroupName` | string | The name of the parent network security group to deploy the security rule into. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `access` | string | `'Deny'` | `[Allow, Deny]` | Whether network traffic is allowed or denied. | diff --git a/modules/Microsoft.Network/networkWatchers/connectionMonitors/readme.md b/modules/Microsoft.Network/networkWatchers/connectionMonitors/readme.md index fe97daab3d..8e5517f1d7 100644 --- a/modules/Microsoft.Network/networkWatchers/connectionMonitors/readme.md +++ b/modules/Microsoft.Network/networkWatchers/connectionMonitors/readme.md @@ -18,11 +18,13 @@ This template deploys Connection Monitors. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the resource. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/networkWatchers/flowLogs/readme.md b/modules/Microsoft.Network/networkWatchers/flowLogs/readme.md index 54e017358e..7080d780f4 100644 --- a/modules/Microsoft.Network/networkWatchers/flowLogs/readme.md +++ b/modules/Microsoft.Network/networkWatchers/flowLogs/readme.md @@ -19,12 +19,14 @@ This module controls the Network Security Group Flow Logs and analytics settings ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `storageId` | string | Resource ID of the diagnostic storage account. | | `targetResourceId` | string | Resource ID of the NSG that must be enabled for Flow Logs. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enabled` | bool | `True` | | If the flow log should be enabled. | diff --git a/modules/Microsoft.Network/networkWatchers/readme.md b/modules/Microsoft.Network/networkWatchers/readme.md index 545438af93..eaf55eb3d0 100644 --- a/modules/Microsoft.Network/networkWatchers/readme.md +++ b/modules/Microsoft.Network/networkWatchers/readme.md @@ -24,6 +24,7 @@ ## Parameters **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `connectionMonitors` | _[connectionMonitors](connectionMonitors/readme.md)_ array | `[]` | | Array that contains the Connection Monitors. | diff --git a/modules/Microsoft.Network/privateDnsZones/A/readme.md b/modules/Microsoft.Network/privateDnsZones/A/readme.md index 4883174f84..50598645f8 100644 --- a/modules/Microsoft.Network/privateDnsZones/A/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/A/readme.md @@ -19,16 +19,19 @@ This module deploys a Private DNS Zone A record. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the A record. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `aRecords` | array | `[]` | The list of A records in the record set. | diff --git a/modules/Microsoft.Network/privateDnsZones/AAAA/readme.md b/modules/Microsoft.Network/privateDnsZones/AAAA/readme.md index 08e641d3e4..d56a039b62 100644 --- a/modules/Microsoft.Network/privateDnsZones/AAAA/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/AAAA/readme.md @@ -19,16 +19,19 @@ This module deploys a Private DNS Zone AAAA record. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the AAAA record. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `aaaaRecords` | array | `[]` | The list of AAAA records in the record set. | diff --git a/modules/Microsoft.Network/privateDnsZones/CNAME/readme.md b/modules/Microsoft.Network/privateDnsZones/CNAME/readme.md index a7c6c05eb3..fa0da16115 100644 --- a/modules/Microsoft.Network/privateDnsZones/CNAME/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/CNAME/readme.md @@ -19,16 +19,19 @@ This module deploys a Private DNS Zone CNAME record. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the CNAME record. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `cnameRecord` | object | `{object}` | A CNAME record. | diff --git a/modules/Microsoft.Network/privateDnsZones/MX/readme.md b/modules/Microsoft.Network/privateDnsZones/MX/readme.md index 45502256ca..f5f507f9dc 100644 --- a/modules/Microsoft.Network/privateDnsZones/MX/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/MX/readme.md @@ -19,16 +19,19 @@ This module deploys a Private DNS Zone MX record. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the MX record. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/privateDnsZones/PTR/readme.md b/modules/Microsoft.Network/privateDnsZones/PTR/readme.md index efbef03cdc..77ae67ac1a 100644 --- a/modules/Microsoft.Network/privateDnsZones/PTR/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/PTR/readme.md @@ -19,16 +19,19 @@ This module deploys a Private DNS Zone PTR record. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the PTR record. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/privateDnsZones/SOA/readme.md b/modules/Microsoft.Network/privateDnsZones/SOA/readme.md index 550afa2da3..28f0f30ae2 100644 --- a/modules/Microsoft.Network/privateDnsZones/SOA/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/SOA/readme.md @@ -19,16 +19,19 @@ This module deploys a Private DNS Zone SOA record. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the SOA record. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/privateDnsZones/SRV/readme.md b/modules/Microsoft.Network/privateDnsZones/SRV/readme.md index 26b9270153..ad8586c61d 100644 --- a/modules/Microsoft.Network/privateDnsZones/SRV/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/SRV/readme.md @@ -19,16 +19,19 @@ This module deploys a Private DNS Zone TXT record. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the SRV record. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/privateDnsZones/TXT/readme.md b/modules/Microsoft.Network/privateDnsZones/TXT/readme.md index 903615d3ff..869bf89045 100644 --- a/modules/Microsoft.Network/privateDnsZones/TXT/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/TXT/readme.md @@ -19,16 +19,19 @@ This module deploys a Private DNS Zone TXT record. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the TXT record. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/privateDnsZones/readme.md b/modules/Microsoft.Network/privateDnsZones/readme.md index 7c90f9d89c..37bd7c55c3 100644 --- a/modules/Microsoft.Network/privateDnsZones/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/readme.md @@ -30,11 +30,13 @@ This template deploys a private DNS zone. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Private DNS zone name. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `a` | _[a](a/readme.md)_ array | `[]` | | Array of A records. | diff --git a/modules/Microsoft.Network/privateDnsZones/virtualNetworkLinks/readme.md b/modules/Microsoft.Network/privateDnsZones/virtualNetworkLinks/readme.md index db28d9654a..c10d1cdb6a 100644 --- a/modules/Microsoft.Network/privateDnsZones/virtualNetworkLinks/readme.md +++ b/modules/Microsoft.Network/privateDnsZones/virtualNetworkLinks/readme.md @@ -18,16 +18,19 @@ This module deploys private dns zone virtual network links. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `virtualNetworkResourceId` | string | Link to another virtual network resource ID. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDnsZoneName` | string | The name of the parent Private DNS zone. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/privateEndpoints/privateDnsZoneGroups/readme.md b/modules/Microsoft.Network/privateEndpoints/privateDnsZoneGroups/readme.md index 1cecdaa66a..d341ce933f 100644 --- a/modules/Microsoft.Network/privateEndpoints/privateDnsZoneGroups/readme.md +++ b/modules/Microsoft.Network/privateEndpoints/privateDnsZoneGroups/readme.md @@ -18,16 +18,19 @@ This module deploys a private endpoint private DNS zone group ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateDNSResourceIds` | array | Array of private DNS zone resource IDs. A DNS zone group can support up to 5 DNS zones. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `privateEndpointName` | string | The name of the parent private endpoint. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/privateEndpoints/readme.md b/modules/Microsoft.Network/privateEndpoints/readme.md index 16798e0db2..dc8d90a6b7 100644 --- a/modules/Microsoft.Network/privateEndpoints/readme.md +++ b/modules/Microsoft.Network/privateEndpoints/readme.md @@ -32,6 +32,7 @@ The following resources are required to be able to deploy this resource: ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `groupIds` | array | Subtype(s) of the connection to be created. The allowed values depend on the type serviceResourceId refers to. | @@ -40,6 +41,7 @@ The following resources are required to be able to deploy this resource: | `subnetResourceId` | string | Resource ID of the subnet where the endpoint needs to be created. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `customDnsConfigs` | array | `[]` | | Custom DNS configurations. | diff --git a/modules/Microsoft.Network/privateLinkServices/readme.md b/modules/Microsoft.Network/privateLinkServices/readme.md index 81136df2d7..71c0f2c6b0 100644 --- a/modules/Microsoft.Network/privateLinkServices/readme.md +++ b/modules/Microsoft.Network/privateLinkServices/readme.md @@ -21,11 +21,13 @@ This module deploys Network Private Link Services. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the private link service to create. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `autoApproval` | object | `{object}` | | The auto-approval list of the private link service. | diff --git a/modules/Microsoft.Network/publicIPAddresses/readme.md b/modules/Microsoft.Network/publicIPAddresses/readme.md index 3d9e49df16..5c222f652e 100644 --- a/modules/Microsoft.Network/publicIPAddresses/readme.md +++ b/modules/Microsoft.Network/publicIPAddresses/readme.md @@ -20,11 +20,13 @@ ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Public IP Address. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Network/publicIPPrefixes/readme.md b/modules/Microsoft.Network/publicIPPrefixes/readme.md index 1545c706c5..3fdc3cb762 100644 --- a/modules/Microsoft.Network/publicIPPrefixes/readme.md +++ b/modules/Microsoft.Network/publicIPPrefixes/readme.md @@ -21,12 +21,14 @@ This template deploys a public IP prefix. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Public IP Prefix. | | `prefixLength` | int | Length of the Public IP Prefix. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/routeTables/readme.md b/modules/Microsoft.Network/routeTables/readme.md index f5ca069bb3..32ed3a8daf 100644 --- a/modules/Microsoft.Network/routeTables/readme.md +++ b/modules/Microsoft.Network/routeTables/readme.md @@ -21,11 +21,13 @@ This module deploys a user defined route table. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name given for the hub route table. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `disableBgpRoutePropagation` | bool | `False` | | Switch to disable BGP route propagation. | diff --git a/modules/Microsoft.Network/trafficmanagerprofiles/readme.md b/modules/Microsoft.Network/trafficmanagerprofiles/readme.md index 93ab65d388..8e709da03f 100644 --- a/modules/Microsoft.Network/trafficmanagerprofiles/readme.md +++ b/modules/Microsoft.Network/trafficmanagerprofiles/readme.md @@ -22,12 +22,14 @@ This module deploys a traffic manager profile. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Traffic Manager. | | `relativeName` | string | The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Network/virtualHubs/hubRouteTables/readme.md b/modules/Microsoft.Network/virtualHubs/hubRouteTables/readme.md index 5801b2c82d..731ee6fbc1 100644 --- a/modules/Microsoft.Network/virtualHubs/hubRouteTables/readme.md +++ b/modules/Microsoft.Network/virtualHubs/hubRouteTables/readme.md @@ -18,16 +18,19 @@ This module deploys virtual hub route tables. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The route table name. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `virtualHubName` | string | The name of the parent virtual hub. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/virtualHubs/hubVirtualNetworkConnections/readme.md b/modules/Microsoft.Network/virtualHubs/hubVirtualNetworkConnections/readme.md index cb1a7411cd..4e5a7bb4f5 100644 --- a/modules/Microsoft.Network/virtualHubs/hubVirtualNetworkConnections/readme.md +++ b/modules/Microsoft.Network/virtualHubs/hubVirtualNetworkConnections/readme.md @@ -18,17 +18,20 @@ This module deploys virtual hub virtual network connections. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The connection name. | | `remoteVirtualNetworkId` | string | Resource ID of the virtual network to link to. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `virtualHubName` | string | The name of the parent virtual hub. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/virtualHubs/readme.md b/modules/Microsoft.Network/virtualHubs/readme.md index b6caea64aa..881525cfdf 100644 --- a/modules/Microsoft.Network/virtualHubs/readme.md +++ b/modules/Microsoft.Network/virtualHubs/readme.md @@ -22,6 +22,7 @@ This module deploys a Virtual Hub. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `addressPrefix` | string | Address-prefix for this VirtualHub. | @@ -29,6 +30,7 @@ This module deploys a Virtual Hub. | `virtualWanId` | string | Resource ID of the virtual WAN to link to. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `allowBranchToBranchTraffic` | bool | `True` | | Flag to control transit for VirtualRouter hub. | diff --git a/modules/Microsoft.Network/virtualNetworkGateways/readme.md b/modules/Microsoft.Network/virtualNetworkGateways/readme.md index 7d631c96f7..d27603bd26 100644 --- a/modules/Microsoft.Network/virtualNetworkGateways/readme.md +++ b/modules/Microsoft.Network/virtualNetworkGateways/readme.md @@ -23,6 +23,7 @@ This module deploys a virtual network gateway. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `name` | string | | Specifies the Virtual Network Gateway name. | @@ -31,6 +32,7 @@ This module deploys a virtual network gateway. | `vNetResourceId` | string | | Virtual Network resource ID. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `activeActive` | bool | `True` | | Value to specify if the Gateway should be deployed in active-active or active-passive configuration. | diff --git a/modules/Microsoft.Network/virtualNetworks/readme.md b/modules/Microsoft.Network/virtualNetworks/readme.md index 325be20e03..376c32ccf1 100644 --- a/modules/Microsoft.Network/virtualNetworks/readme.md +++ b/modules/Microsoft.Network/virtualNetworks/readme.md @@ -25,12 +25,14 @@ This template deploys a virtual network (vNet). ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `addressPrefixes` | array | An Array of 1 or more IP Address Prefixes for the Virtual Network. | | `name` | string | The Virtual Network (vNet) Name. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `ddosProtectionPlanId` | string | `''` | | Resource ID of the DDoS protection plan to assign the VNET to. If it's left blank, DDoS protection will not be configured. If it's provided, the VNET created by this template will be attached to the referenced DDoS protection plan. The DDoS protection plan can exist in the same or in a different subscription. | diff --git a/modules/Microsoft.Network/virtualNetworks/subnets/readme.md b/modules/Microsoft.Network/virtualNetworks/subnets/readme.md index 60619d57be..ee2264513f 100644 --- a/modules/Microsoft.Network/virtualNetworks/subnets/readme.md +++ b/modules/Microsoft.Network/virtualNetworks/subnets/readme.md @@ -20,16 +20,19 @@ This module deploys a virtual network subnet. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `addressPrefix` | string | The address prefix for the subnet. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `virtualNetworkName` | string | The name of the parent virtual network. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `addressPrefixes` | array | `[]` | | List of address prefixes for the subnet. | diff --git a/modules/Microsoft.Network/virtualNetworks/virtualNetworkPeerings/readme.md b/modules/Microsoft.Network/virtualNetworks/virtualNetworkPeerings/readme.md index 55a11de9d4..1663e30c8d 100644 --- a/modules/Microsoft.Network/virtualNetworks/virtualNetworkPeerings/readme.md +++ b/modules/Microsoft.Network/virtualNetworks/virtualNetworkPeerings/readme.md @@ -25,16 +25,19 @@ The following resources are required to be able to deploy this resource. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `remoteVirtualNetworkId` | string | The Resource ID of the VNet that is this Local VNet is being peered to. Should be in the format of a Resource ID. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `localVnetName` | string | The name of the parent Virtual Network to add the peering to. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `allowForwardedTraffic` | bool | `True` | Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. Default is true. | diff --git a/modules/Microsoft.Network/virtualWans/readme.md b/modules/Microsoft.Network/virtualWans/readme.md index bc125b6098..15caaa96a5 100644 --- a/modules/Microsoft.Network/virtualWans/readme.md +++ b/modules/Microsoft.Network/virtualWans/readme.md @@ -21,11 +21,13 @@ This template deploys a virtual WAN. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Virtual WAN. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `allowBranchToBranchTraffic` | bool | `False` | | True if branch to branch traffic is allowed. | diff --git a/modules/Microsoft.Network/vpnGateways/connections/readme.md b/modules/Microsoft.Network/vpnGateways/connections/readme.md index 5e8e9ad4a5..5d14ba5b2d 100644 --- a/modules/Microsoft.Network/vpnGateways/connections/readme.md +++ b/modules/Microsoft.Network/vpnGateways/connections/readme.md @@ -18,16 +18,19 @@ This module deploys VPN Gateways Connections. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the VPN connection. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `vpnGatewayName` | string | The name of the parent VPN gateway this VPN connection is associated with. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `connectionBandwidth` | int | `10` | | Expected bandwidth in MBPS. | diff --git a/modules/Microsoft.Network/vpnGateways/natRules/readme.md b/modules/Microsoft.Network/vpnGateways/natRules/readme.md index ded29c96d5..3c91c94a38 100644 --- a/modules/Microsoft.Network/vpnGateways/natRules/readme.md +++ b/modules/Microsoft.Network/vpnGateways/natRules/readme.md @@ -18,16 +18,19 @@ This module deploys VPN Gateways NATRules ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the NAT rule. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `vpnGatewayName` | string | The name of the parent VPN gateway this NAT rule is associated with. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Network/vpnGateways/readme.md b/modules/Microsoft.Network/vpnGateways/readme.md index 3827325c9c..0e2968839a 100644 --- a/modules/Microsoft.Network/vpnGateways/readme.md +++ b/modules/Microsoft.Network/vpnGateways/readme.md @@ -22,12 +22,14 @@ This module deploys VPN Gateways. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the VPN gateway. | | `virtualHubResourceId` | string | The resource ID of a virtual Hub to connect to. Note: The virtual Hub and Gateway must be deployed into the same location. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `bgpSettings` | object | `{object}` | | BGP settings details. | diff --git a/modules/Microsoft.Network/vpnSites/readme.md b/modules/Microsoft.Network/vpnSites/readme.md index 327ddb9d27..8f85cf0858 100644 --- a/modules/Microsoft.Network/vpnSites/readme.md +++ b/modules/Microsoft.Network/vpnSites/readme.md @@ -21,12 +21,14 @@ This module deploys a VPN Site. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the VPN Site. | | `virtualWanId` | string | Resource ID of the virtual WAN to link to. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `addressPrefixes` | array | `[]` | | An array of IP address ranges that can be used by subnets of the virtual network. Must be provided if no bgpProperties or VPNSiteLinks are configured. | diff --git a/modules/Microsoft.OperationalInsights/workspaces/dataSources/readme.md b/modules/Microsoft.OperationalInsights/workspaces/dataSources/readme.md index 0da03c56cd..5ba27accb3 100644 --- a/modules/Microsoft.OperationalInsights/workspaces/dataSources/readme.md +++ b/modules/Microsoft.OperationalInsights/workspaces/dataSources/readme.md @@ -18,17 +18,20 @@ This template deploys a data source for a Log Analytics workspace. ## Parameters **Required parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `kind` | string | `'AzureActivityLog'` | `[AzureActivityLog, IISLogs, LinuxPerformanceCollection, LinuxPerformanceObject, LinuxSyslog, LinuxSyslogCollection, WindowsEvent, WindowsPerformanceCounter]` | The kind of the DataSource. | | `name` | string | | | Name of the solution. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `logAnalyticsWorkspaceName` | string | The name of the parent Log Analytics workspace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `counterName` | string | `''` | Counter name to configure when kind is WindowsPerformanceCounter. | diff --git a/modules/Microsoft.OperationalInsights/workspaces/linkedServices/readme.md b/modules/Microsoft.OperationalInsights/workspaces/linkedServices/readme.md index 6fb2f4d1e0..8cab0153be 100644 --- a/modules/Microsoft.OperationalInsights/workspaces/linkedServices/readme.md +++ b/modules/Microsoft.OperationalInsights/workspaces/linkedServices/readme.md @@ -18,17 +18,20 @@ This template deploys a linked service for a Log Analytics workspace. ## Parameters **Required parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `name` | string | | Name of the link. | | `resourceId` | string | `''` | The resource ID of the resource that will be linked to the workspace. This should be used for linking resources which require read access. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `logAnalyticsWorkspaceName` | string | The name of the parent Log Analytics workspace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.OperationalInsights/workspaces/linkedStorageAccounts/readme.md b/modules/Microsoft.OperationalInsights/workspaces/linkedStorageAccounts/readme.md index 3d238d9618..12c7041eff 100644 --- a/modules/Microsoft.OperationalInsights/workspaces/linkedStorageAccounts/readme.md +++ b/modules/Microsoft.OperationalInsights/workspaces/linkedStorageAccounts/readme.md @@ -18,17 +18,20 @@ This template deploys a linked Storage Accounts for a Log Analytics workspace. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `name` | string | `[Alerts, AzureWatson, CustomLogs, Query]` | Name of the link. | | `resourceId` | string | | The resource ID of the resource that will be linked to the workspace. This should be used for linking resources which require read access. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `logAnalyticsWorkspaceName` | string | The name of the parent Log Analytics workspace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.OperationalInsights/workspaces/readme.md b/modules/Microsoft.OperationalInsights/workspaces/readme.md index 824f94c41d..def067e464 100644 --- a/modules/Microsoft.OperationalInsights/workspaces/readme.md +++ b/modules/Microsoft.OperationalInsights/workspaces/readme.md @@ -28,16 +28,19 @@ This template deploys a log analytics workspace. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Log Analytics workspace. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `linkedStorageAccounts` | _[linkedStorageAccounts](linkedStorageAccounts/readme.md)_ 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. | diff --git a/modules/Microsoft.OperationalInsights/workspaces/savedSearches/readme.md b/modules/Microsoft.OperationalInsights/workspaces/savedSearches/readme.md index e0d8716804..2405500cbf 100644 --- a/modules/Microsoft.OperationalInsights/workspaces/savedSearches/readme.md +++ b/modules/Microsoft.OperationalInsights/workspaces/savedSearches/readme.md @@ -18,6 +18,7 @@ This template deploys a saved search for a Log Analytics workspace. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `category` | string | Query category. | @@ -26,11 +27,13 @@ This template deploys a saved search for a Log Analytics workspace. | `query` | string | Kusto Query to be stored. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `logAnalyticsWorkspaceName` | string | The name of the parent Log Analytics workspace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.OperationalInsights/workspaces/storageInsightConfigs/readme.md b/modules/Microsoft.OperationalInsights/workspaces/storageInsightConfigs/readme.md index ec086b897a..9e1526040e 100644 --- a/modules/Microsoft.OperationalInsights/workspaces/storageInsightConfigs/readme.md +++ b/modules/Microsoft.OperationalInsights/workspaces/storageInsightConfigs/readme.md @@ -18,16 +18,19 @@ This template deploys a storage insights configuration for a Log Analytics works ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `storageAccountId` | string | The Azure Resource Manager ID of the storage account resource. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `logAnalyticsWorkspaceName` | string | The name of the parent Log Analytics workspace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `containers` | array | `[]` | The names of the blob containers that the workspace should read. | diff --git a/modules/Microsoft.OperationsManagement/solutions/readme.md b/modules/Microsoft.OperationsManagement/solutions/readme.md index e53e89e962..715f3460e6 100644 --- a/modules/Microsoft.OperationsManagement/solutions/readme.md +++ b/modules/Microsoft.OperationsManagement/solutions/readme.md @@ -19,12 +19,14 @@ This module deploys OperationsManagement Solutions. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `logAnalyticsWorkspaceName` | string | Name of the Log Analytics workspace where the solution will be deployed/enabled. | | `name` | string | Name of the solution. For Microsoft published gallery solution the target solution resource name will be composed as `{name}({logAnalyticsWorkspaceName})`. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.PowerBIDedicated/capacities/readme.md b/modules/Microsoft.PowerBIDedicated/capacities/readme.md index e5bb8332d5..86bcfe2c0c 100644 --- a/modules/Microsoft.PowerBIDedicated/capacities/readme.md +++ b/modules/Microsoft.PowerBIDedicated/capacities/readme.md @@ -21,6 +21,7 @@ This module deploys PowerBIDedicated Capacities. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `members` | array | Members of the resource. | @@ -28,6 +29,7 @@ This module deploys PowerBIDedicated Capacities. | `skuCapacity` | int | SkuCapacity of the resource. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `location` | string | `[resourceGroup().location]` | | Location for all Resources. | diff --git a/modules/Microsoft.RecoveryServices/vaults/backupConfig/readme.md b/modules/Microsoft.RecoveryServices/vaults/backupConfig/readme.md index 5378956990..9ab5e987d2 100644 --- a/modules/Microsoft.RecoveryServices/vaults/backupConfig/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/backupConfig/readme.md @@ -18,11 +18,13 @@ This module deploys recovery services vault backup config. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.RecoveryServices/vaults/backupPolicies/readme.md b/modules/Microsoft.RecoveryServices/vaults/backupPolicies/readme.md index 62e3046abf..55f32bb7ae 100644 --- a/modules/Microsoft.RecoveryServices/vaults/backupPolicies/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/backupPolicies/readme.md @@ -18,17 +18,20 @@ This module deploys a Backup Policy for a Recovery Services Vault ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `backupPolicyProperties` | object | Configuration of the Azure Recovery Service Vault Backup Policy. | | `name` | string | Name of the Azure Recovery Service Vault Backup Policy. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.RecoveryServices/vaults/backupStorageConfig/readme.md b/modules/Microsoft.RecoveryServices/vaults/backupStorageConfig/readme.md index c1008850a2..3ddd67d0c8 100644 --- a/modules/Microsoft.RecoveryServices/vaults/backupStorageConfig/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/backupStorageConfig/readme.md @@ -17,11 +17,13 @@ This module deploys the Backup Storage Configuration for the Recovery Service Va ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `crossRegionRestoreFlag` | bool | `True` | | Opt in details of Cross Region Restore feature. | diff --git a/modules/Microsoft.RecoveryServices/vaults/protectionContainers/protectedItems/readme.md b/modules/Microsoft.RecoveryServices/vaults/protectionContainers/protectedItems/readme.md index 1379744445..4393aea4cc 100644 --- a/modules/Microsoft.RecoveryServices/vaults/protectionContainers/protectedItems/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/protectionContainers/protectedItems/readme.md @@ -18,6 +18,7 @@ This module deploys a Protection Container Protected Item for a Recovery Service ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `name` | string | | Name of the resource. | @@ -26,12 +27,14 @@ This module deploys a Protection Container Protected Item for a Recovery Service | `sourceResourceId` | string | | Resource ID of the resource to back up. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `protectionContainerName` | string | Name of the Azure Recovery Service Vault Protection Container. Required if the template is used in a standalone deployment. | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.RecoveryServices/vaults/protectionContainers/readme.md b/modules/Microsoft.RecoveryServices/vaults/protectionContainers/readme.md index 3cfdef285e..c736b0efad 100644 --- a/modules/Microsoft.RecoveryServices/vaults/protectionContainers/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/protectionContainers/readme.md @@ -19,16 +19,19 @@ This module deploys a Protection Container for a Recovery Services Vault ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Azure Recovery Service Vault Protection Container. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `backupManagementType` | string | `''` | `['', AzureBackupServer, AzureIaasVM, AzureSql, AzureStorage, AzureWorkload, DefaultBackup, DPM, Invalid, MAB]` | Backup management type to execute the current Protection Container job. | diff --git a/modules/Microsoft.RecoveryServices/vaults/readme.md b/modules/Microsoft.RecoveryServices/vaults/readme.md index d176ab65c1..d090dce511 100644 --- a/modules/Microsoft.RecoveryServices/vaults/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/readme.md @@ -33,11 +33,13 @@ This module deploys a recovery service vault. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Azure Recovery Service Vault. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `backupConfig` | _[backupConfig](backupConfig/readme.md)_ object | `{object}` | | The backup configuration. | diff --git a/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/readme.md b/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/readme.md index 928952dceb..a2b7c02215 100644 --- a/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/readme.md @@ -22,16 +22,19 @@ This module deploys a Replication Fabric for Azure to Azure disaster recovery sc ## Parameters **Required parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `location` | string | `[resourceGroup().location]` | The recovery location the fabric represents. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/readme.md b/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/readme.md index eee3ee25ab..3a7c965f68 100644 --- a/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/readme.md @@ -21,17 +21,20 @@ This module deploys a Replication Protection Container. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the replication container. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | | `replicationFabricName` | string | The name of the parent Replication Fabric. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/readme.md b/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/readme.md index 4bcee937f3..cbee0072bb 100644 --- a/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/readme.md @@ -20,6 +20,7 @@ This module deploys a Replication Protection Container Mapping. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | @@ -27,6 +28,7 @@ This module deploys a Replication Protection Container Mapping. | `sourceProtectionContainerName` | string | The name of the parent source Replication container. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.RecoveryServices/vaults/replicationPolicies/readme.md b/modules/Microsoft.RecoveryServices/vaults/replicationPolicies/readme.md index f00e7a5af7..48470e81e5 100644 --- a/modules/Microsoft.RecoveryServices/vaults/replicationPolicies/readme.md +++ b/modules/Microsoft.RecoveryServices/vaults/replicationPolicies/readme.md @@ -20,16 +20,19 @@ This module deploys a Replication Policy for Disaster Recovery scenario. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the replication policy. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `recoveryVaultName` | string | The name of the parent Azure Recovery Service Vault. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `appConsistentFrequencyInMinutes` | int | `60` | | The app consistent snapshot frequency (in minutes). | diff --git a/modules/Microsoft.Resources/deploymentScripts/readme.md b/modules/Microsoft.Resources/deploymentScripts/readme.md index 37d74a8f35..9d856ecb6a 100644 --- a/modules/Microsoft.Resources/deploymentScripts/readme.md +++ b/modules/Microsoft.Resources/deploymentScripts/readme.md @@ -21,11 +21,13 @@ This module deploys a deployment script. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Display name of the script to be run. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `arguments` | string | `''` | | Command-line arguments to pass to the script. Arguments are separated by spaces. | @@ -48,6 +50,7 @@ This module deploys a deployment script. | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `baseTime` | string | `[utcNow('yyyy-MM-dd-HH-mm-ss')]` | Do not provide a value! This date value is used to make sure the script run every time the template is deployed. | diff --git a/modules/Microsoft.Resources/resourceGroups/readme.md b/modules/Microsoft.Resources/resourceGroups/readme.md index 465d3fef4b..056ed6fef7 100644 --- a/modules/Microsoft.Resources/resourceGroups/readme.md +++ b/modules/Microsoft.Resources/resourceGroups/readme.md @@ -22,11 +22,13 @@ This module deploys a resource group. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Resource Group. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Resources/tags/readme.md b/modules/Microsoft.Resources/tags/readme.md index cc35a94093..d0b3145135 100644 --- a/modules/Microsoft.Resources/tags/readme.md +++ b/modules/Microsoft.Resources/tags/readme.md @@ -19,6 +19,7 @@ This module deploys Resources Tags on a subscription or resource group scope. ## Parameters **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Resources/tags/resourceGroups/readme.md b/modules/Microsoft.Resources/tags/resourceGroups/readme.md index 7270c4dcf3..309b585300 100644 --- a/modules/Microsoft.Resources/tags/resourceGroups/readme.md +++ b/modules/Microsoft.Resources/tags/resourceGroups/readme.md @@ -18,6 +18,7 @@ This module deploys Resources Tags on a resource group scope. ## Parameters **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Resources/tags/subscriptions/readme.md b/modules/Microsoft.Resources/tags/subscriptions/readme.md index e3129f2bb0..24d29ae4eb 100644 --- a/modules/Microsoft.Resources/tags/subscriptions/readme.md +++ b/modules/Microsoft.Resources/tags/subscriptions/readme.md @@ -18,6 +18,7 @@ This module deploys Resources Tags on a subscription scope. ## Parameters **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Security/azureSecurityCenter/readme.md b/modules/Microsoft.Security/azureSecurityCenter/readme.md index ad45c55dd9..96c45b4c96 100644 --- a/modules/Microsoft.Security/azureSecurityCenter/readme.md +++ b/modules/Microsoft.Security/azureSecurityCenter/readme.md @@ -24,12 +24,14 @@ This template enables Azure security center - Standard tier by default, could be ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `scope` | string | All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope. | | `workspaceId` | string | The full Azure ID of the workspace to save the data in. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `appServicesPricingTier` | string | `'Free'` | `[Free, Standard]` | The pricing tier value for AppServices. Azure Security Center is provided in two pricing tiers: free and standard, with the standard tier available with a trial period. The standard tier offers advanced security capabilities, while the free tier offers basic security features. - Free or Standard. | diff --git a/modules/Microsoft.ServiceBus/namespaces/authorizationRules/readme.md b/modules/Microsoft.ServiceBus/namespaces/authorizationRules/readme.md index c775cc25a1..143c1779d9 100644 --- a/modules/Microsoft.ServiceBus/namespaces/authorizationRules/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/authorizationRules/readme.md @@ -18,16 +18,19 @@ This module deploys authorization rules for a service bus namespace ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the authorization rule. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent Service Bus Namespace for the Service Bus Queue. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs/readme.md b/modules/Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs/readme.md index 9660476d20..c1a02761d6 100644 --- a/modules/Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs/readme.md @@ -18,11 +18,13 @@ This module deploys a disaster recovery config for a service bus Namespace ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent Service Bus Namespace for the Service Bus Queue. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `alternateName` | string | `''` | Primary/Secondary eventhub namespace name, which is part of GEO DR pairing. | diff --git a/modules/Microsoft.ServiceBus/namespaces/migrationConfigurations/readme.md b/modules/Microsoft.ServiceBus/namespaces/migrationConfigurations/readme.md index 60ebea3c68..b572a462aa 100644 --- a/modules/Microsoft.ServiceBus/namespaces/migrationConfigurations/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/migrationConfigurations/readme.md @@ -18,17 +18,20 @@ This module deploys a migration configuration for a service bus namespace ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `postMigrationName` | string | Name to access Standard Namespace after migration. | | `targetNamespaceResourceId` | string | Existing premium Namespace resource ID which has no entities, will be used for migration. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent Service Bus Namespace for the Service Bus Queue. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ServiceBus/namespaces/networkRuleSets/readme.md b/modules/Microsoft.ServiceBus/namespaces/networkRuleSets/readme.md index c04d22816e..faa419a4c1 100644 --- a/modules/Microsoft.ServiceBus/namespaces/networkRuleSets/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/networkRuleSets/readme.md @@ -18,11 +18,13 @@ This module deploys ServiceBus Namespaces NetworkRuleSets. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent Service Bus Namespace for the Service Bus Network Rule Set. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `defaultAction` | string | `'Allow'` | `[Allow, Deny]` | Default Action for Network Rule Set. Default is "Allow". It will not be set if publicNetworkAccess is "Disabled". Otherwise, it will be set to "Deny" if ipRules or virtualNetworkRules are being used. | diff --git a/modules/Microsoft.ServiceBus/namespaces/queues/authorizationRules/readme.md b/modules/Microsoft.ServiceBus/namespaces/queues/authorizationRules/readme.md index 1cf9885381..05ac1fa561 100644 --- a/modules/Microsoft.ServiceBus/namespaces/queues/authorizationRules/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/queues/authorizationRules/readme.md @@ -18,17 +18,20 @@ This module deploys an authorization rule for a service bus namespace queue. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the service bus namepace queue. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent Service Bus Namespace. Required if the template is used in a standalone deployment. | | `queueName` | string | The name of the parent Service Bus Namespace Queue. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ServiceBus/namespaces/queues/readme.md b/modules/Microsoft.ServiceBus/namespaces/queues/readme.md index 8bc8b2a15e..f032967099 100644 --- a/modules/Microsoft.ServiceBus/namespaces/queues/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/queues/readme.md @@ -21,16 +21,19 @@ This module deploys a queue for a service bus namespace. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Service Bus Queue. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent Service Bus Namespace for the Service Bus Queue. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `authorizationRules` | _[authorizationRules](authorizationRules/readme.md)_ array | `[System.Collections.Hashtable]` | | Authorization Rules for the Service Bus Queue. | diff --git a/modules/Microsoft.ServiceBus/namespaces/readme.md b/modules/Microsoft.ServiceBus/namespaces/readme.md index 53e599e535..bdc457bfca 100644 --- a/modules/Microsoft.ServiceBus/namespaces/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/readme.md @@ -32,11 +32,13 @@ This module deploys a service bus namespace resource. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Service Bus Namespace. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `authorizationRules` | _[authorizationRules](authorizationRules/readme.md)_ array | `[System.Collections.Hashtable]` | | Authorization Rules for the Service Bus namespace. | diff --git a/modules/Microsoft.ServiceBus/namespaces/topics/authorizationRules/readme.md b/modules/Microsoft.ServiceBus/namespaces/topics/authorizationRules/readme.md index f14dec08fd..a94e991136 100644 --- a/modules/Microsoft.ServiceBus/namespaces/topics/authorizationRules/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/topics/authorizationRules/readme.md @@ -18,17 +18,20 @@ This module deploys an authorization rule for a service bus namespace topic. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the service bus namespace topic. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent Service Bus Namespace. Required if the template is used in a standalone deployment. | | `topicName` | string | The name of the parent Service Bus Namespace Topic. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ServiceBus/namespaces/topics/readme.md b/modules/Microsoft.ServiceBus/namespaces/topics/readme.md index ac2dc5455a..73e8d478ca 100644 --- a/modules/Microsoft.ServiceBus/namespaces/topics/readme.md +++ b/modules/Microsoft.ServiceBus/namespaces/topics/readme.md @@ -21,16 +21,19 @@ This module deploys a topic for a service bus namespace. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Service Bus Topic. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `namespaceName` | string | The name of the parent Service Bus Namespace for the Service Bus Topic. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `authorizationRules` | _[authorizationRules](authorizationRules/readme.md)_ array | `[System.Collections.Hashtable]` | | Authorization Rules for the Service Bus Topic. | diff --git a/modules/Microsoft.ServiceFabric/clusters/applicationTypes/readme.md b/modules/Microsoft.ServiceFabric/clusters/applicationTypes/readme.md index ea3c5ed03b..1373637cd5 100644 --- a/modules/Microsoft.ServiceFabric/clusters/applicationTypes/readme.md +++ b/modules/Microsoft.ServiceFabric/clusters/applicationTypes/readme.md @@ -18,11 +18,13 @@ This module deploys a Service Fabric Cluster Application Type. ## Parameters **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `serviceFabricClusterName` | string | `''` | The name of the parent Service Fabric cluster. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.ServiceFabric/clusters/readme.md b/modules/Microsoft.ServiceFabric/clusters/readme.md index c5df17ecc4..49326b0e0c 100644 --- a/modules/Microsoft.ServiceFabric/clusters/readme.md +++ b/modules/Microsoft.ServiceFabric/clusters/readme.md @@ -22,12 +22,14 @@ This module deploys a Service Fabric Cluster. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `managementEndpoint` | string | The http management endpoint of the cluster. | | `name` | string | Name of the Service Fabric cluster. | **Optional parameters** + | 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. | diff --git a/modules/Microsoft.SignalRService/webPubSub/readme.md b/modules/Microsoft.SignalRService/webPubSub/readme.md index bb7d84af8a..414c8a4a78 100644 --- a/modules/Microsoft.SignalRService/webPubSub/readme.md +++ b/modules/Microsoft.SignalRService/webPubSub/readme.md @@ -23,11 +23,13 @@ This module deploys a Web PubSub Service resource. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Web PubSub Service resource. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `capacity` | int | `1` | | The unit count of the resource. 1 by default. | diff --git a/modules/Microsoft.Sql/managedInstances/administrators/readme.md b/modules/Microsoft.Sql/managedInstances/administrators/readme.md index b078d56d14..0ff31f3891 100644 --- a/modules/Microsoft.Sql/managedInstances/administrators/readme.md +++ b/modules/Microsoft.Sql/managedInstances/administrators/readme.md @@ -18,17 +18,20 @@ This module deploys an administrator for the SQL managed instance ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `login` | string | Login name of the managed instance administrator. | | `sid` | string | SID (object ID) of the managed instance administrator. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `managedInstanceName` | string | The name of the parent SQL managed instance. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies/readme.md b/modules/Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies/readme.md index e8504dc650..a4fdffe6cf 100644 --- a/modules/Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies/readme.md +++ b/modules/Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies/readme.md @@ -18,17 +18,20 @@ This module deploys a backup long-term retention policies for SQL Managed Instan ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Long Term Retention backup policy. For example "default". | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `databaseName` | string | The name of the parent managed instance database. Required if the template is used in a standalone deployment. | | `managedInstanceName` | string | The name of the parent managed instance. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies/readme.md b/modules/Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies/readme.md index cc9fa72806..2753efdf71 100644 --- a/modules/Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies/readme.md +++ b/modules/Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies/readme.md @@ -19,17 +19,20 @@ This module deploys a backup short-term retention policies for SQL Managed Insta ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Short Term Retention backup policy. For example "default". | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `databaseName` | string | The name of the parent SQL managed instance database. Required if the template is used in a standalone deployment. | | `managedInstanceName` | string | The name of the parent SQL managed instance. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Sql/managedInstances/databases/readme.md b/modules/Microsoft.Sql/managedInstances/databases/readme.md index 444678552f..efd78b6217 100644 --- a/modules/Microsoft.Sql/managedInstances/databases/readme.md +++ b/modules/Microsoft.Sql/managedInstances/databases/readme.md @@ -26,11 +26,13 @@ The SQL Managed Instance Database is deployed on a SQL Managed Instance. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the SQL managed instance database. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `longTermRetentionBackupResourceId` | string | `''` | The resource ID of the Long Term Retention backup to be used for restore of this managed database. Required if createMode is RestoreLongTermRetentionBackup. | @@ -42,6 +44,7 @@ The SQL Managed Instance Database is deployed on a SQL Managed Instance. | `storageContainerUri` | string | `''` | Specifies the uri of the storage container where backups for this restore are stored. Required if createMode is RestoreExternalBackup. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `backupLongTermRetentionPoliciesObj` | _[backupLongTermRetentionPolicies](backupLongTermRetentionPolicies/readme.md)_ object | `{object}` | | The configuration for the backup long term retention policy definition. | diff --git a/modules/Microsoft.Sql/managedInstances/encryptionProtector/readme.md b/modules/Microsoft.Sql/managedInstances/encryptionProtector/readme.md index fe57349173..d1a6815e4b 100644 --- a/modules/Microsoft.Sql/managedInstances/encryptionProtector/readme.md +++ b/modules/Microsoft.Sql/managedInstances/encryptionProtector/readme.md @@ -18,17 +18,20 @@ This module deploys an encryption protector for a SQL managed instance. ## Parameters **Required parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `name` | string | `'current'` | The name of the encryptionProtector. | | `serverKeyName` | string | | The name of the SQL managed instance key. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `managedInstanceName` | string | The name of the parent SQL managed instance. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `autoRotationEnabled` | bool | `False` | | Key auto rotation opt-in flag. | diff --git a/modules/Microsoft.Sql/managedInstances/keys/readme.md b/modules/Microsoft.Sql/managedInstances/keys/readme.md index 975789e837..932a60b70b 100644 --- a/modules/Microsoft.Sql/managedInstances/keys/readme.md +++ b/modules/Microsoft.Sql/managedInstances/keys/readme.md @@ -18,16 +18,19 @@ This module deploys a key for a SQL managed instance. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the key. Must follow the [__] pattern. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `managedInstanceName` | string | The name of the parent SQL managed instance. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Sql/managedInstances/readme.md b/modules/Microsoft.Sql/managedInstances/readme.md index 72922e4a20..be7d382d93 100644 --- a/modules/Microsoft.Sql/managedInstances/readme.md +++ b/modules/Microsoft.Sql/managedInstances/readme.md @@ -42,6 +42,7 @@ SQL MI allows for Azure AD Authentication via an [Azure AD Admin](https://docs.m ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `administratorLogin` | string | The username used to establish jumpbox VMs. | @@ -50,11 +51,13 @@ SQL MI allows for Azure AD Authentication via an [Azure AD Admin](https://docs.m | `subnetId` | string | The fully qualified resource ID of the subnet on which the SQL managed instance will be placed. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `primaryUserAssignedIdentityId` | string | `''` | The resource ID of a user assigned identity to be used by default. Required if "userAssignedIdentities" is not empty. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `administratorsObj` | _[administrators](administrators/readme.md)_ object | `{object}` | | The administrator configuration. | diff --git a/modules/Microsoft.Sql/managedInstances/securityAlertPolicies/readme.md b/modules/Microsoft.Sql/managedInstances/securityAlertPolicies/readme.md index d5a49f9d77..884d9c15b9 100644 --- a/modules/Microsoft.Sql/managedInstances/securityAlertPolicies/readme.md +++ b/modules/Microsoft.Sql/managedInstances/securityAlertPolicies/readme.md @@ -18,16 +18,19 @@ This module deploys a security alert policy for a SQL managed instance. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the security alert policy. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `managedInstanceName` | string | The name of the parent SQL managed instance. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `emailAccountAdmins` | bool | `False` | | Specifies that the schedule scan notification will be is sent to the subscription administrators. | diff --git a/modules/Microsoft.Sql/managedInstances/vulnerabilityAssessments/readme.md b/modules/Microsoft.Sql/managedInstances/vulnerabilityAssessments/readme.md index 8e1bcf9e68..65d0ed4fdb 100644 --- a/modules/Microsoft.Sql/managedInstances/vulnerabilityAssessments/readme.md +++ b/modules/Microsoft.Sql/managedInstances/vulnerabilityAssessments/readme.md @@ -18,16 +18,19 @@ This module deploys a vulnerability assessment for a SQL managed instance. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the vulnerability assessment. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `managedInstanceName` | string | The name of the parent SQL managed instance. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Sql/servers/databases/readme.md b/modules/Microsoft.Sql/servers/databases/readme.md index a5de6b7b7b..b002cd4ec4 100644 --- a/modules/Microsoft.Sql/servers/databases/readme.md +++ b/modules/Microsoft.Sql/servers/databases/readme.md @@ -19,16 +19,19 @@ This module deploys an Azure SQL Server. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the database. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `serverName` | string | The name of the parent SQL Server. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `autoPauseDelay` | string | `''` | | Time in minutes after which database is automatically paused. | diff --git a/modules/Microsoft.Sql/servers/firewallRules/readme.md b/modules/Microsoft.Sql/servers/firewallRules/readme.md index d5564bac88..a934ad5ad0 100644 --- a/modules/Microsoft.Sql/servers/firewallRules/readme.md +++ b/modules/Microsoft.Sql/servers/firewallRules/readme.md @@ -18,16 +18,19 @@ This module deploys an SQL Server Firewall rule. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Server Firewall Rule. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `serverName` | string | The name of the parent SQL Server. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Sql/servers/readme.md b/modules/Microsoft.Sql/servers/readme.md index 00cb8c5d50..7d46f7e58c 100644 --- a/modules/Microsoft.Sql/servers/readme.md +++ b/modules/Microsoft.Sql/servers/readme.md @@ -29,11 +29,13 @@ This module deploys a SQL server. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the server. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `administratorLogin` | string | `''` | The administrator username for the server. Required if no `administrators` object for AAD authentication is provided. | @@ -41,6 +43,7 @@ This module deploys a SQL server. | `administrators` | object | `{object}` | The Azure Active Directory (AAD) administrator authentication. Required if no `administratorLogin` & `administratorLoginPassword` is provided. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `databases` | _[databases](databases/readme.md)_ array | `[]` | | The databases to create in the server. | diff --git a/modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md b/modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md index 60cb233bc8..79b6212296 100644 --- a/modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md +++ b/modules/Microsoft.Sql/servers/securityAlertPolicies/readme.md @@ -18,16 +18,19 @@ This module deploys an SQL Server Security Alert Policy. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Security Alert Policy. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `serverName` | string | The name of the parent SQL Server. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `disabledAlerts` | array | `[]` | | Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force. | diff --git a/modules/Microsoft.Sql/servers/virtualNetworkRules/readme.md b/modules/Microsoft.Sql/servers/virtualNetworkRules/readme.md index 532dc4c041..0afb03213b 100644 --- a/modules/Microsoft.Sql/servers/virtualNetworkRules/readme.md +++ b/modules/Microsoft.Sql/servers/virtualNetworkRules/readme.md @@ -18,17 +18,20 @@ This module deploys a Sql Server Virtual Network Rule. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Server Virtual Network Rule. | | `virtualNetworkSubnetId` | string | The resource ID of the virtual network subnet. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `serverName` | string | The name of the parent SQL Server. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Sql/servers/vulnerabilityAssessments/readme.md b/modules/Microsoft.Sql/servers/vulnerabilityAssessments/readme.md index f48d00123c..5cf0b880ed 100644 --- a/modules/Microsoft.Sql/servers/vulnerabilityAssessments/readme.md +++ b/modules/Microsoft.Sql/servers/vulnerabilityAssessments/readme.md @@ -18,12 +18,14 @@ This module deploys a vulnerability assessment for a SQL server. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the vulnerability assessment. | | `serverName` | string | The Name of SQL Server. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies/readme.md b/modules/Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies/readme.md index e2775f5d88..84a161c09a 100644 --- a/modules/Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies/readme.md @@ -18,6 +18,7 @@ This module deploys an Immutability Policy for a blob container ## Parameters **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `blobServicesName` | string | `'default'` | The name of the parent blob service. Required if the template is used in a standalone deployment. | @@ -25,6 +26,7 @@ This module deploys an Immutability Policy for a blob container | `storageAccountName` | string | | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `allowProtectedAppendWrites` | bool | `True` | This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. | diff --git a/modules/Microsoft.Storage/storageAccounts/blobServices/containers/readme.md b/modules/Microsoft.Storage/storageAccounts/blobServices/containers/readme.md index 3928bf6bc7..080e700907 100644 --- a/modules/Microsoft.Storage/storageAccounts/blobServices/containers/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/blobServices/containers/readme.md @@ -20,16 +20,19 @@ This module deploys a blob container ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the storage container to deploy. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `storageAccountName` | string | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `blobServicesName` | string | `'default'` | | Name of the blob service. | diff --git a/modules/Microsoft.Storage/storageAccounts/blobServices/readme.md b/modules/Microsoft.Storage/storageAccounts/blobServices/readme.md index b8536619cb..c8e9c5f11b 100644 --- a/modules/Microsoft.Storage/storageAccounts/blobServices/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/blobServices/readme.md @@ -22,11 +22,13 @@ This module can be used to deploy a blob service into a storage account. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `storageAccountName` | string | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `automaticSnapshotPolicyEnabled` | bool | `False` | | Automatic Snapshot is enabled if set to true. | diff --git a/modules/Microsoft.Storage/storageAccounts/fileServices/readme.md b/modules/Microsoft.Storage/storageAccounts/fileServices/readme.md index bafd75f1d7..58429e86d8 100644 --- a/modules/Microsoft.Storage/storageAccounts/fileServices/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/fileServices/readme.md @@ -21,11 +21,13 @@ This module can be used to deploy a file share service into a storage account. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `storageAccountName` | string | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Storage/storageAccounts/fileServices/shares/readme.md b/modules/Microsoft.Storage/storageAccounts/fileServices/shares/readme.md index 1401a4420f..e566adcb54 100644 --- a/modules/Microsoft.Storage/storageAccounts/fileServices/shares/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/fileServices/shares/readme.md @@ -19,17 +19,20 @@ This module deploys a storage account file share. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the file share to create. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `fileServicesName` | string | `'default'` | The name of the parent file service. Required if the template is used in a standalone deployment. | | `storageAccountName` | string | | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Storage/storageAccounts/managementPolicies/readme.md b/modules/Microsoft.Storage/storageAccounts/managementPolicies/readme.md index 5dd79a0af1..c8e0b71ec1 100644 --- a/modules/Microsoft.Storage/storageAccounts/managementPolicies/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/managementPolicies/readme.md @@ -18,16 +18,19 @@ This module can be used to deploy a management policies into a storage account. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `rules` | array | The Storage Account ManagementPolicies Rules. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `storageAccountName` | string | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Storage/storageAccounts/queueServices/queues/readme.md b/modules/Microsoft.Storage/storageAccounts/queueServices/queues/readme.md index 2ec1604350..e5b902735f 100644 --- a/modules/Microsoft.Storage/storageAccounts/queueServices/queues/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/queueServices/queues/readme.md @@ -19,18 +19,21 @@ This module deploys a storage account queue ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `metadata` | object | A name-value pair that represents queue metadata. | | `name` | string | The name of the storage queue to deploy. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `queueServicesName` | string | `'default'` | The name of the parent queue service. Required if the template is used in a standalone deployment. | | `storageAccountName` | string | | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Storage/storageAccounts/queueServices/readme.md b/modules/Microsoft.Storage/storageAccounts/queueServices/readme.md index 27f6851818..b4f0cfc979 100644 --- a/modules/Microsoft.Storage/storageAccounts/queueServices/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/queueServices/readme.md @@ -21,11 +21,13 @@ This module can be used to deploy a file share service into a storage account. ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `storageAccountName` | string | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Storage/storageAccounts/readme.md b/modules/Microsoft.Storage/storageAccounts/readme.md index ee77a8cc2f..fcd1a77a67 100644 --- a/modules/Microsoft.Storage/storageAccounts/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/readme.md @@ -35,16 +35,19 @@ This module is used to deploy a storage account, with the ability to deploy 1 or ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the Storage Account. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `cMKUserAssignedIdentityResourceId` | string | `''` | User assigned identity to use when fetching the customer managed key. Required if 'cMKKeyName' is not empty. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `allowBlobPublicAccess` | bool | `False` | | Indicates whether public access is enabled for all blobs or containers in the storage account. For security reasons, it is recommended to set it to false. | diff --git a/modules/Microsoft.Storage/storageAccounts/tableServices/readme.md b/modules/Microsoft.Storage/storageAccounts/tableServices/readme.md index b1a1f90e14..d389bf842c 100644 --- a/modules/Microsoft.Storage/storageAccounts/tableServices/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/tableServices/readme.md @@ -20,11 +20,13 @@ This module deploys a storage account table service ## Parameters **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `storageAccountName` | string | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `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/Microsoft.Storage/storageAccounts/tableServices/tables/readme.md b/modules/Microsoft.Storage/storageAccounts/tableServices/tables/readme.md index f8f69b76f2..4a4ce3ca02 100644 --- a/modules/Microsoft.Storage/storageAccounts/tableServices/tables/readme.md +++ b/modules/Microsoft.Storage/storageAccounts/tableServices/tables/readme.md @@ -18,17 +18,20 @@ This module deploys a storage account table ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the table. | **Conditional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `storageAccountName` | string | | The name of the parent Storage Account. Required if the template is used in a standalone deployment. | | `tableServicesName` | string | `'default'` | The name of the parent table service. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Synapse/privateLinkHubs/readme.md b/modules/Microsoft.Synapse/privateLinkHubs/readme.md index 319d608c64..aa1a79ab65 100644 --- a/modules/Microsoft.Synapse/privateLinkHubs/readme.md +++ b/modules/Microsoft.Synapse/privateLinkHubs/readme.md @@ -23,11 +23,13 @@ This module deploys Azure Synapse Analytics (private link hubs). ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the Private Link Hub. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Synapse/workspaces/keys/readme.md b/modules/Microsoft.Synapse/workspaces/keys/readme.md index 66188d82eb..14b262824b 100644 --- a/modules/Microsoft.Synapse/workspaces/keys/readme.md +++ b/modules/Microsoft.Synapse/workspaces/keys/readme.md @@ -19,17 +19,20 @@ This module deploys a Synapse Workspaces Key. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `isActiveCMK` | bool | Used to activate the workspace after a customer managed key is provided. | | `name` | string | Encryption key name. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `workspaceName` | string | The name of the parent Synapse Workspace. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `False` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.VirtualMachineImages/imageTemplates/readme.md b/modules/Microsoft.VirtualMachineImages/imageTemplates/readme.md index de58360caf..0b6c0fc743 100644 --- a/modules/Microsoft.VirtualMachineImages/imageTemplates/readme.md +++ b/modules/Microsoft.VirtualMachineImages/imageTemplates/readme.md @@ -21,6 +21,7 @@ This module deploys an image template that can be consumed by the Azure Image Bu ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `customizationSteps` | array | Customization steps to be run when building the VM image. | @@ -29,6 +30,7 @@ This module deploys an image template that can be consumed by the Azure Image Bu | `userMsiName` | string | Name of the User Assigned Identity to be used to deploy Image Templates in Azure Image Builder. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `buildTimeoutInMinutes` | int | `0` | | Image build timeout in minutes. Allowed values: 0-960. 0 means the default 240 minutes. | @@ -47,6 +49,7 @@ This module deploys an image template that can be consumed by the Azure Image Bu | `vmSize` | string | `'Standard_D2s_v3'` | | Specifies the size for the VM. | **Generated parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `baseTime` | string | `[utcNow('yyyy-MM-dd-HH-mm-ss')]` | Do not provide a value! This date value is used to generate a unique image template name. | diff --git a/modules/Microsoft.Web/connections/readme.md b/modules/Microsoft.Web/connections/readme.md index 9a25bff7e4..a3631325d0 100644 --- a/modules/Microsoft.Web/connections/readme.md +++ b/modules/Microsoft.Web/connections/readme.md @@ -21,12 +21,14 @@ This module deploys an Azure API connection. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `displayName` | string | Display name connection. Example: 'blobconnection' when using blobs. It can change depending on the resource. | | `name` | string | Connection name for connection. Example: 'azureblob' when using blobs. It can change depending on the resource. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `alternativeParameterValues` | object | `{object}` | | Alternative parameter values. | diff --git a/modules/Microsoft.Web/hostingEnvironments/readme.md b/modules/Microsoft.Web/hostingEnvironments/readme.md index f5fd364d40..25e04b3123 100644 --- a/modules/Microsoft.Web/hostingEnvironments/readme.md +++ b/modules/Microsoft.Web/hostingEnvironments/readme.md @@ -22,12 +22,14 @@ This module deploys an app service environment. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the App Service Environment. | | `subnetResourceId` | string | ResourceId for the subnet. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `clusterSettings` | array | `[System.Collections.Hashtable]` | | Custom settings for changing the behavior of the App Service Environment. | diff --git a/modules/Microsoft.Web/serverfarms/readme.md b/modules/Microsoft.Web/serverfarms/readme.md index ffad984d4a..5f97655392 100644 --- a/modules/Microsoft.Web/serverfarms/readme.md +++ b/modules/Microsoft.Web/serverfarms/readme.md @@ -22,12 +22,14 @@ This module deploys an app service plan. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | The name of the app service plan to deploy. | | `sku` | object | Defines the name, tier, size, family and capacity of the App Service Plan. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `appServiceEnvironmentId` | string | `''` | | The Resource ID of the App Service Environment to use for the App Service Plan. | diff --git a/modules/Microsoft.Web/sites/config-appsettings/readme.md b/modules/Microsoft.Web/sites/config-appsettings/readme.md index 5d5fdf1058..f2972f7af5 100644 --- a/modules/Microsoft.Web/sites/config-appsettings/readme.md +++ b/modules/Microsoft.Web/sites/config-appsettings/readme.md @@ -18,16 +18,19 @@ This module deploys the app settings. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `kind` | string | `[app, functionapp, functionapp,linux]` | Type of site to deploy. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `appName` | string | The name of the parent site resource. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `appInsightId` | string | `''` | Resource ID of the app insight to leverage for this resource. | diff --git a/modules/Microsoft.Web/sites/config-authsettingsv2/readme.md b/modules/Microsoft.Web/sites/config-authsettingsv2/readme.md index 2cee5670b6..45849c552a 100644 --- a/modules/Microsoft.Web/sites/config-authsettingsv2/readme.md +++ b/modules/Microsoft.Web/sites/config-authsettingsv2/readme.md @@ -18,17 +18,20 @@ This module deploys the auth settings v2. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `authSettingV2Configuration` | object | | The auth settings V2 configuration. | | `kind` | string | `[app, functionapp, functionapp,linux]` | Type of site to deploy. | **Conditional parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `appName` | string | The name of the parent site resource. Required if the template is used in a standalone deployment. | **Optional parameters** + | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | diff --git a/modules/Microsoft.Web/sites/readme.md b/modules/Microsoft.Web/sites/readme.md index 6fe2a3478c..e3f3f035cf 100644 --- a/modules/Microsoft.Web/sites/readme.md +++ b/modules/Microsoft.Web/sites/readme.md @@ -25,6 +25,7 @@ This module deploys a web or function app. ## Parameters **Required parameters** + | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `kind` | string | `[app, functionapp, functionapp,linux]` | Type of site to deploy. | @@ -32,6 +33,7 @@ This module deploys a web or function app. | `serverFarmResourceId` | string | | The resource ID of the app service plan to use for the site. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `appInsightId` | string | `''` | | Resource ID of the app insight to leverage for this resource. | diff --git a/modules/Microsoft.Web/staticSites/readme.md b/modules/Microsoft.Web/staticSites/readme.md index be44befea5..95ce3baf1d 100644 --- a/modules/Microsoft.Web/staticSites/readme.md +++ b/modules/Microsoft.Web/staticSites/readme.md @@ -23,11 +23,13 @@ This module deploys a Static Web App. ## Parameters **Required parameters** + | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Name of the static site. | **Optional parameters** + | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | | `allowConfigFileUpdates` | bool | `True` | | If config file is locked for this static web app. | diff --git a/utilities/pipelines/staticValidation/module.tests.ps1 b/utilities/pipelines/staticValidation/module.tests.ps1 index 5148281387..410d027597 100644 --- a/utilities/pipelines/staticValidation/module.tests.ps1 +++ b/utilities/pipelines/staticValidation/module.tests.ps1 @@ -341,7 +341,7 @@ Describe 'Readme tests' -Tag Readme { if ($shouldHaveAllowed) { $expectedColumnsInOrder += @('Allowed Values') } $expectedColumnsInOrder += @('Description') - $readMeCategoryIndex = $readMeContent | Select-String -Pattern "^\*\*$paramCategory parameters\*\*$" | ForEach-Object { $_.LineNumber } + $readMeCategoryIndex = $readMeContent | Select-String -Pattern "^\*\*$paramCategory parameters\*\*$" | ForEach-Object { $_.LineNumber + 1 } $readmeCategoryColumns = ($readMeContent[$readMeCategoryIndex] -split '\|') | ForEach-Object { $_.Trim() } | Where-Object { -not [String]::IsNullOrEmpty($_) } $readmeCategoryColumns | Should -Be $expectedColumnsInOrder