From 64e62f007802bda69e17305bc9ed741f4f213d7d Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Tue, 31 Oct 2023 22:42:54 +0100 Subject: [PATCH] [Fixes] Fixed incorrect UDT required identification & updated allowed & default value handling (#4168) * Updated API Management module * Updated Container App module * Updating Configuration Store module (ongoing) * Updated Configuration Store module * Updated Automation Account module * Comment headers formatted * Readme/ARM for first four modules * Updated Batch Account module * Fixed parameter descriptions * Updated Readme and ARM * Updated Redis Cache module * Container App - Fixed parameter descriptions * Updated Cognitive Services module * Updated VMSS module * Updated Container Group module * Updated Container Registry module * Updated Data Factory module * Updated Event Grid / System Topic module * Updated EventHub Namespace module * [Modules] Resolved conflicts (#4129) * [Modules] Migrated batch [1/4] to AVM RBAC (#4125) * Updated first badge of templates (readmes pending) * Update to latest * Compiled templates * Compiled templates * Compiled first few readmes * Updated test files * Updated readmes * Reduced roles * Updated templates * Rollback different branches' changes * Updated nic & pip * Fixed test file * Refreshed vm * Push updated Readme file(s) * Updated templates * Updated templates --------- Co-authored-by: CARMLPipelinePrincipal * Clean-up, some fixes * Removed Azure Firewall changes from branch * Update API common test file * Update API common test file2 * Updated Recovery Services Vault module * Updated ServiceBus Namespace module * Updated SQL Managed Instance module * Updated SQL Server module * Updated Static Website module * Updated Web Site module * Updated website slot readme/arm * Redis Cache - Testing with two identities * Configuration Store module - Testing with two identities * Updated Signal-R WebPub Sub module * Updated Barch module to support only one type of identity * Updated AKS module * Updated Databricks Access Connector module * Updated Disk Encryption Set module * Updated Search Service module * Updated Backup Vault module * Updated Firewall Policy module * Updated MySQL Flexible server module * MySQL Flexible server module - namePrefix reset * Updated Health Bot module * Updated NetApp Account module * Updated App Gateway module * Updated Deployment Script module * Updated PostgreSQL Flexible Server module * Fixed description of userAssignedResourcesIds * Updated Storage Account module * Updated Web Hosting Environment module * Updated Log Analytics Workspace module * Updated Logic Workflow module * Updated ML Workspace module * Updated ML Workspace Compute module * Updated Cosmos DB module * Updated VM module * Updated Digital Twins module * Updated Healthcare APIs module * Updated DevTest Lab module * Updated PurView Account module * Fixed Digital Twins missing references * Fixed DevTest Lab formattedManagementIdentities ref * Purview fix * Purview fix 2 * Purview updated ARM * SQL MI fix * SQL MI updated ARM * SQL MI removed new output * Small fixes * Fixed SQL Server module * DigitalTwins - fixed params * Digital Twins - reset to main * mySQL - updated param description * postgreSQL - updated param description * mySQL - updated conditional param description * postgreSQL - updated conditional param description * Updated param description for "one identity only" modules * Update to latest * Updated Allowed & Default value handling, etc. * Rollback of unrelated changes * Updated readmes * Small formatting --------- Co-authored-by: Kris Baranek Co-authored-by: CARMLPipelinePrincipal --- modules/aad/domain-service/README.md | 97 ++++- modules/analysis-services/server/README.md | 14 +- modules/api-management/service/README.md | 32 +- .../service/api-version-set/README.md | 2 +- modules/api-management/service/api/README.md | 49 ++- .../service/api/policy/README.md | 10 +- .../service/authorization-server/README.md | 21 +- .../api-management/service/backend/README.md | 14 +- .../service/identity-provider/README.md | 12 +- .../service/named-value/README.md | 2 +- .../api-management/service/policy/README.md | 10 +- .../service/portalsetting/README.md | 11 +- .../configuration-store/README.md | 25 +- modules/app/container-app/README.md | 22 +- modules/app/job/README.md | 19 +- modules/app/managed-environment/README.md | 8 +- modules/authorization/lock/README.md | 8 +- .../lock/resource-group/README.md | 8 +- .../authorization/lock/subscription/README.md | 8 +- .../authorization/policy-assignment/README.md | 21 +- .../management-group/README.md | 21 +- .../resource-group/README.md | 21 +- .../policy-assignment/subscription/README.md | 21 +- .../authorization/policy-definition/README.md | 16 +- .../management-group/README.md | 16 +- .../policy-definition/subscription/README.md | 16 +- .../authorization/policy-exemption/README.md | 19 +- .../management-group/README.md | 19 +- .../policy-exemption/resource-group/README.md | 19 +- .../policy-exemption/subscription/README.md | 19 +- .../policy-set-definition/README.md | 4 +- .../management-group/README.md | 4 +- .../subscription/README.md | 4 +- .../authorization/role-assignment/README.md | 19 +- .../authorization/role-assignment/main.json | 33 +- .../management-group/README.md | 19 +- .../management-group/main.json | 403 +---------------- .../role-assignment/resource-group/README.md | 19 +- .../role-assignment/resource-group/main.json | 404 +----------------- .../role-assignment/subscription/README.md | 19 +- .../role-assignment/subscription/main.json | 404 +----------------- .../automation/automation-account/README.md | 17 +- .../automation-account/job-schedule/README.md | 2 +- .../automation/automation-account/main.json | 26 +- .../automation-account/runbook/README.md | 11 +- .../automation-account/schedule/README.md | 14 +- .../software-update-configuration/README.md | 123 +++++- modules/batch/batch-account/README.md | 42 +- modules/cache/redis-enterprise/README.md | 22 +- .../cache/redis-enterprise/database/README.md | 51 ++- modules/cache/redis/README.md | 52 ++- modules/cdn/profile/README.md | 21 +- modules/cdn/profile/afdEndpoint/README.md | 18 +- .../cdn/profile/afdEndpoint/route/README.md | 43 +- modules/cdn/profile/customdomain/README.md | 18 +- modules/cdn/profile/origingroup/README.md | 10 +- .../cdn/profile/origingroup/origin/README.md | 10 +- modules/cdn/profile/ruleset/rule/README.md | 8 +- modules/cdn/profile/secret/README.md | 10 +- modules/cognitive-services/account/README.md | 64 ++- modules/compute/disk-encryption-set/README.md | 16 +- modules/compute/disk/README.md | 72 +++- modules/compute/gallery/application/README.md | 8 +- modules/compute/gallery/image/README.md | 51 ++- modules/compute/image/README.md | 10 +- .../proximity-placement-group/README.md | 12 +- .../virtual-machine-scale-set/README.md | 107 ++++- .../extension/README.md | 4 +- modules/compute/virtual-machine/README.md | 134 +++++- .../virtual-machine/extension/README.md | 4 +- modules/compute/virtual-machine/main.json | 12 +- modules/consumption/budget/README.md | 31 +- .../container-group/README.md | 36 +- modules/container-registry/registry/README.md | 90 +++- .../registry/replication/README.md | 8 +- .../registry/webhook/README.md | 21 +- .../managed-cluster/README.md | 132 +++++- .../managed-cluster/agent-pool/README.md | 68 ++- modules/data-factory/factory/README.md | 11 +- .../factory/integration-runtime/README.md | 10 +- .../data-protection/backup-vault/README.md | 30 +- .../backup-vault/backup-policy/README.md | 2 +- modules/databricks/workspace/README.md | 25 +- .../db-for-my-sql/flexible-server/README.md | 98 ++++- .../flexible-server/README.md | 91 +++- .../flexible-server/administrator/README.md | 10 +- .../application-group/README.md | 8 +- .../application-group/application/README.md | 9 +- .../host-pool/README.md | 89 +++- .../scaling-plan/README.md | 51 ++- modules/dev-test-lab/lab/README.md | 57 ++- .../dev-test-lab/lab/artifactsource/README.md | 18 +- modules/dev-test-lab/lab/cost/README.md | 96 ++++- .../lab/notificationchannel/README.md | 8 +- .../lab/policyset/policy/README.md | 34 +- modules/dev-test-lab/lab/schedule/README.md | 38 +- .../digital-twins-instance/README.md | 17 +- .../endpoint--event-hub/README.md | 8 +- .../endpoint--service-bus/README.md | 8 +- .../document-db/database-account/README.md | 65 ++- .../gremlin-database/graph/README.md | 2 +- .../gremlin-database/main.json | 4 +- .../sql-database/container/README.md | 13 +- modules/event-grid/domain/README.md | 9 +- .../system-topic/event-subscription/README.md | 20 +- modules/event-grid/topic/README.md | 9 +- .../topic/event-subscription/README.md | 20 +- modules/event-hub/namespace/README.md | 46 +- .../namespace/authorization-rule/README.md | 9 +- .../event-hub/namespace/eventhub/README.md | 54 ++- .../eventhub/authorization-rule/README.md | 9 +- .../namespace/network-rule-set/README.md | 16 +- modules/health-bot/health-bot/README.md | 9 +- modules/healthcare-apis/workspace/README.md | 8 +- .../workspace/dicomservice/README.md | 20 +- .../workspace/dicomservice/main.json | 4 +- .../workspace/fhirservice/README.md | 39 +- .../workspace/fhirservice/main.json | 4 +- .../workspace/iotconnector/README.md | 10 +- .../iotconnector/fhirdestination/README.md | 16 +- .../workspace/iotconnector/main.json | 4 +- modules/insights/activity-log-alert/README.md | 7 +- modules/insights/component/README.md | 39 +- .../data-collection-endpoint/README.md | 16 +- .../insights/data-collection-rule/README.md | 10 +- modules/insights/diagnostic-setting/README.md | 9 +- modules/insights/metric-alert/README.md | 52 ++- .../insights/scheduled-query-rule/README.md | 19 +- modules/insights/webtest/README.md | 34 +- modules/key-vault/vault/README.md | 21 +- modules/key-vault/vault/key/README.md | 35 +- .../extension/README.md | 4 +- .../flux-configuration/README.md | 24 +- modules/logic/workflow/README.md | 38 +- .../workspace/README.md | 29 +- .../workspace/compute/README.md | 29 +- .../workspace/compute/main.json | 4 +- .../maintenance-configuration/README.md | 27 +- .../net-app-account/capacity-pool/README.md | 26 +- .../capacity-pool/volume/README.md | 10 +- .../README.md | 4 +- modules/network/application-gateway/README.md | 88 +++- modules/network/azure-firewall/README.md | 38 +- modules/network/bastion-host/README.md | 15 +- modules/network/connection/README.md | 47 +- .../forwarding-rule/README.md | 10 +- modules/network/dns-zone/a/README.md | 2 +- modules/network/dns-zone/aaaa/README.md | 2 +- modules/network/dns-zone/caa/README.md | 2 +- modules/network/dns-zone/cname/README.md | 4 +- modules/network/dns-zone/mx/README.md | 2 +- modules/network/dns-zone/ns/README.md | 2 +- modules/network/dns-zone/ptr/README.md | 2 +- modules/network/dns-zone/soa/README.md | 4 +- modules/network/dns-zone/srv/README.md | 2 +- modules/network/dns-zone/txt/README.md | 2 +- .../network/express-route-circuit/README.md | 25 +- modules/network/firewall-policy/README.md | 34 +- .../README.md | 62 ++- modules/network/load-balancer/README.md | 8 +- .../backend-address-pool/README.md | 9 +- .../load-balancer/inbound-nat-rule/README.md | 9 +- modules/network/network-interface/README.md | 20 +- .../connectivity-configuration/README.md | 24 +- .../security-admin-configuration/README.md | 16 +- .../rule-collection/rule/README.md | 29 +- .../security-rule/README.md | 28 +- .../network-watcher/flow-log/README.md | 16 +- modules/network/private-dns-zone/a/README.md | 2 +- .../network/private-dns-zone/aaaa/README.md | 2 +- .../network/private-dns-zone/cname/README.md | 4 +- modules/network/private-dns-zone/mx/README.md | 2 +- .../network/private-dns-zone/ptr/README.md | 2 +- .../network/private-dns-zone/soa/README.md | 4 +- .../network/private-dns-zone/srv/README.md | 2 +- .../network/private-dns-zone/txt/README.md | 2 +- .../network/private-link-service/README.md | 6 +- modules/network/public-ip-address/README.md | 43 +- modules/network/public-ip-prefix/README.md | 2 +- .../network/trafficmanagerprofile/README.md | 37 +- modules/network/virtual-hub/README.md | 18 +- .../hub-virtual-network-connection/README.md | 2 +- .../network/virtual-network-gateway/README.md | 50 ++- .../nat-rule/README.md | 18 +- modules/network/virtual-network/README.md | 8 +- .../network/virtual-network/subnet/README.md | 18 +- modules/network/virtual-wan/README.md | 8 +- modules/network/vpn-gateway/README.md | 2 +- .../network/vpn-gateway/nat-rule/README.md | 18 +- .../vpn-gateway/vpn-connection/README.md | 10 +- modules/network/vpn-site/README.md | 6 +- .../operational-insights/workspace/README.md | 30 +- .../workspace/data-export/README.md | 2 +- .../workspace/data-source/README.md | 14 +- .../linked-storage-account/README.md | 10 +- .../workspace/table/README.md | 14 +- modules/policy-insights/remediation/README.md | 8 +- .../remediation/management-group/README.md | 8 +- .../remediation/resource-group/README.md | 8 +- .../remediation/subscription/README.md | 8 +- modules/power-bi-dedicated/capacity/README.md | 29 +- modules/purview/account/README.md | 9 +- modules/recovery-services/vault/README.md | 18 +- .../vault/backup-config/README.md | 44 +- .../protection-container/README.md | 32 +- .../protected-item/README.md | 16 +- .../vault/backup-storage-config/README.md | 10 +- .../vault/replication-alert-setting/README.md | 8 +- .../vault/replication-policy/README.md | 8 +- modules/relay/namespace/README.md | 23 +- .../namespace/authorization-rule/README.md | 9 +- .../namespace/hybrid-connection/README.md | 26 +- .../authorization-rule/README.md | 9 +- .../namespace/network-rule-set/README.md | 16 +- modules/relay/namespace/wcf-relay/README.md | 34 +- .../wcf-relay/authorization-rule/README.md | 9 +- modules/resources/deployment-script/README.md | 19 +- modules/search/search-service/README.md | 42 +- .../security/azure-security-center/README.md | 118 ++++- modules/service-bus/namespace/README.md | 60 ++- .../namespace/authorization-rule/README.md | 9 +- .../namespace/network-rule-set/README.md | 16 +- modules/service-bus/namespace/queue/README.md | 31 +- .../queue/authorization-rule/README.md | 9 +- modules/service-bus/namespace/topic/README.md | 31 +- .../topic/authorization-rule/README.md | 9 +- modules/service-fabric/cluster/README.md | 68 ++- modules/signal-r-service/signal-r/README.md | 81 +++- .../signal-r-service/web-pub-sub/README.md | 35 +- modules/sql/managed-instance/README.md | 61 ++- .../sql/managed-instance/database/README.md | 15 +- .../encryption-protector/README.md | 8 +- modules/sql/managed-instance/key/README.md | 8 +- .../security-alert-policy/README.md | 8 +- modules/sql/server/README.md | 33 +- modules/sql/server/database/README.md | 45 +- modules/sql/server/elastic-pool/README.md | 8 +- .../sql/server/encryption-protector/README.md | 8 +- modules/sql/server/key/README.md | 8 +- .../server/security-alert-policy/README.md | 8 +- modules/storage/storage-account/README.md | 90 +++- .../blob-service/container/README.md | 13 +- .../storage-account/file-service/README.md | 10 +- .../file-service/share/README.md | 27 +- .../queue-service/queue/README.md | 2 +- modules/synapse/workspace/README.md | 12 +- .../workspace/integration-runtime/README.md | 10 +- .../image-template/README.md | 8 +- modules/web/connection/README.md | 8 +- modules/web/hosting-environment/README.md | 55 ++- modules/web/serverfarm/README.md | 20 +- modules/web/site/README.md | 48 ++- .../README.md | 8 +- .../web/site/config--appsettings/README.md | 13 +- .../web/site/config--authsettingsv2/README.md | 11 +- modules/web/site/slot/README.md | 48 ++- .../site/slot/config--appsettings/README.md | 13 +- .../slot/config--authsettingsv2/README.md | 11 +- modules/web/site/slot/main.json | 4 +- modules/web/static-site/README.md | 36 +- modules/web/static-site/config/README.md | 8 +- .../sharedScripts/Set-ModuleReadMe.ps1 | 102 +++-- 262 files changed, 5218 insertions(+), 2082 deletions(-) diff --git a/modules/aad/domain-service/README.md b/modules/aad/domain-service/README.md index 1e6faab9e8..b93dc2af43 100644 --- a/modules/aad/domain-service/README.md +++ b/modules/aad/domain-service/README.md @@ -309,7 +309,13 @@ The value is to provide domain configuration type. - Required: No - Type: string - Default: `'FullySynced'` -- Allowed: `[FullySynced, ResourceTrusting]` +- Allowed: + ```Bicep + [ + 'FullySynced' + 'ResourceTrusting' + ] + ``` ### Parameter: `domainName` @@ -330,7 +336,13 @@ The value is to enable the Secure LDAP for external services of Azure ADDS Servi - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `filteredSync` @@ -345,7 +357,13 @@ The value is to enable to provide a protected channel between the Kerberos clien - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `kerberosRc4Encryption` @@ -353,7 +371,13 @@ The value is to enable Kerberos requests that use RC4 encryption. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `ldaps` @@ -361,7 +385,13 @@ A flag to determine whether or not Secure LDAP is enabled or disabled. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `location` @@ -410,7 +440,13 @@ The value is to notify the DC Admins. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `notifyGlobalAdmins` @@ -418,7 +454,13 @@ The value is to notify the Global Admins. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `ntlmV1` @@ -426,7 +468,13 @@ The value is to enable clients making request using NTLM v1. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `pfxCertificate` @@ -523,7 +571,14 @@ The name of the SKU specific to Azure ADDS Services. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Enterprise, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Enterprise' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `syncNtlmPasswords` @@ -531,7 +586,13 @@ The value is to enable synchronized users to use NTLM authentication. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `syncOnPremPasswords` @@ -539,7 +600,13 @@ The value is to enable on-premises users to authenticate against managed domain. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `tags` @@ -553,7 +620,13 @@ The value is to enable clients making request using TLSv1. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ## Outputs diff --git a/modules/analysis-services/server/README.md b/modules/analysis-services/server/README.md index ded6d13e0a..7fa90cf6f9 100644 --- a/modules/analysis-services/server/README.md +++ b/modules/analysis-services/server/README.md @@ -496,7 +496,19 @@ Enable telemetry via a Globally Unique Identifier (GUID). The inbound firewall rules to define on the server. If not specified, firewall is disabled. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enablePowerBIService: true + firewallRules: [ + { + firewallRuleName: 'AllowFromAll' + rangeEnd: '255.255.255.255' + rangeStart: '0.0.0.0' + } + ] + } + ``` ### Parameter: `location` diff --git a/modules/api-management/service/README.md b/modules/api-management/service/README.md index 411ee60b8f..596879a4b5 100644 --- a/modules/api-management/service/README.md +++ b/modules/api-management/service/README.md @@ -698,7 +698,7 @@ API Version Sets. Authorization servers. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `backends` @@ -726,7 +726,7 @@ List of Certificates that need to be installed in the API Management service. Ma Custom properties of the API Management service. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `diagnosticSettings` @@ -1086,7 +1086,16 @@ The pricing tier of this API Management service. - Required: No - Type: string - Default: `'Developer'` -- Allowed: `[Basic, Consumption, Developer, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Consumption' + 'Developer' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `skuCount` @@ -1094,7 +1103,13 @@ The instance size of this API Management service. - Required: No - Type: int - Default: `1` -- Allowed: `[1, 2]` +- Allowed: + ```Bicep + [ + 1 + 2 + ] + ``` ### Parameter: `subnetResourceId` @@ -1122,7 +1137,14 @@ The type of VPN in which API Management service needs to be configured in. None - Required: No - Type: string - Default: `'None'` -- Allowed: `[External, Internal, None]` +- Allowed: + ```Bicep + [ + 'External' + 'Internal' + 'None' + ] + ``` ### Parameter: `zones` diff --git a/modules/api-management/service/api-version-set/README.md b/modules/api-management/service/api-version-set/README.md index 3be54ecd44..15300dd5bf 100644 --- a/modules/api-management/service/api-version-set/README.md +++ b/modules/api-management/service/api-version-set/README.md @@ -56,7 +56,7 @@ API Version set name. API Version set properties. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/api-management/service/api/README.md b/modules/api-management/service/api/README.md index a9cd300c66..a746976978 100644 --- a/modules/api-management/service/api/README.md +++ b/modules/api-management/service/api/README.md @@ -90,7 +90,15 @@ Type of API to create. * http creates a REST API * soap creates a SOAP pass-thro - Required: No - Type: string - Default: `'http'` -- Allowed: `[graphql, http, soap, websocket]` +- Allowed: + ```Bicep + [ + 'graphql' + 'http' + 'soap' + 'websocket' + ] + ``` ### Parameter: `apiVersion` @@ -118,7 +126,7 @@ Indicates the Version identifier of the API version set. Collection of authentication settings included into this API. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `displayName` @@ -139,7 +147,21 @@ Format of the Content in which the API is getting imported. - Required: No - Type: string - Default: `'openapi'` -- Allowed: `[openapi, openapi-link, openapi+json, openapi+json-link, swagger-json, swagger-link-json, wadl-link-json, wadl-xml, wsdl, wsdl-link]` +- Allowed: + ```Bicep + [ + 'openapi' + 'openapi-link' + 'openapi+json' + 'openapi+json-link' + 'swagger-json' + 'swagger-link-json' + 'wadl-link-json' + 'wadl-xml' + 'wsdl' + 'wsdl-link' + ] + ``` ### Parameter: `isCurrent` @@ -172,7 +194,12 @@ Array of Policies to apply to the Service API. Describes on which protocols the operations in this API can be invoked. - HTTP or HTTPS. - Required: No - Type: array -- Default: `[https]` +- Default: + ```Bicep + [ + 'https' + ] + ``` ### Parameter: `serviceUrl` @@ -193,7 +220,7 @@ API identifier of the source API. Protocols over which API is made available. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `subscriptionRequired` @@ -208,7 +235,15 @@ Type of API. - Required: No - Type: string - Default: `'http'` -- Allowed: `[graphql, http, soap, websocket]` +- Allowed: + ```Bicep + [ + 'graphql' + 'http' + 'soap' + 'websocket' + ] + ``` ### Parameter: `value` @@ -222,7 +257,7 @@ Content value when Importing an API. Criteria to limit import of WSDL to a subset of the document. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/api-management/service/api/policy/README.md b/modules/api-management/service/api/policy/README.md index 969678d876..da2b69af2c 100644 --- a/modules/api-management/service/api/policy/README.md +++ b/modules/api-management/service/api/policy/README.md @@ -63,7 +63,15 @@ Format of the policyContent. - Required: No - Type: string - Default: `'xml'` -- Allowed: `[rawxml, rawxml-link, xml, xml-link]` +- Allowed: + ```Bicep + [ + 'rawxml' + 'rawxml-link' + 'xml' + 'xml-link' + ] + ``` ### Parameter: `name` diff --git a/modules/api-management/service/authorization-server/README.md b/modules/api-management/service/authorization-server/README.md index f10abac911..9f9569411e 100644 --- a/modules/api-management/service/authorization-server/README.md +++ b/modules/api-management/service/authorization-server/README.md @@ -67,21 +67,36 @@ OAuth authorization endpoint. See - If this value is not spec - Required: No - Type: string - Default: `''` -- Allowed: `['', V1, V2]` +- Allowed: + ```Bicep + [ + '' + 'V1' + 'V2' + ] + ``` ### Parameter: `isAcceleratedNetworkSupported` @@ -116,7 +123,13 @@ The image supports accelerated networking.

Accelerated networking enables sin - Required: No - Type: string - Default: `'false'` -- Allowed: `[false, true]` +- Allowed: + ```Bicep + [ + 'false' + 'true' + ] + ``` ### Parameter: `isHibernateSupported` @@ -124,7 +137,13 @@ The image will support hibernation. - Required: No - Type: string - Default: `'false'` -- Allowed: `[false, true]` +- Allowed: + ```Bicep + [ + 'false' + 'true' + ] + ``` ### Parameter: `location` @@ -180,7 +199,13 @@ This property allows the user to specify whether the virtual machines created un - Required: No - Type: string - Default: `'Generalized'` -- Allowed: `[Generalized, Specialized]` +- Allowed: + ```Bicep + [ + 'Generalized' + 'Specialized' + ] + ``` ### Parameter: `osType` @@ -188,7 +213,13 @@ OS type of the image to be created. - Required: No - Type: string - Default: `'Windows'` -- Allowed: `[Linux, Windows]` +- Allowed: + ```Bicep + [ + 'Linux' + 'Windows' + ] + ``` ### Parameter: `planName` @@ -306,7 +337,15 @@ The security type of the image. Requires a hyperVGeneration V2. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[ConfidentialVM, ConfidentialVMSupported, Standard, TrustedLaunch]` +- Allowed: + ```Bicep + [ + 'ConfidentialVM' + 'ConfidentialVMSupported' + 'Standard' + 'TrustedLaunch' + ] + ``` ### Parameter: `sku` diff --git a/modules/compute/image/README.md b/modules/compute/image/README.md index 4d8ffaa7a3..4bbb50b4f4 100644 --- a/modules/compute/image/README.md +++ b/modules/compute/image/README.md @@ -204,7 +204,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The extended location of the Image. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `hyperVGeneration` @@ -257,7 +257,13 @@ The OS State. For managed images, use Generalized. - Required: No - Type: string - Default: `'Generalized'` -- Allowed: `[Generalized, Specialized]` +- Allowed: + ```Bicep + [ + 'Generalized' + 'Specialized' + ] + ``` ### Parameter: `osType` diff --git a/modules/compute/proximity-placement-group/README.md b/modules/compute/proximity-placement-group/README.md index e41f19400b..dbc8c0751f 100644 --- a/modules/compute/proximity-placement-group/README.md +++ b/modules/compute/proximity-placement-group/README.md @@ -231,7 +231,7 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro Describes colocation status of the Proximity Placement Group. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -245,7 +245,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). Specifies the user intent of the proximity placement group. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` @@ -367,7 +367,13 @@ Specifies the type of the proximity placement group. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Standard, Ultra]` +- Allowed: + ```Bicep + [ + 'Standard' + 'Ultra' + ] + ``` ### Parameter: `zones` diff --git a/modules/compute/virtual-machine-scale-set/README.md b/modules/compute/virtual-machine-scale-set/README.md index d7421e7061..b67aef92a5 100644 --- a/modules/compute/virtual-machine-scale-set/README.md +++ b/modules/compute/virtual-machine-scale-set/README.md @@ -1510,35 +1510,61 @@ This property can be used by user in the request to enable or disable the Host E The configuration for the [Anti Malware] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionAzureDiskEncryptionConfig` The configuration for the [Azure Disk Encryption] extension. Must at least contain the ["enabled": true] property to be executed. Restrictions: Cannot be enabled on disks that have encryption at host enabled. Managed disks encrypted using Azure Disk Encryption cannot be encrypted using customer-managed keys. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionCustomScriptConfig` The configuration for the [Custom Script] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + fileData: [] + } + ``` ### Parameter: `extensionDependencyAgentConfig` The configuration for the [Dependency Agent] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionDomainJoinConfig` The configuration for the [Domain Join] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionDomainJoinPassword` @@ -1552,21 +1578,36 @@ Required if name is specified. Password of the user specified in user parameter. The configuration for the [Desired State Configuration] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionMonitoringAgentConfig` The configuration for the [Monitoring Agent] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionNetworkWatcherAgentConfig` The configuration for the [Network Watcher Agent] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `gracePeriod` @@ -1587,7 +1628,14 @@ Specifies that the image or disk that is being used was licensed on-premises. Th - Required: No - Type: string - Default: `''` -- Allowed: `['', Windows_Client, Windows_Server]` +- Allowed: + ```Bicep + [ + '' + 'Windows_Client' + 'Windows_Server' + ] + ``` ### Parameter: `location` @@ -1708,7 +1756,13 @@ Specifies the OS disk. For security reasons, it is recommended to specify DiskEn The chosen OS type. - Required: Yes - Type: string -- Allowed: `[Linux, Windows]` +- Allowed: + ```Bicep + [ + 'Linux' + 'Windows' + ] + ``` ### Parameter: `overprovision` @@ -1729,7 +1783,7 @@ The wait time between completing the update for all virtual machines in one batc Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `provisionVMAgent` @@ -1832,7 +1886,14 @@ SAS token validity length to use to download files from storage accounts. Usage: Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + rules: [ + 'Default' + ] + } + ``` ### Parameter: `scaleSetFaultDomain` @@ -1846,7 +1907,7 @@ Fault Domain count for each placement group. Specifies Scheduled Event related configurations. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `secrets` @@ -1915,7 +1976,14 @@ Specifies the mode of an upgrade to virtual machines in the scale set.' Manual - - Required: No - Type: string - Default: `'Manual'` -- Allowed: `[Automatic, Manual, Rolling]` +- Allowed: + ```Bicep + [ + 'Automatic' + 'Manual' + 'Rolling' + ] + ``` ### Parameter: `vmNamePrefix` @@ -1930,7 +1998,14 @@ Specifies the priority for the virtual machine. - Required: No - Type: string - Default: `'Regular'` -- Allowed: `[Low, Regular, Spot]` +- Allowed: + ```Bicep + [ + 'Low' + 'Regular' + 'Spot' + ] + ``` ### Parameter: `vTpmEnabled` @@ -1944,7 +2019,7 @@ Specifies whether vTPM should be enabled on the virtual machine scale set. This Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - WinRMConfiguration object. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `zoneBalance` diff --git a/modules/compute/virtual-machine-scale-set/extension/README.md b/modules/compute/virtual-machine-scale-set/extension/README.md index 462a5b3111..468af0d8f6 100644 --- a/modules/compute/virtual-machine-scale-set/extension/README.md +++ b/modules/compute/virtual-machine-scale-set/extension/README.md @@ -81,7 +81,7 @@ The name of the virtual machine scale set extension. Any object that contains the extension specific protected settings. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `publisher` @@ -94,7 +94,7 @@ The name of the extension handler publisher. Any object that contains the extension specific settings. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `supressFailures` diff --git a/modules/compute/virtual-machine/README.md b/modules/compute/virtual-machine/README.md index 879a36149b..bda155d259 100644 --- a/modules/compute/virtual-machine/README.md +++ b/modules/compute/virtual-machine/README.md @@ -2039,7 +2039,15 @@ If set to 1, 2 or 3, the availability zone for all VMs is hardcoded to that valu - Required: No - Type: int - Default: `0` -- Allowed: `[0, 1, 2, 3]` +- Allowed: + ```Bicep + [ + 0 + 1 + 2 + 3 + ] + ``` ### Parameter: `backupPolicyName` @@ -2110,7 +2118,14 @@ The configuration profile of automanage. - Required: No - Type: string - Default: `''` -- Allowed: `['', /providers/Microsoft.Automanage/bestPractices/AzureBestPracticesDevTest, /providers/Microsoft.Automanage/bestPractices/AzureBestPracticesProduction]` +- Allowed: + ```Bicep + [ + '' + '/providers/Microsoft.Automanage/bestPractices/AzureBestPracticesDevTest' + '/providers/Microsoft.Automanage/bestPractices/AzureBestPracticesProduction' + ] + ``` ### Parameter: `customData` @@ -2173,49 +2188,80 @@ This property can be used by user in the request to enable or disable the Host E The configuration for the [AAD Join] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionAntiMalwareConfig` The configuration for the [Anti Malware] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionAzureDiskEncryptionConfig` The configuration for the [Azure Disk Encryption] extension. Must at least contain the ["enabled": true] property to be executed. Restrictions: Cannot be enabled on disks that have encryption at host enabled. Managed disks encrypted using Azure Disk Encryption cannot be encrypted using customer-managed keys. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionCustomScriptConfig` The configuration for the [Custom Script] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + fileData: [] + } + ``` ### Parameter: `extensionCustomScriptProtectedSetting` Any object that contains the extension specific protected settings. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `extensionDependencyAgentConfig` The configuration for the [Dependency Agent] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionDomainJoinConfig` The configuration for the [Domain Join] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionDomainJoinPassword` @@ -2229,21 +2275,36 @@ Required if name is specified. Password of the user specified in user parameter. The configuration for the [Desired State Configuration] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionMonitoringAgentConfig` The configuration for the [Monitoring Agent] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `extensionNetworkWatcherAgentConfig` The configuration for the [Network Watcher Agent] extension. Must at least contain the ["enabled": true] property to be executed. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabled: false + } + ``` ### Parameter: `imageReference` @@ -2257,7 +2318,14 @@ Specifies that the image or disk that is being used was licensed on-premises. Th - Required: No - Type: string - Default: `''` -- Allowed: `['', Windows_Client, Windows_Server]` +- Allowed: + ```Bicep + [ + '' + 'Windows_Client' + 'Windows_Server' + ] + ``` ### Parameter: `location` @@ -2357,7 +2425,13 @@ Specifies the OS disk. For security reasons, it is recommended to specify DiskEn The chosen OS type. - Required: Yes - Type: string -- Allowed: `[Linux, Windows]` +- Allowed: + ```Bicep + [ + 'Linux' + 'Windows' + ] + ``` ### Parameter: `patchAssessmentMode` @@ -2365,7 +2439,13 @@ VM guest patching assessment mode. Set it to 'AutomaticByPlatform' to enable aut - Required: No - Type: string - Default: `'ImageDefault'` -- Allowed: `[AutomaticByPlatform, ImageDefault]` +- Allowed: + ```Bicep + [ + 'AutomaticByPlatform' + 'ImageDefault' + ] + ``` ### Parameter: `patchMode` @@ -2373,14 +2453,23 @@ VM guest patching orchestration mode. 'AutomaticByOS' & 'Manual' are for Windows - Required: No - Type: string - Default: `''` -- Allowed: `['', AutomaticByOS, AutomaticByPlatform, ImageDefault, Manual]` +- Allowed: + ```Bicep + [ + '' + 'AutomaticByOS' + 'AutomaticByPlatform' + 'ImageDefault' + 'Manual' + ] + ``` ### Parameter: `plan` Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `priority` @@ -2388,7 +2477,14 @@ Specifies the priority for the virtual machine. - Required: No - Type: string - Default: `'Regular'` -- Allowed: `[Low, Regular, Spot]` +- Allowed: + ```Bicep + [ + 'Low' + 'Regular' + 'Spot' + ] + ``` ### Parameter: `provisionVMAgent` @@ -2538,7 +2634,7 @@ Specifies whether vTPM should be enabled on the virtual machine. This parameter Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - WinRMConfiguration object. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/compute/virtual-machine/extension/README.md b/modules/compute/virtual-machine/extension/README.md index 89e5dc338f..447f83aed0 100644 --- a/modules/compute/virtual-machine/extension/README.md +++ b/modules/compute/virtual-machine/extension/README.md @@ -90,7 +90,7 @@ The name of the virtual machine extension. Any object that contains the extension specific protected settings. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `publisher` @@ -103,7 +103,7 @@ The name of the extension handler publisher. Any object that contains the extension specific settings. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `supressFailures` diff --git a/modules/compute/virtual-machine/main.json b/modules/compute/virtual-machine/main.json index bc357c1252..2fd9016b0e 100644 --- a/modules/compute/virtual-machine/main.json +++ b/modules/compute/virtual-machine/main.json @@ -6,7 +6,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "13033892292472228031" + "templateHash": "6920007226521594959" }, "name": "Virtual Machines", "description": "This module deploys a Virtual Machine with one or multiple NICs and optionally one or multiple public IPs.", @@ -1001,7 +1001,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "2272323782582357015" + "templateHash": "10482660512843717253" } }, "definitions": { @@ -1305,7 +1305,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "968771326214380550" + "templateHash": "18404193892947466906" }, "name": "Public IP Addresses", "description": "This module deploys a Public IP Address.", @@ -1644,7 +1644,7 @@ }, "tags": { "type": "object", - "defaultValue": {}, + "nullable": true, "metadata": { "description": "Optional. Tags of the resource." } @@ -1850,7 +1850,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "8812824728238881787" + "templateHash": "6506615823435977032" }, "name": "Network Interface", "description": "This module deploys a Network Interface.", @@ -2045,7 +2045,7 @@ }, "tags": { "type": "object", - "defaultValue": {}, + "nullable": true, "metadata": { "description": "Optional. Tags of the resource." } diff --git a/modules/consumption/budget/README.md b/modules/consumption/budget/README.md index bd08b6d387..fe87cf897b 100644 --- a/modules/consumption/budget/README.md +++ b/modules/consumption/budget/README.md @@ -212,7 +212,13 @@ The category of the budget, whether the budget tracks cost or usage. - Required: No - Type: string - Default: `'Cost'` -- Allowed: `[Cost, Usage]` +- Allowed: + ```Bicep + [ + 'Cost' + 'Usage' + ] + ``` ### Parameter: `contactEmails` @@ -261,7 +267,17 @@ The time covered by a budget. Tracking of the amount will be reset based on the - Required: No - Type: string - Default: `'Monthly'` -- Allowed: `[Annually, BillingAnnual, BillingMonth, BillingQuarter, Monthly, Quarterly]` +- Allowed: + ```Bicep + [ + 'Annually' + 'BillingAnnual' + 'BillingMonth' + 'BillingQuarter' + 'Monthly' + 'Quarterly' + ] + ``` ### Parameter: `startDate` @@ -275,7 +291,16 @@ The start date for the budget. Start date should be the first day of the month a Percent thresholds of budget for when to get a notification. Can be up to 5 thresholds, where each must be between 1 and 1000. - Required: No - Type: array -- Default: `[50, 75, 90, 100, 110]` +- Default: + ```Bicep + [ + 50 + 75 + 90 + 100 + 110 + ] + ``` ## Outputs diff --git a/modules/container-instance/container-group/README.md b/modules/container-instance/container-group/README.md index aadba485c5..f5d59c9161 100644 --- a/modules/container-instance/container-group/README.md +++ b/modules/container-instance/container-group/README.md @@ -831,7 +831,16 @@ Specify level of protection of the domain name label. - Required: No - Type: string - Default: `'TenantReuse'` -- Allowed: `[Noreuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse, Unsecure]` +- Allowed: + ```Bicep + [ + 'Noreuse' + 'ResourceGroupReuse' + 'SubscriptionReuse' + 'TenantReuse' + 'Unsecure' + ] + ``` ### Parameter: `cMKKeyName` @@ -922,7 +931,13 @@ Specifies if the IP is exposed to the public internet or private VNET. - Public - Required: No - Type: string - Default: `'Public'` -- Allowed: `[Private, Public]` +- Allowed: + ```Bicep + [ + 'Private' + 'Public' + ] + ``` ### Parameter: `location` @@ -1003,7 +1018,14 @@ Restart policy for all containers within the container group. - Always: Always r - Required: No - Type: string - Default: `'Always'` -- Allowed: `[Always, Never, OnFailure]` +- Allowed: + ```Bicep + [ + 'Always' + 'Never' + 'OnFailure' + ] + ``` ### Parameter: `sku` @@ -1011,7 +1033,13 @@ The container group SKU. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Dedicated, Standard]` +- Allowed: + ```Bicep + [ + 'Dedicated' + 'Standard' + ] + ``` ### Parameter: `subnetId` diff --git a/modules/container-registry/registry/README.md b/modules/container-registry/registry/README.md index a0116062d8..27720aff64 100644 --- a/modules/container-registry/registry/README.md +++ b/modules/container-registry/registry/README.md @@ -583,7 +583,14 @@ Tier of your Azure container registry. - Required: No - Type: string - Default: `'Basic'` -- Allowed: `[Basic, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `anonymousPullEnabled` @@ -598,7 +605,13 @@ The value that indicates whether the policy for using ARM audience token for a c - Required: No - Type: string - Default: `'enabled'` -- Allowed: `[disabled, enabled]` +- Allowed: + ```Bicep + [ + 'disabled' + 'enabled' + ] + ``` ### Parameter: `cacheRules` @@ -770,7 +783,13 @@ The value that indicates whether the export policy is enabled or not. - Required: No - Type: string - Default: `'disabled'` -- Allowed: `[disabled, enabled]` +- Allowed: + ```Bicep + [ + 'disabled' + 'enabled' + ] + ``` ### Parameter: `location` @@ -844,7 +863,13 @@ Whether to allow trusted Azure services to access a network restricted registry. - Required: No - Type: string - Default: `'AzureServices'` -- Allowed: `[AzureServices, None]` +- Allowed: + ```Bicep + [ + 'AzureServices' + 'None' + ] + ``` ### Parameter: `networkRuleSetDefaultAction` @@ -852,7 +877,13 @@ The default action of allow or deny when no other rules match. - Required: No - Type: string - Default: `'Deny'` -- Allowed: `[Allow, Deny]` +- Allowed: + ```Bicep + [ + 'Allow' + 'Deny' + ] + ``` ### Parameter: `networkRuleSetIpRules` @@ -1035,7 +1066,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `quarantinePolicyStatus` @@ -1043,7 +1081,13 @@ The value that indicates whether the quarantine policy is enabled or not. - Required: No - Type: string - Default: `'disabled'` -- Allowed: `[disabled, enabled]` +- Allowed: + ```Bicep + [ + 'disabled' + 'enabled' + ] + ``` ### Parameter: `replications` @@ -1065,7 +1109,13 @@ The value that indicates whether the retention policy is enabled or not. - Required: No - Type: string - Default: `'enabled'` -- Allowed: `[disabled, enabled]` +- Allowed: + ```Bicep + [ + 'disabled' + 'enabled' + ] + ``` ### Parameter: `roleAssignments` @@ -1148,7 +1198,13 @@ Soft Delete policy status. Default is disabled. - Required: No - Type: string - Default: `'disabled'` -- Allowed: `[disabled, enabled]` +- Allowed: + ```Bicep + [ + 'disabled' + 'enabled' + ] + ``` ### Parameter: `tags` @@ -1162,7 +1218,13 @@ The value that indicates whether the trust policy is enabled or not. - Required: No - Type: string - Default: `'disabled'` -- Allowed: `[disabled, enabled]` +- Allowed: + ```Bicep + [ + 'disabled' + 'enabled' + ] + ``` ### Parameter: `webhooks` @@ -1177,7 +1239,13 @@ Whether or not zone redundancy is enabled for this container registry. - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ## Outputs diff --git a/modules/container-registry/registry/replication/README.md b/modules/container-registry/registry/replication/README.md index 90104f8954..1dbe5d559c 100644 --- a/modules/container-registry/registry/replication/README.md +++ b/modules/container-registry/registry/replication/README.md @@ -84,7 +84,13 @@ Whether or not zone redundancy is enabled for this container registry. - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ## Outputs diff --git a/modules/container-registry/registry/webhook/README.md b/modules/container-registry/registry/webhook/README.md index 978954919c..380e28389e 100644 --- a/modules/container-registry/registry/webhook/README.md +++ b/modules/container-registry/registry/webhook/README.md @@ -47,14 +47,23 @@ This module deploys an Azure Container Registry (ACR) Webhook. The list of actions that trigger the webhook to post notifications. - Required: No - Type: array -- Default: `[chart_delete, chart_push, delete, push, quarantine]` +- Default: + ```Bicep + [ + 'chart_delete' + 'chart_push' + 'delete' + 'push' + 'quarantine' + ] + ``` ### Parameter: `customHeaders` Custom headers that will be added to the webhook notifications. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -102,7 +111,13 @@ The status of the webhook at the time the operation was called. - Required: No - Type: string - Default: `'enabled'` -- Allowed: `[disabled, enabled]` +- Allowed: + ```Bicep + [ + 'disabled' + 'enabled' + ] + ``` ### Parameter: `tags` diff --git a/modules/container-service/managed-cluster/README.md b/modules/container-service/managed-cluster/README.md index b9d850bd99..f77784354b 100644 --- a/modules/container-service/managed-cluster/README.md +++ b/modules/container-service/managed-cluster/README.md @@ -1300,7 +1300,7 @@ Define one or more secondary/additional agent pools. Information about a service principal identity for the cluster to use for manipulating Azure APIs. Required if no managed identities are assigned to the cluster. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `appGatewayResourceId` @@ -1322,7 +1322,13 @@ Specifies the balance of similar node groups for the auto-scaler of the AKS clus - Required: No - Type: string - Default: `'false'` -- Allowed: `[false, true]` +- Allowed: + ```Bicep + [ + 'false' + 'true' + ] + ``` ### Parameter: `autoScalerProfileExpander` @@ -1330,7 +1336,15 @@ Specifies the expand strategy for the auto-scaler of the AKS cluster. - Required: No - Type: string - Default: `'random'` -- Allowed: `[least-waste, most-pods, priority, random]` +- Allowed: + ```Bicep + [ + 'least-waste' + 'most-pods' + 'priority' + 'random' + ] + ``` ### Parameter: `autoScalerProfileMaxEmptyBulkDelete` @@ -1422,7 +1436,13 @@ Specifies if nodes with local storage should be skipped for the auto-scaler of t - Required: No - Type: string - Default: `'true'` -- Allowed: `[false, true]` +- Allowed: + ```Bicep + [ + 'false' + 'true' + ] + ``` ### Parameter: `autoScalerProfileSkipNodesWithSystemPods` @@ -1430,7 +1450,13 @@ Specifies if nodes with system pods should be skipped for the auto-scaler of the - Required: No - Type: string - Default: `'true'` -- Allowed: `[false, true]` +- Allowed: + ```Bicep + [ + 'false' + 'true' + ] + ``` ### Parameter: `autoScalerProfileUtilizationThreshold` @@ -1445,7 +1471,17 @@ Auto-upgrade channel on the AKS cluster. - Required: No - Type: string - Default: `''` -- Allowed: `['', node-image, none, patch, rapid, stable]` +- Allowed: + ```Bicep + [ + '' + 'node-image' + 'none' + 'patch' + 'rapid' + 'stable' + ] + ``` ### Parameter: `azurePolicyEnabled` @@ -1687,7 +1723,13 @@ Specifies whether the KeyvaultSecretsProvider add-on uses secret rotation. - Required: No - Type: string - Default: `'false'` -- Allowed: `[false, true]` +- Allowed: + ```Bicep + [ + 'false' + 'true' + ] + ``` ### Parameter: `enableStorageProfileBlobCSIDriver` @@ -1729,14 +1771,14 @@ Whether to enable Workload Identity. Requires OIDC issuer profile to be enabled. Configuration settings that are sensitive, as name-value pairs for configuring this extension. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `fluxExtension` Settings and configurations for the flux extension. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `httpApplicationRoutingEnabled` @@ -1750,14 +1792,14 @@ Specifies whether the httpApplicationRouting add-on is enabled or not. Configurations for provisioning the cluster with HTTP proxy servers. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `identityProfile` Identities associated with the cluster. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `ingressApplicationGatewayEnabled` @@ -1786,7 +1828,13 @@ Specifies the sku of the load balancer used by the virtual machine scale sets us - Required: No - Type: string - Default: `'standard'` -- Allowed: `[basic, standard]` +- Allowed: + ```Bicep + [ + 'basic' + 'standard' + ] + ``` ### Parameter: `location` @@ -1874,7 +1922,14 @@ Network dataplane used in the Kubernetes cluster. Not compatible with kubenet ne - Required: No - Type: string - Default: `''` -- Allowed: `['', azure, cilium]` +- Allowed: + ```Bicep + [ + '' + 'azure' + 'cilium' + ] + ``` ### Parameter: `networkPlugin` @@ -1882,7 +1937,14 @@ Specifies the network plugin used for building Kubernetes network. - Required: No - Type: string - Default: `''` -- Allowed: `['', azure, kubenet]` +- Allowed: + ```Bicep + [ + '' + 'azure' + 'kubenet' + ] + ``` ### Parameter: `networkPluginMode` @@ -1890,7 +1952,13 @@ Network plugin mode used for building the Kubernetes network. Not compatible wit - Required: No - Type: string - Default: `''` -- Allowed: `['', overlay]` +- Allowed: + ```Bicep + [ + '' + 'overlay' + ] + ``` ### Parameter: `networkPolicy` @@ -1898,7 +1966,14 @@ Specifies the network policy used for building Kubernetes network. - calico or a - Required: No - Type: string - Default: `''` -- Allowed: `['', azure, calico]` +- Allowed: + ```Bicep + [ + '' + 'azure' + 'calico' + ] + ``` ### Parameter: `nodeResourceGroup` @@ -1927,7 +2002,13 @@ Specifies outbound (egress) routing method. - loadBalancer or userDefinedRouting - Required: No - Type: string - Default: `'loadBalancer'` -- Allowed: `[loadBalancer, userDefinedRouting]` +- Allowed: + ```Bicep + [ + 'loadBalancer' + 'userDefinedRouting' + ] + ``` ### Parameter: `podCidr` @@ -2058,7 +2139,14 @@ Tier of a managed cluster SKU. - Free or Standard. - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `sshPublicKey` @@ -2073,7 +2161,13 @@ The support plan for the Managed Cluster. - Required: No - Type: string - Default: `'KubernetesOfficial'` -- Allowed: `[AKSLongTermSupport, KubernetesOfficial]` +- Allowed: + ```Bicep + [ + 'AKSLongTermSupport' + 'KubernetesOfficial' + ] + ``` ### Parameter: `tags` diff --git a/modules/container-service/managed-cluster/agent-pool/README.md b/modules/container-service/managed-cluster/agent-pool/README.md index c2dda9f91f..ea2052f582 100644 --- a/modules/container-service/managed-cluster/agent-pool/README.md +++ b/modules/container-service/managed-cluster/agent-pool/README.md @@ -131,7 +131,17 @@ GPUInstanceProfile to be used to specify GPU MIG instance profile for supported - Required: No - Type: string - Default: `''` -- Allowed: `['', MIG1g, MIG2g, MIG3g, MIG4g, MIG7g]` +- Allowed: + ```Bicep + [ + '' + 'MIG1g' + 'MIG2g' + 'MIG3g' + 'MIG4g' + 'MIG7g' + ] + ``` ### Parameter: `kubeletDiskType` @@ -192,7 +202,7 @@ Name of the agent pool. The node labels to be persisted across all nodes in agent pool. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `nodePublicIpPrefixId` @@ -228,7 +238,14 @@ The default is "Ephemeral" if the VM supports it and has a cache disk larger tha - Required: No - Type: string - Default: `''` -- Allowed: `['', Ephemeral, Managed]` +- Allowed: + ```Bicep + [ + '' + 'Ephemeral' + 'Managed' + ] + ``` ### Parameter: `osSku` @@ -236,7 +253,17 @@ Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is - Required: No - Type: string - Default: `''` -- Allowed: `['', AzureLinux, CBLMariner, Ubuntu, Windows2019, Windows2022]` +- Allowed: + ```Bicep + [ + '' + 'AzureLinux' + 'CBLMariner' + 'Ubuntu' + 'Windows2019' + 'Windows2022' + ] + ``` ### Parameter: `osType` @@ -244,7 +271,13 @@ The operating system type. The default is Linux. - Required: No - Type: string - Default: `'Linux'` -- Allowed: `[Linux, Windows]` +- Allowed: + ```Bicep + [ + 'Linux' + 'Windows' + ] + ``` ### Parameter: `podSubnetId` @@ -266,7 +299,13 @@ Describes how VMs are added to or removed from Agent Pools. See billing states ( - Required: No - Type: string - Default: `'Delete'` -- Allowed: `[Deallocate, Delete]` +- Allowed: + ```Bicep + [ + 'Deallocate' + 'Delete' + ] + ``` ### Parameter: `scaleSetEvictionPolicy` @@ -274,7 +313,13 @@ The eviction policy specifies what to do with the VM when it is evicted. The def - Required: No - Type: string - Default: `'Delete'` -- Allowed: `[Deallocate, Delete]` +- Allowed: + ```Bicep + [ + 'Deallocate' + 'Delete' + ] + ``` ### Parameter: `scaleSetPriority` @@ -282,7 +327,14 @@ The Virtual Machine Scale Set priority. - Required: No - Type: string - Default: `''` -- Allowed: `['', Regular, Spot]` +- Allowed: + ```Bicep + [ + '' + 'Regular' + 'Spot' + ] + ``` ### Parameter: `sourceResourceId` diff --git a/modules/data-factory/factory/README.md b/modules/data-factory/factory/README.md index 8b1c5eb5c7..8c0c5003d4 100644 --- a/modules/data-factory/factory/README.md +++ b/modules/data-factory/factory/README.md @@ -593,7 +593,7 @@ The root folder path name. Default is '/'. List of Global Parameters for the factory. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `integrationRuntimes` @@ -856,7 +856,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/data-factory/factory/integration-runtime/README.md b/modules/data-factory/factory/integration-runtime/README.md index 27111ad237..0e9de57341 100644 --- a/modules/data-factory/factory/integration-runtime/README.md +++ b/modules/data-factory/factory/integration-runtime/README.md @@ -70,14 +70,20 @@ The name of the Integration Runtime. The type of Integration Runtime. - Required: Yes - Type: string -- Allowed: `[Managed, SelfHosted]` +- Allowed: + ```Bicep + [ + 'Managed' + 'SelfHosted' + ] + ``` ### Parameter: `typeProperties` Integration Runtime type properties. Required if type is "Managed". - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/data-protection/backup-vault/README.md b/modules/data-protection/backup-vault/README.md index 68efc247f0..8784320e19 100644 --- a/modules/data-protection/backup-vault/README.md +++ b/modules/data-protection/backup-vault/README.md @@ -335,7 +335,13 @@ Settings for Azure Monitor based alerts for job failures. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `backupPolicies` @@ -350,7 +356,14 @@ The datastore type to use. ArchiveStore does not support ZoneRedundancy. - Required: No - Type: string - Default: `'VaultStore'` -- Allowed: `[ArchiveStore, OperationalStore, VaultStore]` +- Allowed: + ```Bicep + [ + 'ArchiveStore' + 'OperationalStore' + 'VaultStore' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -364,7 +377,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). Feature settings for the backup vault. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` @@ -497,7 +510,7 @@ Required. The name of the role to assign. If it cannot be found you can specify Security settings for the backup vault. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `tags` @@ -511,7 +524,14 @@ The vault redundancy level to use. - Required: No - Type: string - Default: `'GeoRedundant'` -- Allowed: `[GeoRedundant, LocallyRedundant, ZoneRedundant]` +- Allowed: + ```Bicep + [ + 'GeoRedundant' + 'LocallyRedundant' + 'ZoneRedundant' + ] + ``` ## Outputs diff --git a/modules/data-protection/backup-vault/backup-policy/README.md b/modules/data-protection/backup-vault/backup-policy/README.md index 169a76f3d5..07cfc9da89 100644 --- a/modules/data-protection/backup-vault/backup-policy/README.md +++ b/modules/data-protection/backup-vault/backup-policy/README.md @@ -57,7 +57,7 @@ The name of the backup policy. The properties of the backup policy. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/databricks/workspace/README.md b/modules/databricks/workspace/README.md index 12e776c7f6..402bcdc57f 100644 --- a/modules/databricks/workspace/README.md +++ b/modules/databricks/workspace/README.md @@ -818,7 +818,13 @@ Name of the Public IP for No Public IP workspace with managed vNet. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `requiredNsgRules` @@ -826,7 +832,13 @@ Gets or sets a value indicating whether data plane (clusters) to control plane c - Required: No - Type: string - Default: `'AllRules'` -- Allowed: `[AllRules, NoAzureDatabricksRules]` +- Allowed: + ```Bicep + [ + 'AllRules' + 'NoAzureDatabricksRules' + ] + ``` ### Parameter: `requireInfrastructureEncryption` @@ -909,7 +921,14 @@ The pricing tier of workspace. - Required: No - Type: string - Default: `'premium'` -- Allowed: `[premium, standard, trial]` +- Allowed: + ```Bicep + [ + 'premium' + 'standard' + 'trial' + ] + ``` ### Parameter: `storageAccountName` diff --git a/modules/db-for-my-sql/flexible-server/README.md b/modules/db-for-my-sql/flexible-server/README.md index 7d4bbf44bf..fbc748a98e 100644 --- a/modules/db-for-my-sql/flexible-server/README.md +++ b/modules/db-for-my-sql/flexible-server/README.md @@ -652,7 +652,15 @@ Availability zone information of the server. Default will have no preference set - Required: No - Type: string - Default: `''` -- Allowed: `['', 1, 2, 3]` +- Allowed: + ```Bicep + [ + '' + '1' + '2' + '3' + ] + ``` ### Parameter: `backupRetentionDays` @@ -695,7 +703,15 @@ The mode to create a new MySQL server. - Required: No - Type: string - Default: `'Default'` -- Allowed: `[Default, GeoRestore, PointInTimeRestore, Replica]` +- Allowed: + ```Bicep + [ + 'Default' + 'GeoRestore' + 'PointInTimeRestore' + 'Replica' + ] + ``` ### Parameter: `databases` @@ -874,7 +890,13 @@ A value indicating whether Geo-Redundant backup is enabled on the server. If "En - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `highAvailability` @@ -882,7 +904,14 @@ The mode for High Availability (HA). It is not supported for the Burstable prici - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, SameZone, ZoneRedundant]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'SameZone' + 'ZoneRedundant' + ] + ``` ### Parameter: `location` @@ -923,7 +952,7 @@ Optional. Specify the name of lock. Properties for the maintenence window. If provided, "customWindow" property must exist and set to "Enabled". - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `managedIdentities` @@ -962,7 +991,14 @@ The replication role. - Required: No - Type: string - Default: `'None'` -- Allowed: `[None, Replica, Source]` +- Allowed: + ```Bicep + [ + 'None' + 'Replica' + 'Source' + ] + ``` ### Parameter: `restorePointInTime` @@ -1058,7 +1094,13 @@ Enable Storage Auto Grow or not. Storage auto-growth prevents a server from runn - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `storageAutoIoScaling` @@ -1066,7 +1108,13 @@ Enable IO Auto Scaling or not. The server scales IOPs up or down automatically d - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `storageIOPS` @@ -1081,7 +1129,22 @@ Max storage allowed for a server. In all compute tiers, the minimum storage supp - Required: No - Type: int - Default: `64` -- Allowed: `[20, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384]` +- Allowed: + ```Bicep + [ + 20 + 32 + 64 + 128 + 256 + 512 + 1024 + 2048 + 4096 + 8192 + 16384 + ] + ``` ### Parameter: `tags` @@ -1094,7 +1157,14 @@ Tags of the resource. The tier of the particular SKU. Tier must align with the "skuName" property. Example, tier cannot be "Burstable" if skuName is "Standard_D4s_v3". - Required: Yes - Type: string -- Allowed: `[Burstable, GeneralPurpose, MemoryOptimized]` +- Allowed: + ```Bicep + [ + 'Burstable' + 'GeneralPurpose' + 'MemoryOptimized' + ] + ``` ### Parameter: `version` @@ -1102,7 +1172,13 @@ MySQL Server version. - Required: No - Type: string - Default: `'5.7'` -- Allowed: `[5.7, 8.0.21]` +- Allowed: + ```Bicep + [ + '5.7' + '8.0.21' + ] + ``` ## Outputs diff --git a/modules/db-for-postgre-sql/flexible-server/README.md b/modules/db-for-postgre-sql/flexible-server/README.md index 30db670f19..157b30d978 100644 --- a/modules/db-for-postgre-sql/flexible-server/README.md +++ b/modules/db-for-postgre-sql/flexible-server/README.md @@ -558,7 +558,13 @@ If Enabled, Azure Active Directory authentication is enabled. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `administratorLogin` @@ -587,7 +593,15 @@ Availability zone information of the server. Default will have no preference set - Required: No - Type: string - Default: `''` -- Allowed: `['', 1, 2, 3]` +- Allowed: + ```Bicep + [ + '' + '1' + '2' + '3' + ] + ``` ### Parameter: `backupRetentionDays` @@ -637,7 +651,15 @@ The mode to create a new PostgreSQL server. - Required: No - Type: string - Default: `'Default'` -- Allowed: `[Create, Default, PointInTimeRestore, Update]` +- Allowed: + ```Bicep + [ + 'Create' + 'Default' + 'PointInTimeRestore' + 'Update' + ] + ``` ### Parameter: `databases` @@ -788,7 +810,13 @@ A value indicating whether Geo-Redundant backup is enabled on the server. Should - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `highAvailability` @@ -796,7 +824,14 @@ The mode for high availability. - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, SameZone, ZoneRedundant]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'SameZone' + 'ZoneRedundant' + ] + ``` ### Parameter: `location` @@ -837,7 +872,7 @@ Optional. Specify the name of lock. Properties for the maintenence window. If provided, "customWindow" property must exist and set to "Enabled". - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `managedIdentities` @@ -869,7 +904,13 @@ If Enabled, password authentication is enabled. - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `pointInTimeUTC` @@ -972,7 +1013,21 @@ Max storage allowed for a server. - Required: No - Type: int - Default: `32` -- Allowed: `[32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384]` +- Allowed: + ```Bicep + [ + 32 + 64 + 128 + 256 + 512 + 1024 + 2048 + 4096 + 8192 + 16384 + ] + ``` ### Parameter: `tags` @@ -992,7 +1047,14 @@ Tenant id of the server. The tier of the particular SKU. Tier must align with the "skuName" property. Example, tier cannot be "Burstable" if skuName is "Standard_D4s_v3". - Required: Yes - Type: string -- Allowed: `[Burstable, GeneralPurpose, MemoryOptimized]` +- Allowed: + ```Bicep + [ + 'Burstable' + 'GeneralPurpose' + 'MemoryOptimized' + ] + ``` ### Parameter: `version` @@ -1000,7 +1062,16 @@ PostgreSQL Server version. - Required: No - Type: string - Default: `'15'` -- Allowed: `[11, 12, 13, 14, 15]` +- Allowed: + ```Bicep + [ + '11' + '12' + '13' + '14' + '15' + ] + ``` ## Outputs diff --git a/modules/db-for-postgre-sql/flexible-server/administrator/README.md b/modules/db-for-postgre-sql/flexible-server/administrator/README.md index 64e08316bd..3c95a48a9c 100644 --- a/modules/db-for-postgre-sql/flexible-server/administrator/README.md +++ b/modules/db-for-postgre-sql/flexible-server/administrator/README.md @@ -76,7 +76,15 @@ Active Directory administrator principal name. The principal type used to represent the type of Active Directory Administrator. - Required: Yes - Type: string -- Allowed: `[Group, ServicePrincipal, Unknown, User]` +- Allowed: + ```Bicep + [ + 'Group' + 'ServicePrincipal' + 'Unknown' + 'User' + ] + ``` ### Parameter: `tenantId` diff --git a/modules/desktop-virtualization/application-group/README.md b/modules/desktop-virtualization/application-group/README.md index 400891b5b2..7e86196f3e 100644 --- a/modules/desktop-virtualization/application-group/README.md +++ b/modules/desktop-virtualization/application-group/README.md @@ -281,7 +281,13 @@ module applicationGroup 'br:bicep/modules/desktop-virtualization.application-gro The type of the Application Group to be created. Allowed values: RemoteApp or Desktop. - Required: Yes - Type: string -- Allowed: `[Desktop, RemoteApp]` +- Allowed: + ```Bicep + [ + 'Desktop' + 'RemoteApp' + ] + ``` ### Parameter: `applications` diff --git a/modules/desktop-virtualization/application-group/application/README.md b/modules/desktop-virtualization/application-group/application/README.md index cc46be1fbe..61b2562dac 100644 --- a/modules/desktop-virtualization/application-group/application/README.md +++ b/modules/desktop-virtualization/application-group/application/README.md @@ -62,7 +62,14 @@ Specifies whether this published application can be launched with command-line a - Required: No - Type: string - Default: `'DoNotAllow'` -- Allowed: `[Allow, DoNotAllow, Require]` +- Allowed: + ```Bicep + [ + 'Allow' + 'DoNotAllow' + 'Require' + ] + ``` ### Parameter: `description` diff --git a/modules/desktop-virtualization/host-pool/README.md b/modules/desktop-virtualization/host-pool/README.md index be6dc2e213..03ed873f95 100644 --- a/modules/desktop-virtualization/host-pool/README.md +++ b/modules/desktop-virtualization/host-pool/README.md @@ -339,7 +339,15 @@ module hostPool 'br:bicep/modules/desktop-virtualization.host-pool:1.0.0' = { The session host configuration for updating agent, monitoring agent, and stack component. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + maintenanceWindows: '[parameters(\'agentUpdateMaintenanceWindows\')]' + maintenanceWindowTimeZone: '[parameters(\'agentUpdateMaintenanceWindowTimeZone\')]' + type: '[parameters(\'agentUpdateType\')]' + useSessionHostLocalTime: '[parameters(\'agentUpdateUseSessionHostLocalTime\')]' + } + ``` ### Parameter: `agentUpdateMaintenanceWindowDayOfWeek` @@ -347,7 +355,18 @@ Update day for scheduled agent updates. - Required: No - Type: string - Default: `'Sunday'` -- Allowed: `[Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday]` +- Allowed: + ```Bicep + [ + 'Friday' + 'Monday' + 'Saturday' + 'Sunday' + 'Thursday' + 'Tuesday' + 'Wednesday' + ] + ``` ### Parameter: `agentUpdateMaintenanceWindowHour` @@ -361,7 +380,15 @@ Update hour for scheduled agent updates. List of maintenance windows for scheduled agent updates. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + dayOfWeek: '[parameters(\'agentUpdateMaintenanceWindowDayOfWeek\')]' + hour: '[parameters(\'agentUpdateMaintenanceWindowHour\')]' + } + ] + ``` ### Parameter: `agentUpdateMaintenanceWindowTimeZone` @@ -376,7 +403,13 @@ Enable scheduled agent updates, Default means agent updates will automatically b - Required: No - Type: string - Default: `'Default'` -- Allowed: `[Default, Scheduled]` +- Allowed: + ```Bicep + [ + 'Default' + 'Scheduled' + ] + ``` ### Parameter: `agentUpdateUseSessionHostLocalTime` @@ -521,7 +554,14 @@ Type of load balancer algorithm. - Required: No - Type: string - Default: `'BreadthFirst'` -- Allowed: `[BreadthFirst, DepthFirst, Persistent]` +- Allowed: + ```Bicep + [ + 'BreadthFirst' + 'DepthFirst' + 'Persistent' + ] + ``` ### Parameter: `location` @@ -576,7 +616,14 @@ Set the type of assignment for a Personal Host Pool type. - Required: No - Type: string - Default: `''` -- Allowed: `['', Automatic, Direct]` +- Allowed: + ```Bicep + [ + '' + 'Automatic' + 'Direct' + ] + ``` ### Parameter: `preferredAppGroupType` @@ -584,7 +631,14 @@ The type of preferred application group type, default to Desktop Application Gro - Required: No - Type: string - Default: `'Desktop'` -- Allowed: `[Desktop, None, RailApplications]` +- Allowed: + ```Bicep + [ + 'Desktop' + 'None' + 'RailApplications' + ] + ``` ### Parameter: `ring` @@ -688,7 +742,16 @@ The type of single sign on Secret Type. - Required: No - Type: string - Default: `''` -- Allowed: `['', Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault]` +- Allowed: + ```Bicep + [ + '' + 'Certificate' + 'CertificateInKeyVault' + 'SharedKey' + 'SharedKeyInKeyVault' + ] + ``` ### Parameter: `startVMOnConnect` @@ -716,7 +779,13 @@ Set this parameter to Personal if you would like to enable Persistent Desktop ex - Required: No - Type: string - Default: `'Pooled'` -- Allowed: `[Personal, Pooled]` +- Allowed: + ```Bicep + [ + 'Personal' + 'Pooled' + ] + ``` ### Parameter: `validationEnvironment` @@ -730,7 +799,7 @@ Validation host pools allows you to test service changes before they are deploye The necessary information for adding more VMs to this Host Pool. The object is converted to an in-line string when handed over to the resource deployment, since that only takes strings. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/desktop-virtualization/scaling-plan/README.md b/modules/desktop-virtualization/scaling-plan/README.md index dae9ec2b75..032df11696 100644 --- a/modules/desktop-virtualization/scaling-plan/README.md +++ b/modules/desktop-virtualization/scaling-plan/README.md @@ -429,7 +429,12 @@ The type of hostpool where this scaling plan should be applied. - Required: No - Type: string - Default: `'Pooled'` -- Allowed: `[Pooled]` +- Allowed: + ```Bicep + [ + 'Pooled' + ] + ``` ### Parameter: `location` @@ -517,7 +522,49 @@ Required. The name of the role to assign. If it cannot be found you can specify The schedules related to this scaling plan. If no value is provided a default schedule will be provided. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + daysOfWeek: [ + 'Friday' + 'Monday' + 'Thursday' + 'Tuesday' + 'Wednesday' + ] + name: 'weekdays_schedule' + offPeakLoadBalancingAlgorithm: 'DepthFirst' + offPeakStartTime: { + hour: 20 + minute: 0 + } + peakLoadBalancingAlgorithm: 'DepthFirst' + peakStartTime: { + hour: 9 + minute: 0 + } + rampDownCapacityThresholdPct: 90 + rampDownForceLogoffUsers: true + rampDownLoadBalancingAlgorithm: 'DepthFirst' + rampDownMinimumHostsPct: 10 + rampDownNotificationMessage: 'You will be logged off in 30 min. Make sure to save your work.' + rampDownStartTime: { + hour: 18 + minute: 0 + } + rampDownStopHostsWhen: 'ZeroSessions' + rampDownWaitTimeMinutes: 30 + rampUpCapacityThresholdPct: 60 + rampUpLoadBalancingAlgorithm: 'DepthFirst' + rampUpMinimumHostsPct: 20 + rampUpStartTime: { + hour: 7 + minute: 0 + } + } + ] + ``` ### Parameter: `tags` diff --git a/modules/dev-test-lab/lab/README.md b/modules/dev-test-lab/lab/README.md index e506fa7f34..be1f1cc67e 100644 --- a/modules/dev-test-lab/lab/README.md +++ b/modules/dev-test-lab/lab/README.md @@ -677,7 +677,7 @@ module lab 'br:bicep/modules/dev-test-lab.lab:1.0.0' = { The properties of any lab announcement associated with this lab. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `artifactsources` @@ -699,14 +699,20 @@ Enable browser connect on virtual machines if the lab's VNETs have configured Az - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `costs` Costs to create for the lab. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `disableAutoUpgradeCseMinorVersion` @@ -735,7 +741,13 @@ Specify how OS and data disks created as part of the lab are encrypted. - Required: No - Type: string - Default: `'EncryptionAtRestWithPlatformKey'` -- Allowed: `[EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformKey]` +- Allowed: + ```Bicep + [ + 'EncryptionAtRestWithCustomerKey' + 'EncryptionAtRestWithPlatformKey' + ] + ``` ### Parameter: `environmentPermission` @@ -743,14 +755,20 @@ The access rights to be granted to the user when provisioning an environment. - Required: No - Type: string - Default: `'Reader'` -- Allowed: `[Contributor, Reader]` +- Allowed: + ```Bicep + [ + 'Contributor' + 'Reader' + ] + ``` ### Parameter: `extendedProperties` Extended properties of the lab used for experimental features. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `isolateLabResources` @@ -758,7 +776,13 @@ Enable lab resources isolation from the public internet. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `labStorageType` @@ -766,7 +790,14 @@ Type of storage used by the lab. It can be either Premium or Standard. - Required: No - Type: string - Default: `'Premium'` -- Allowed: `[Premium, Standard, StandardSSD]` +- Allowed: + ```Bicep + [ + 'Premium' + 'Standard' + 'StandardSSD' + ] + ``` ### Parameter: `location` @@ -867,7 +898,13 @@ The setting to enable usage of premium data disks. When its value is "Enabled", - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` @@ -949,7 +986,7 @@ Schedules to create for the lab. The properties of any lab support message associated with this lab. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `tags` diff --git a/modules/dev-test-lab/lab/artifactsource/README.md b/modules/dev-test-lab/lab/artifactsource/README.md index f2ac68cd9a..596527ee0d 100644 --- a/modules/dev-test-lab/lab/artifactsource/README.md +++ b/modules/dev-test-lab/lab/artifactsource/README.md @@ -106,7 +106,15 @@ The artifact source's type. - Required: No - Type: string - Default: `''` -- Allowed: `['', GitHub, StorageAccount, VsoGit]` +- Allowed: + ```Bicep + [ + '' + 'GitHub' + 'StorageAccount' + 'VsoGit' + ] + ``` ### Parameter: `status` @@ -114,7 +122,13 @@ Indicates if the artifact source is enabled (values: Enabled, Disabled). Default - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `tags` diff --git a/modules/dev-test-lab/lab/cost/README.md b/modules/dev-test-lab/lab/cost/README.md index 51d6302f23..7d50b0542b 100644 --- a/modules/dev-test-lab/lab/cost/README.md +++ b/modules/dev-test-lab/lab/cost/README.md @@ -79,7 +79,13 @@ Reporting cycle start date in the zulu time format (e.g. 2023-12-01T00:00:00.000 Reporting cycle type. - Required: Yes - Type: string -- Allowed: `[CalendarMonth, Custom]` +- Allowed: + ```Bicep + [ + 'CalendarMonth' + 'Custom' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -100,7 +106,13 @@ Target cost status. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `tags` @@ -121,7 +133,13 @@ Target Cost threshold at 100% display on chart. Indicates whether this threshold - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue100SendNotificationWhenExceeded` @@ -129,7 +147,13 @@ Target cost threshold at 100% send notification when exceeded. Indicates whether - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue125DisplayOnChart` @@ -137,7 +161,13 @@ Target Cost threshold at 125% display on chart. Indicates whether this threshold - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue125SendNotificationWhenExceeded` @@ -145,7 +175,13 @@ Target cost threshold at 125% send notification when exceeded. Indicates whether - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue25DisplayOnChart` @@ -153,7 +189,13 @@ Target Cost threshold at 25% display on chart. Indicates whether this threshold - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue25SendNotificationWhenExceeded` @@ -161,7 +203,13 @@ Target cost threshold at 25% send notification when exceeded. Indicates whether - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue50DisplayOnChart` @@ -169,7 +217,13 @@ Target Cost threshold at 50% display on chart. Indicates whether this threshold - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue50SendNotificationWhenExceeded` @@ -177,7 +231,13 @@ Target cost threshold at 50% send notification when exceeded. Indicates whether - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue75DisplayOnChart` @@ -185,7 +245,13 @@ Target Cost threshold at 75% display on chart. Indicates whether this threshold - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `thresholdValue75SendNotificationWhenExceeded` @@ -193,7 +259,13 @@ Target cost threshold at 75% send notification when exceeded. Indicates whether - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ## Outputs diff --git a/modules/dev-test-lab/lab/notificationchannel/README.md b/modules/dev-test-lab/lab/notificationchannel/README.md index 45abfc2693..026f51995a 100644 --- a/modules/dev-test-lab/lab/notificationchannel/README.md +++ b/modules/dev-test-lab/lab/notificationchannel/README.md @@ -82,7 +82,13 @@ The name of the parent lab. Required if the template is used in a standalone dep The name of the notification channel. - Required: Yes - Type: string -- Allowed: `[autoShutdown, costThreshold]` +- Allowed: + ```Bicep + [ + 'autoShutdown' + 'costThreshold' + ] + ``` ### Parameter: `notificationLocale` diff --git a/modules/dev-test-lab/lab/policyset/policy/README.md b/modules/dev-test-lab/lab/policyset/policy/README.md index cc9746dea5..21a43a924c 100644 --- a/modules/dev-test-lab/lab/policyset/policy/README.md +++ b/modules/dev-test-lab/lab/policyset/policy/README.md @@ -64,7 +64,13 @@ Enable telemetry via a Globally Unique Identifier (GUID). The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). - Required: Yes - Type: string -- Allowed: `[AllowedValuesPolicy, MaxValuePolicy]` +- Allowed: + ```Bicep + [ + 'AllowedValuesPolicy' + 'MaxValuePolicy' + ] + ``` ### Parameter: `factData` @@ -78,7 +84,21 @@ The fact data of the policy. The fact name of the policy. - Required: Yes - Type: string -- Allowed: `[EnvironmentTemplate, GalleryImage, LabPremiumVmCount, LabTargetCost, LabVmCount, LabVmSize, ScheduleEditPermission, UserOwnedLabPremiumVmCount, UserOwnedLabVmCount, UserOwnedLabVmCountInSubnet]` +- Allowed: + ```Bicep + [ + 'EnvironmentTemplate' + 'GalleryImage' + 'LabPremiumVmCount' + 'LabTargetCost' + 'LabVmCount' + 'LabVmSize' + 'ScheduleEditPermission' + 'UserOwnedLabPremiumVmCount' + 'UserOwnedLabVmCount' + 'UserOwnedLabVmCountInSubnet' + ] + ``` ### Parameter: `labName` @@ -105,14 +125,20 @@ The status of the policy. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `tags` Tags of the resource. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `threshold` diff --git a/modules/dev-test-lab/lab/schedule/README.md b/modules/dev-test-lab/lab/schedule/README.md index 293747d728..35c6ea868e 100644 --- a/modules/dev-test-lab/lab/schedule/README.md +++ b/modules/dev-test-lab/lab/schedule/README.md @@ -52,7 +52,7 @@ Lab schedules are used to modify the settings for auto-shutdown, auto-start for If the schedule will occur once each day of the week, specify the daily recurrence. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -66,7 +66,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). If the schedule will occur multiple times a day, specify the hourly recurrence. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `labName` @@ -79,7 +79,13 @@ The name of the parent lab. Required if the template is used in a standalone dep The name of the schedule. - Required: Yes - Type: string -- Allowed: `[LabVmAutoStart, LabVmsShutdown]` +- Allowed: + ```Bicep + [ + 'LabVmAutoStart' + 'LabVmsShutdown' + ] + ``` ### Parameter: `notificationSettingsStatus` @@ -87,7 +93,13 @@ If notifications are enabled for this schedule (i.e. Enabled, Disabled). - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `notificationSettingsTimeInMinutes` @@ -102,7 +114,13 @@ The status of the schedule (i.e. Enabled, Disabled). - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `tags` @@ -122,7 +140,13 @@ The resource ID to which the schedule belongs. The task type of the schedule (e.g. LabVmsShutdownTask, LabVmsStartupTask). - Required: Yes - Type: string -- Allowed: `[LabVmsShutdownTask, LabVmsStartupTask]` +- Allowed: + ```Bicep + [ + 'LabVmsShutdownTask' + 'LabVmsStartupTask' + ] + ``` ### Parameter: `timeZoneId` @@ -136,7 +160,7 @@ The time zone ID (e.g. Pacific Standard time). If the schedule will occur only some days of the week, specify the weekly recurrence. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/digital-twins/digital-twins-instance/README.md b/modules/digital-twins/digital-twins-instance/README.md index dcf0765ad2..8b7a1480d9 100644 --- a/modules/digital-twins/digital-twins-instance/README.md +++ b/modules/digital-twins/digital-twins-instance/README.md @@ -415,14 +415,14 @@ Enable telemetry via the Customer Usage Attribution ID (GUID). Event Grid Endpoint. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `eventHubEndpoint` Event Hub Endpoint. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` @@ -638,7 +638,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` @@ -713,7 +720,7 @@ Required. The name of the role to assign. If it cannot be found you can specify Service Bus Endpoint. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `systemAssignedIdentity` @@ -733,7 +740,7 @@ Resource tags. The ID(s) to assign to the resource. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/digital-twins/digital-twins-instance/endpoint--event-hub/README.md b/modules/digital-twins/digital-twins-instance/endpoint--event-hub/README.md index ea2990793c..0dd7790d4e 100644 --- a/modules/digital-twins/digital-twins-instance/endpoint--event-hub/README.md +++ b/modules/digital-twins/digital-twins-instance/endpoint--event-hub/README.md @@ -45,7 +45,13 @@ Specifies the authentication type being used for connecting to the endpoint. If - Required: No - Type: string - Default: `'IdentityBased'` -- Allowed: `[IdentityBased, KeyBased]` +- Allowed: + ```Bicep + [ + 'IdentityBased' + 'KeyBased' + ] + ``` ### Parameter: `connectionStringPrimaryKey` diff --git a/modules/digital-twins/digital-twins-instance/endpoint--service-bus/README.md b/modules/digital-twins/digital-twins-instance/endpoint--service-bus/README.md index eeae357cd9..fd96f9cd28 100644 --- a/modules/digital-twins/digital-twins-instance/endpoint--service-bus/README.md +++ b/modules/digital-twins/digital-twins-instance/endpoint--service-bus/README.md @@ -45,7 +45,13 @@ Specifies the authentication type being used for connecting to the endpoint. If - Required: No - Type: string - Default: `'IdentityBased'` -- Allowed: `[IdentityBased, KeyBased]` +- Allowed: + ```Bicep + [ + 'IdentityBased' + 'KeyBased' + ] + ``` ### Parameter: `deadLetterSecret` diff --git a/modules/document-db/database-account/README.md b/modules/document-db/database-account/README.md index 6891ab0f3d..de51a3b003 100644 --- a/modules/document-db/database-account/README.md +++ b/modules/document-db/database-account/README.md @@ -1325,7 +1325,13 @@ Configuration values for continuous mode backup. - Required: No - Type: string - Default: `'Continuous30Days'` -- Allowed: `[Continuous30Days, Continuous7Days]` +- Allowed: + ```Bicep + [ + 'Continuous30Days' + 'Continuous7Days' + ] + ``` ### Parameter: `backupPolicyType` @@ -1333,7 +1339,13 @@ Describes the mode of backups. - Required: No - Type: string - Default: `'Continuous'` -- Allowed: `[Continuous, Periodic]` +- Allowed: + ```Bicep + [ + 'Continuous' + 'Periodic' + ] + ``` ### Parameter: `backupRetentionIntervalInHours` @@ -1348,7 +1360,14 @@ Enum to indicate type of backup residency. Only applies to periodic backup type. - Required: No - Type: string - Default: `'Local'` -- Allowed: `[Geo, Local, Zone]` +- Allowed: + ```Bicep + [ + 'Geo' + 'Local' + 'Zone' + ] + ``` ### Parameter: `capabilitiesToAdd` @@ -1356,7 +1375,17 @@ List of Cosmos DB capabilities for the account. - Required: No - Type: array - Default: `[]` -- Allowed: `[DisableRateLimitingResponses, EnableCassandra, EnableGremlin, EnableMongo, EnableServerless, EnableTable]` +- Allowed: + ```Bicep + [ + 'DisableRateLimitingResponses' + 'EnableCassandra' + 'EnableGremlin' + 'EnableMongo' + 'EnableServerless' + 'EnableTable' + ] + ``` ### Parameter: `databaseAccountOfferType` @@ -1364,7 +1393,12 @@ The offer type for the Cosmos DB database account. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Standard]` +- Allowed: + ```Bicep + [ + 'Standard' + ] + ``` ### Parameter: `defaultConsistencyLevel` @@ -1372,7 +1406,16 @@ The default consistency level of the Cosmos DB account. - Required: No - Type: string - Default: `'Session'` -- Allowed: `[BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong]` +- Allowed: + ```Bicep + [ + 'BoundedStaleness' + 'ConsistentPrefix' + 'Eventual' + 'Session' + 'Strong' + ] + ``` ### Parameter: `diagnosticSettings` @@ -1845,7 +1888,15 @@ Specifies the MongoDB server version to use. - Required: No - Type: string - Default: `'4.2'` -- Allowed: `[3.2, 3.6, 4.0, 4.2]` +- Allowed: + ```Bicep + [ + '3.2' + '3.6' + '4.0' + '4.2' + ] + ``` ### Parameter: `sqlDatabases` diff --git a/modules/document-db/database-account/gremlin-database/graph/README.md b/modules/document-db/database-account/gremlin-database/graph/README.md index b682df47c6..6e358a9bfe 100644 --- a/modules/document-db/database-account/gremlin-database/graph/README.md +++ b/modules/document-db/database-account/gremlin-database/graph/README.md @@ -64,7 +64,7 @@ The name of the parent Gremlin Database. Required if the template is used in a s Indexing policy of the graph. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/document-db/database-account/gremlin-database/main.json b/modules/document-db/database-account/gremlin-database/main.json index 7d513e6420..6210f39a32 100644 --- a/modules/document-db/database-account/gremlin-database/main.json +++ b/modules/document-db/database-account/gremlin-database/main.json @@ -6,7 +6,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "1439508098279696940" + "templateHash": "9027351090124444562" }, "name": "DocumentDB Database Account Gremlin Databases", "description": "This module deploys a Gremlin Database within a CosmosDB Account.", @@ -318,4 +318,4 @@ "value": "[resourceGroup().name]" } } -} +} \ No newline at end of file diff --git a/modules/document-db/database-account/sql-database/container/README.md b/modules/document-db/database-account/sql-database/container/README.md index a6621174f4..cc46af3c67 100644 --- a/modules/document-db/database-account/sql-database/container/README.md +++ b/modules/document-db/database-account/sql-database/container/README.md @@ -66,7 +66,7 @@ Specifies the Autoscale settings and represents maximum throughput, the resource The conflict resolution policy for the container. Conflicts and conflict resolution policies are applicable if the Azure Cosmos DB account is configured with multiple write regions. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `databaseAccountName` @@ -93,7 +93,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). Indexing policy of the container. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `kind` @@ -101,7 +101,14 @@ Indicates the kind of algorithm used for partitioning. - Required: No - Type: string - Default: `'Hash'` -- Allowed: `[Hash, MultiHash, Range]` +- Allowed: + ```Bicep + [ + 'Hash' + 'MultiHash' + 'Range' + ] + ``` ### Parameter: `name` diff --git a/modules/event-grid/domain/README.md b/modules/event-grid/domain/README.md index c72c581389..636322d154 100644 --- a/modules/event-grid/domain/README.md +++ b/modules/event-grid/domain/README.md @@ -718,7 +718,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/event-grid/system-topic/event-subscription/README.md b/modules/event-grid/system-topic/event-subscription/README.md index d488702524..f8c63e5e22 100644 --- a/modules/event-grid/system-topic/event-subscription/README.md +++ b/modules/event-grid/system-topic/event-subscription/README.md @@ -45,21 +45,21 @@ This module deploys an Event Grid System Topic Event Subscription. Dead Letter Destination. (See https://learn.microsoft.com/en-us/azure/templates/microsoft.eventgrid/eventsubscriptions?pivots=deployment-language-bicep#deadletterdestination-objects for more information). - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `deadLetterWithResourceIdentity` Dead Letter with Resource Identity Configuration. (See https://learn.microsoft.com/en-us/azure/templates/microsoft.eventgrid/eventsubscriptions?pivots=deployment-language-bicep#deadletterwithresourceidentity-objects for more information). - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `deliveryWithResourceIdentity` Delivery with Resource Identity Configuration. (See https://learn.microsoft.com/en-us/azure/templates/microsoft.eventgrid/eventsubscriptions?pivots=deployment-language-bicep#deliverywithresourceidentity-objects for more information). - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `destination` @@ -80,7 +80,15 @@ The event delivery schema for the event subscription. - Required: No - Type: string - Default: `'EventGridSchema'` -- Allowed: `[CloudEventSchemaV1_0, CustomInputSchema, EventGridEvent, EventGridSchema]` +- Allowed: + ```Bicep + [ + 'CloudEventSchemaV1_0' + 'CustomInputSchema' + 'EventGridEvent' + 'EventGridSchema' + ] + ``` ### Parameter: `expirationTimeUtc` @@ -94,7 +102,7 @@ The expiration time for the event subscription. Format is ISO-8601 (yyyy-MM-ddTH The filter for the event subscription. (See https://learn.microsoft.com/en-us/azure/templates/microsoft.eventgrid/eventsubscriptions?pivots=deployment-language-bicep#eventsubscriptionfilter for more information). - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `labels` @@ -121,7 +129,7 @@ The name of the Event Subscription. The retry policy for events. This can be used to configure the TTL and maximum number of delivery attempts and time to live for events. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `systemTopicName` diff --git a/modules/event-grid/topic/README.md b/modules/event-grid/topic/README.md index 363cdc2cc0..8f7c1adab0 100644 --- a/modules/event-grid/topic/README.md +++ b/modules/event-grid/topic/README.md @@ -751,7 +751,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/event-grid/topic/event-subscription/README.md b/modules/event-grid/topic/event-subscription/README.md index ddfd871622..5ca0bc97ca 100644 --- a/modules/event-grid/topic/event-subscription/README.md +++ b/modules/event-grid/topic/event-subscription/README.md @@ -45,21 +45,21 @@ This module deploys an Event Grid Topic Event Subscription. Dead Letter Destination. (See https://learn.microsoft.com/en-us/azure/templates/microsoft.eventgrid/eventsubscriptions?pivots=deployment-language-bicep#deadletterdestination-objects for more information). - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `deadLetterWithResourceIdentity` Dead Letter with Resource Identity Configuration. (See https://learn.microsoft.com/en-us/azure/templates/microsoft.eventgrid/eventsubscriptions?pivots=deployment-language-bicep#deadletterwithresourceidentity-objects for more information). - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `deliveryWithResourceIdentity` Delivery with Resource Identity Configuration. (See https://learn.microsoft.com/en-us/azure/templates/microsoft.eventgrid/eventsubscriptions?pivots=deployment-language-bicep#deliverywithresourceidentity-objects for more information). - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `destination` @@ -80,7 +80,15 @@ The event delivery schema for the event subscription. - Required: No - Type: string - Default: `'EventGridSchema'` -- Allowed: `[CloudEventSchemaV1_0, CustomInputSchema, EventGridEvent, EventGridSchema]` +- Allowed: + ```Bicep + [ + 'CloudEventSchemaV1_0' + 'CustomInputSchema' + 'EventGridEvent' + 'EventGridSchema' + ] + ``` ### Parameter: `expirationTimeUtc` @@ -94,7 +102,7 @@ The expiration time for the event subscription. Format is ISO-8601 (yyyy-MM-ddTH The filter for the event subscription. (See https://learn.microsoft.com/en-us/azure/templates/microsoft.eventgrid/eventsubscriptions?pivots=deployment-language-bicep#eventsubscriptionfilter for more information). - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `labels` @@ -121,7 +129,7 @@ The name of the Event Subscription. The retry policy for events. This can be used to configure the TTL and maximum number of delivery attempts and time to live for events. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `topicName` diff --git a/modules/event-hub/namespace/README.md b/modules/event-hub/namespace/README.md index ea77988f49..bb1a32227b 100644 --- a/modules/event-hub/namespace/README.md +++ b/modules/event-hub/namespace/README.md @@ -726,7 +726,19 @@ module namespace 'br:bicep/modules/event-hub.namespace:1.0.0' = { Authorization Rules for the Event Hub namespace. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'RootManageSharedAccessKey' + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + ] + ``` ### Parameter: `cMKKeyName` @@ -883,7 +895,7 @@ This property disables SAS authentication for the Event Hubs namespace. The disaster recovery config for this namespace. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -986,7 +998,14 @@ The minimum TLS version for the cluster to support. - Required: No - Type: string - Default: `'1.2'` -- Allowed: `[1.0, 1.1, 1.2]` +- Allowed: + ```Bicep + [ + '1.0' + '1.1' + '1.2' + ] + ``` ### Parameter: `name` @@ -999,7 +1018,7 @@ The name of the event hub namespace. Configure networking options. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `privateEndpoints` @@ -1175,7 +1194,15 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled, SecuredByPerimeter]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + 'SecuredByPerimeter' + ] + ``` ### Parameter: `requireInfrastructureEncryption` @@ -1265,7 +1292,14 @@ event hub plan SKU name. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Basic, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/event-hub/namespace/authorization-rule/README.md b/modules/event-hub/namespace/authorization-rule/README.md index bbc74cf9cc..dfb4d84591 100644 --- a/modules/event-hub/namespace/authorization-rule/README.md +++ b/modules/event-hub/namespace/authorization-rule/README.md @@ -61,7 +61,14 @@ The rights associated with the rule. - Required: No - Type: array - Default: `[]` -- Allowed: `[Listen, Manage, Send]` +- Allowed: + ```Bicep + [ + 'Listen' + 'Manage' + 'Send' + ] + ``` ## Outputs diff --git a/modules/event-hub/namespace/eventhub/README.md b/modules/event-hub/namespace/eventhub/README.md index 600b84c374..c07d8cf98d 100644 --- a/modules/event-hub/namespace/eventhub/README.md +++ b/modules/event-hub/namespace/eventhub/README.md @@ -63,7 +63,19 @@ This module deploys an Event Hub Namespace Event Hub. Authorization Rules for the event hub. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'RootManageSharedAccessKey' + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + ] + ``` ### Parameter: `captureDescriptionDestinationArchiveNameFormat` @@ -106,7 +118,13 @@ Enumerates the possible values for the encoding format of capture description. N - Required: No - Type: string - Default: `'Avro'` -- Allowed: `[Avro, AvroDeflate]` +- Allowed: + ```Bicep + [ + 'Avro' + 'AvroDeflate' + ] + ``` ### Parameter: `captureDescriptionIntervalInSeconds` @@ -134,7 +152,14 @@ A value that indicates whether to Skip Empty Archives. The consumer groups to create in this event hub instance. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: '$Default' + } + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -202,7 +227,13 @@ Retention cleanup policy. Enumerates the possible values for cleanup policy. - Required: No - Type: string - Default: `'Delete'` -- Allowed: `[Compact, Delete]` +- Allowed: + ```Bicep + [ + 'Compact' + 'Delete' + ] + ``` ### Parameter: `retentionDescriptionRetentionTimeInHours` @@ -292,7 +323,20 @@ Enumerates the possible values for the status of the Event Hub. - Required: No - Type: string - Default: `'Active'` -- Allowed: `[Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown]` +- Allowed: + ```Bicep + [ + 'Active' + 'Creating' + 'Deleting' + 'Disabled' + 'ReceiveDisabled' + 'Renaming' + 'Restoring' + 'SendDisabled' + 'Unknown' + ] + ``` ## Outputs diff --git a/modules/event-hub/namespace/eventhub/authorization-rule/README.md b/modules/event-hub/namespace/eventhub/authorization-rule/README.md index 5abe5dafa8..4880cabcbd 100644 --- a/modules/event-hub/namespace/eventhub/authorization-rule/README.md +++ b/modules/event-hub/namespace/eventhub/authorization-rule/README.md @@ -68,7 +68,14 @@ The rights associated with the rule. - Required: No - Type: array - Default: `[]` -- Allowed: `[Listen, Manage, Send]` +- Allowed: + ```Bicep + [ + 'Listen' + 'Manage' + 'Send' + ] + ``` ## Outputs diff --git a/modules/event-hub/namespace/network-rule-set/README.md b/modules/event-hub/namespace/network-rule-set/README.md index a0ac082d1c..ff9c6bb262 100644 --- a/modules/event-hub/namespace/network-rule-set/README.md +++ b/modules/event-hub/namespace/network-rule-set/README.md @@ -40,7 +40,13 @@ Default Action for Network Rule Set. Default is "Allow". It will not be set if p - Required: No - Type: string - Default: `'Allow'` -- Allowed: `[Allow, Deny]` +- Allowed: + ```Bicep + [ + 'Allow' + 'Deny' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -68,7 +74,13 @@ This determines if traffic is allowed over public network. Default is "Enabled". - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `trustedServiceAccessEnabled` diff --git a/modules/health-bot/health-bot/README.md b/modules/health-bot/health-bot/README.md index 363f535857..3ba7ed1140 100644 --- a/modules/health-bot/health-bot/README.md +++ b/modules/health-bot/health-bot/README.md @@ -342,7 +342,14 @@ Required. The name of the role to assign. If it cannot be found you can specify The name of the Azure Health Bot SKU. - Required: Yes - Type: string -- Allowed: `[C0, F0, S1]` +- Allowed: + ```Bicep + [ + 'C0' + 'F0' + 'S1' + ] + ``` ### Parameter: `tags` diff --git a/modules/healthcare-apis/workspace/README.md b/modules/healthcare-apis/workspace/README.md index 443ba44ef1..3c1d11f2db 100644 --- a/modules/healthcare-apis/workspace/README.md +++ b/modules/healthcare-apis/workspace/README.md @@ -470,7 +470,13 @@ Control permission for data plane traffic coming from public networks while priv - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/healthcare-apis/workspace/dicomservice/README.md b/modules/healthcare-apis/workspace/dicomservice/README.md index 82cdc71170..f8c690b4c1 100644 --- a/modules/healthcare-apis/workspace/dicomservice/README.md +++ b/modules/healthcare-apis/workspace/dicomservice/README.md @@ -75,7 +75,17 @@ Specify the allowed HTTP methods. - Required: No - Type: array - Default: `[]` -- Allowed: `[DELETE, GET, OPTIONS, PATCH, POST, PUT]` +- Allowed: + ```Bicep + [ + 'DELETE' + 'GET' + 'OPTIONS' + 'PATCH' + 'POST' + 'PUT' + ] + ``` ### Parameter: `corsOrigins` @@ -278,7 +288,13 @@ Control permission for data plane traffic coming from public networks while priv - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `tags` diff --git a/modules/healthcare-apis/workspace/dicomservice/main.json b/modules/healthcare-apis/workspace/dicomservice/main.json index f05ffafc1c..a0bbc93dad 100644 --- a/modules/healthcare-apis/workspace/dicomservice/main.json +++ b/modules/healthcare-apis/workspace/dicomservice/main.json @@ -6,7 +6,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "4165874741118763430" + "templateHash": "10991463946028183992" }, "name": "Healthcare API Workspace DICOM Services", "description": "This module deploys a Healthcare API Workspace DICOM Service.", @@ -397,4 +397,4 @@ "value": "[reference('dicom', '2022-06-01', 'full').location]" } } -} +} \ No newline at end of file diff --git a/modules/healthcare-apis/workspace/fhirservice/README.md b/modules/healthcare-apis/workspace/fhirservice/README.md index 1c8d86d105..703c240ab8 100644 --- a/modules/healthcare-apis/workspace/fhirservice/README.md +++ b/modules/healthcare-apis/workspace/fhirservice/README.md @@ -126,7 +126,17 @@ Specify the allowed HTTP methods. - Required: No - Type: array - Default: `[]` -- Allowed: `[DELETE, GET, OPTIONS, PATCH, POST, PUT]` +- Allowed: + ```Bicep + [ + 'DELETE' + 'GET' + 'OPTIONS' + 'PATCH' + 'POST' + 'PUT' + ] + ``` ### Parameter: `corsOrigins` @@ -291,7 +301,13 @@ The kind of the service. Defaults to R4. - Required: No - Type: string - Default: `'fhir-R4'` -- Allowed: `[fhir-R4, fhir-Stu3]` +- Allowed: + ```Bicep + [ + 'fhir-R4' + 'fhir-Stu3' + ] + ``` ### Parameter: `location` @@ -365,14 +381,20 @@ Control permission for data plane traffic coming from public networks while priv - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `resourceVersionOverrides` A list of FHIR Resources and their version policy overrides. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `resourceVersionPolicy` @@ -380,7 +402,14 @@ The default value for tracking history across all resources. - Required: No - Type: string - Default: `'versioned'` -- Allowed: `[no-version, versioned, versioned-update]` +- Allowed: + ```Bicep + [ + 'no-version' + 'versioned' + 'versioned-update' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/healthcare-apis/workspace/fhirservice/main.json b/modules/healthcare-apis/workspace/fhirservice/main.json index 3e1e52d236..b435adb5bb 100644 --- a/modules/healthcare-apis/workspace/fhirservice/main.json +++ b/modules/healthcare-apis/workspace/fhirservice/main.json @@ -6,7 +6,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "14914386228020873144" + "templateHash": "8893393036207321770" }, "name": "Healthcare API Workspace FHIR Services", "description": "This module deploys a Healthcare API Workspace FHIR Service.", @@ -647,4 +647,4 @@ "value": "[parameters('workspaceName')]" } } -} +} \ No newline at end of file diff --git a/modules/healthcare-apis/workspace/iotconnector/README.md b/modules/healthcare-apis/workspace/iotconnector/README.md index 2da0f7ced5..26ff9a5f3f 100644 --- a/modules/healthcare-apis/workspace/iotconnector/README.md +++ b/modules/healthcare-apis/workspace/iotconnector/README.md @@ -61,7 +61,13 @@ Consumer group of the event hub to connected to. The mapping JSON that determines how incoming device data is normalized. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + template: [] + templateType: 'CollectionContent' + } + ``` ### Parameter: `diagnosticSettings` @@ -202,7 +208,7 @@ Namespace of the Event Hub to connect to. FHIR Destination. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` diff --git a/modules/healthcare-apis/workspace/iotconnector/fhirdestination/README.md b/modules/healthcare-apis/workspace/iotconnector/fhirdestination/README.md index 16df71b996..3e561c8be8 100644 --- a/modules/healthcare-apis/workspace/iotconnector/fhirdestination/README.md +++ b/modules/healthcare-apis/workspace/iotconnector/fhirdestination/README.md @@ -46,7 +46,13 @@ This module deploys a Healthcare API Workspace IoT Connector FHIR Destination. The mapping JSON that determines how normalized data is converted to FHIR Observations. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + template: [] + templateType: 'CollectionFhir' + } + ``` ### Parameter: `enableDefaultTelemetry` @@ -86,7 +92,13 @@ Determines how resource identity is resolved on the destination. - Required: No - Type: string - Default: `'Lookup'` -- Allowed: `[Create, Lookup]` +- Allowed: + ```Bicep + [ + 'Create' + 'Lookup' + ] + ``` ### Parameter: `workspaceName` diff --git a/modules/healthcare-apis/workspace/iotconnector/main.json b/modules/healthcare-apis/workspace/iotconnector/main.json index 90607dde65..ef71ca1131 100644 --- a/modules/healthcare-apis/workspace/iotconnector/main.json +++ b/modules/healthcare-apis/workspace/iotconnector/main.json @@ -6,7 +6,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "9502385350114367681" + "templateHash": "16117637432944064764" }, "name": "Healthcare API Workspace IoT Connectors", "description": "This module deploys a Healthcare API Workspace IoT Connector.", @@ -566,4 +566,4 @@ "value": "[parameters('workspaceName')]" } } -} +} \ No newline at end of file diff --git a/modules/insights/activity-log-alert/README.md b/modules/insights/activity-log-alert/README.md index 361b57243f..7ea6985434 100644 --- a/modules/insights/activity-log-alert/README.md +++ b/modules/insights/activity-log-alert/README.md @@ -332,7 +332,12 @@ Required. The name of the role to assign. If it cannot be found you can specify The list of resource IDs that this Activity Log Alert is scoped to. - Required: No - Type: array -- Default: `[[subscription().id]]` +- Default: + ```Bicep + [ + '[subscription().id]' + ] + ``` ### Parameter: `tags` diff --git a/modules/insights/component/README.md b/modules/insights/component/README.md index 93f098019a..e0aa1d9ff6 100644 --- a/modules/insights/component/README.md +++ b/modules/insights/component/README.md @@ -223,7 +223,13 @@ Application type. - Required: No - Type: string - Default: `'web'` -- Allowed: `[other, web]` +- Allowed: + ```Bicep + [ + 'other' + 'web' + ] + ``` ### Parameter: `diagnosticSettings` @@ -373,7 +379,13 @@ The network access type for accessing Application Insights ingestion. - Enabled - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `publicNetworkAccessForQuery` @@ -381,7 +393,13 @@ The network access type for accessing Application Insights query. - Enabled or D - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `retentionInDays` @@ -389,7 +407,20 @@ Retention period in days. - Required: No - Type: int - Default: `365` -- Allowed: `[30, 60, 90, 120, 180, 270, 365, 550, 730]` +- Allowed: + ```Bicep + [ + 30 + 60 + 90 + 120 + 180 + 270 + 365 + 550 + 730 + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/insights/data-collection-endpoint/README.md b/modules/insights/data-collection-endpoint/README.md index 5f791e34bd..d7c991c56c 100644 --- a/modules/insights/data-collection-endpoint/README.md +++ b/modules/insights/data-collection-endpoint/README.md @@ -205,7 +205,13 @@ The kind of the resource. - Required: No - Type: string - Default: `'Linux'` -- Allowed: `[Linux, Windows]` +- Allowed: + ```Bicep + [ + 'Linux' + 'Windows' + ] + ``` ### Parameter: `location` @@ -253,7 +259,13 @@ The configuration to set whether network access from public internet to the endp - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/insights/data-collection-rule/README.md b/modules/insights/data-collection-rule/README.md index 261e51782d..37edcaf1f4 100644 --- a/modules/insights/data-collection-rule/README.md +++ b/modules/insights/data-collection-rule/README.md @@ -1549,7 +1549,13 @@ The kind of the resource. - Required: No - Type: string - Default: `'Linux'` -- Allowed: `[Linux, Windows]` +- Allowed: + ```Bicep + [ + 'Linux' + 'Windows' + ] + ``` ### Parameter: `location` @@ -1664,7 +1670,7 @@ Required. The name of the role to assign. If it cannot be found you can specify Declaration of custom streams used in this rule. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `tags` diff --git a/modules/insights/diagnostic-setting/README.md b/modules/insights/diagnostic-setting/README.md index fd196a7ed3..7ef93aebbb 100644 --- a/modules/insights/diagnostic-setting/README.md +++ b/modules/insights/diagnostic-setting/README.md @@ -149,7 +149,14 @@ A string indicating whether the export to Log Analytics should use the default d - Required: No - Type: string - Default: `''` -- Allowed: `['', AzureDiagnostics, Dedicated]` +- Allowed: + ```Bicep + [ + '' + 'AzureDiagnostics' + 'Dedicated' + ] + ``` ### Parameter: `logCategoriesAndGroups` diff --git a/modules/insights/metric-alert/README.md b/modules/insights/metric-alert/README.md index 2ff2485b0e..3ad1b77aac 100644 --- a/modules/insights/metric-alert/README.md +++ b/modules/insights/metric-alert/README.md @@ -199,7 +199,14 @@ Maps to the 'odata.type' field. Specifies the type of the alert criteria. - Required: No - Type: string - Default: `'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria'` -- Allowed: `[Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria, Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria, Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria]` +- Allowed: + ```Bicep + [ + 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' + 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' + 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' + ] + ``` ### Parameter: `alertDescription` @@ -241,7 +248,16 @@ how often the metric alert is evaluated represented in ISO 8601 duration format. - Required: No - Type: string - Default: `'PT5M'` -- Allowed: `[PT15M, PT1H, PT1M, PT30M, PT5M]` +- Allowed: + ```Bicep + [ + 'PT15M' + 'PT1H' + 'PT1M' + 'PT30M' + 'PT5M' + ] + ``` ### Parameter: `location` @@ -329,7 +345,12 @@ Required. The name of the role to assign. If it cannot be found you can specify the list of resource IDs that this metric alert is scoped to. - Required: No - Type: array -- Default: `[[subscription().id]]` +- Default: + ```Bicep + [ + '[subscription().id]' + ] + ``` ### Parameter: `severity` @@ -337,7 +358,16 @@ The severity of the alert. - Required: No - Type: int - Default: `3` -- Allowed: `[0, 1, 2, 3, 4]` +- Allowed: + ```Bicep + [ + 0 + 1 + 2 + 3 + 4 + ] + ``` ### Parameter: `tags` @@ -365,7 +395,19 @@ the period of time (in ISO 8601 duration format) that is used to monitor alert a - Required: No - Type: string - Default: `'PT15M'` -- Allowed: `[P1D, PT12H, PT15M, PT1H, PT1M, PT30M, PT5M, PT6H]` +- Allowed: + ```Bicep + [ + 'P1D' + 'PT12H' + 'PT15M' + 'PT1H' + 'PT1M' + 'PT30M' + 'PT5M' + 'PT6H' + ] + ``` ## Outputs diff --git a/modules/insights/scheduled-query-rule/README.md b/modules/insights/scheduled-query-rule/README.md index 7a4003acd4..f81174bdb5 100644 --- a/modules/insights/scheduled-query-rule/README.md +++ b/modules/insights/scheduled-query-rule/README.md @@ -277,7 +277,13 @@ Indicates the type of scheduled query rule. - Required: No - Type: string - Default: `'LogAlert'` -- Allowed: `[LogAlert, LogToMetric]` +- Allowed: + ```Bicep + [ + 'LogAlert' + 'LogToMetric' + ] + ``` ### Parameter: `location` @@ -379,7 +385,16 @@ Severity of the alert. Should be an integer between [0-4]. Value of 0 is severes - Required: No - Type: int - Default: `3` -- Allowed: `[0, 1, 2, 3, 4]` +- Allowed: + ```Bicep + [ + 0 + 1 + 2 + 3 + 4 + ] + ``` ### Parameter: `skipQueryValidation` diff --git a/modules/insights/webtest/README.md b/modules/insights/webtest/README.md index c0fb2f99fe..9c53d80ad2 100644 --- a/modules/insights/webtest/README.md +++ b/modules/insights/webtest/README.md @@ -235,7 +235,7 @@ module webtest 'br:bicep/modules/insights.webtest:1.0.0' = { An XML configuration specification for a WebTest. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `description` @@ -271,7 +271,14 @@ The kind of WebTest that this web test watches. - Required: No - Type: string - Default: `'standard'` -- Allowed: `[multistep, ping, standard]` +- Allowed: + ```Bicep + [ + 'multistep' + 'ping' + 'standard' + ] + ``` ### Parameter: `location` @@ -285,7 +292,26 @@ Location for all Resources. List of where to physically run the tests from to give global coverage for accessibility of your application. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + Id: 'us-il-ch1-azr' + } + { + Id: 'us-fl-mia-edge' + } + { + Id: 'latam-br-gru-edge' + } + { + Id: 'apac-sg-sin-azr' + } + { + Id: 'emea-nl-ams-azr' + } + ] + ``` ### Parameter: `lock` @@ -426,7 +452,7 @@ Seconds until this WebTest will timeout and fail. The collection of validation rule properties. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `webTestName` diff --git a/modules/key-vault/vault/README.md b/modules/key-vault/vault/README.md index 28af1e5341..5645f22dd2 100644 --- a/modules/key-vault/vault/README.md +++ b/modules/key-vault/vault/README.md @@ -1004,7 +1004,7 @@ Name of the Key Vault. Must be globally unique. Service endpoint object information. For security reasons, it is recommended to set the DefaultAction Deny. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `privateEndpoints` @@ -1180,7 +1180,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` @@ -1255,7 +1262,7 @@ Required. The name of the role to assign. If it cannot be found you can specify All secrets to create. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `softDeleteRetentionInDays` @@ -1276,7 +1283,13 @@ Specifies the SKU for the vault. - Required: No - Type: string - Default: `'premium'` -- Allowed: `[premium, standard]` +- Allowed: + ```Bicep + [ + 'premium' + 'standard' + ] + ``` ## Outputs diff --git a/modules/key-vault/vault/key/README.md b/modules/key-vault/vault/key/README.md index 561700f223..9a4617afd2 100644 --- a/modules/key-vault/vault/key/README.md +++ b/modules/key-vault/vault/key/README.md @@ -74,7 +74,15 @@ The elliptic curve name. - Required: No - Type: string - Default: `'P-256'` -- Allowed: `[P-256, P-256K, P-384, P-521]` +- Allowed: + ```Bicep + [ + 'P-256' + 'P-256K' + 'P-384' + 'P-521' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -89,7 +97,18 @@ Array of JsonWebKeyOperation. - Required: No - Type: array - Default: `[]` -- Allowed: `[decrypt, encrypt, import, sign, unwrapKey, verify, wrapKey]` +- Allowed: + ```Bicep + [ + 'decrypt' + 'encrypt' + 'import' + 'sign' + 'unwrapKey' + 'verify' + 'wrapKey' + ] + ``` ### Parameter: `keySize` @@ -110,7 +129,15 @@ The type of the key. - Required: No - Type: string - Default: `'EC'` -- Allowed: `[EC, EC-HSM, RSA, RSA-HSM]` +- Allowed: + ```Bicep + [ + 'EC' + 'EC-HSM' + 'RSA' + 'RSA-HSM' + ] + ``` ### Parameter: `name` @@ -191,7 +218,7 @@ Required. The name of the role to assign. If it cannot be found you can specify Key rotation policy properties object. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `tags` diff --git a/modules/kubernetes-configuration/extension/README.md b/modules/kubernetes-configuration/extension/README.md index b084bf2dd2..31bd67803a 100644 --- a/modules/kubernetes-configuration/extension/README.md +++ b/modules/kubernetes-configuration/extension/README.md @@ -244,14 +244,14 @@ The name of the AKS cluster that should be configured. Configuration settings that are sensitive, as name-value pairs for configuring this extension. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `configurationSettings` Configuration settings, as name-value pairs for configuring this extension. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` diff --git a/modules/kubernetes-configuration/flux-configuration/README.md b/modules/kubernetes-configuration/flux-configuration/README.md index 4920286fde..ac523aecce 100644 --- a/modules/kubernetes-configuration/flux-configuration/README.md +++ b/modules/kubernetes-configuration/flux-configuration/README.md @@ -242,7 +242,7 @@ module fluxConfiguration 'br:bicep/modules/kubernetes-configuration.flux-configu Parameters to reconcile to the GitRepository source kind type. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `clusterName` @@ -255,7 +255,7 @@ The name of the AKS cluster that should be configured. Key-value pairs of protected configuration settings for the configuration. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -269,14 +269,14 @@ Enable telemetry via a Globally Unique Identifier (GUID). Parameters to reconcile to the GitRepository source kind type. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `kustomizations` Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` @@ -302,14 +302,26 @@ The namespace to which this configuration is installed to. Maximum of 253 lower Scope at which the configuration will be installed. - Required: Yes - Type: string -- Allowed: `[cluster, namespace]` +- Allowed: + ```Bicep + [ + 'cluster' + 'namespace' + ] + ``` ### Parameter: `sourceKind` Source Kind to pull the configuration data from. - Required: Yes - Type: string -- Allowed: `[Bucket, GitRepository]` +- Allowed: + ```Bicep + [ + 'Bucket' + 'GitRepository' + ] + ``` ### Parameter: `suspend` diff --git a/modules/logic/workflow/README.md b/modules/logic/workflow/README.md index f1190e77fd..b60f3509e9 100644 --- a/modules/logic/workflow/README.md +++ b/modules/logic/workflow/README.md @@ -265,28 +265,28 @@ module workflow 'br:bicep/modules/logic.workflow:1.0.0' = { The access control configuration for workflow actions. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `connectorEndpointsConfiguration` The endpoints configuration: Access endpoint and outgoing IP addresses for the connector. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `contentsAccessControlConfiguration` The access control configuration for accessing workflow run contents. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `definitionParameters` Parameters for the definition template. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `diagnosticSettings` @@ -415,7 +415,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The integration account. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `integrationServiceEnvironmentResourceId` @@ -564,7 +564,17 @@ The state. - NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended]` +- Allowed: + ```Bicep + [ + 'Completed' + 'Deleted' + 'Disabled' + 'Enabled' + 'NotSpecified' + 'Suspended' + ] + ``` ### Parameter: `tags` @@ -577,56 +587,56 @@ Tags of the resource. The access control configuration for invoking workflow triggers. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workflowActions` The definitions for one or more actions to execute at workflow runtime. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workflowEndpointsConfiguration` The endpoints configuration: Access endpoint and outgoing IP addresses for the workflow. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workflowManagementAccessControlConfiguration` The access control configuration for workflow management. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workflowOutputs` The definitions for the outputs to return from a workflow run. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workflowParameters` The definitions for one or more parameters that pass the values to use at your logic app's runtime. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workflowStaticResults` The definitions for one or more static results returned by actions as mock outputs when static results are enabled on those actions. In each action definition, the runtimeConfiguration.staticResult.name attribute references the corresponding definition inside staticResults. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workflowTriggers` The definitions for one or more triggers that instantiate your workflow. You can define more than one trigger, but only with the Workflow Definition Language, not visually through the Logic Apps Designer. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/machine-learning-services/workspace/README.md b/modules/machine-learning-services/workspace/README.md index e5915c0e53..8bb70f240e 100644 --- a/modules/machine-learning-services/workspace/README.md +++ b/modules/machine-learning-services/workspace/README.md @@ -792,8 +792,14 @@ Optional. Specify the name of lock. ### Parameter: `managedIdentities` The managed identity definition for this resource. At least one identity type is required. -- Required: Yes +- Required: No - Type: object +- Default: + ```Bicep + { + systemAssigned: true + } + ``` | Name | Required | Type | Description | @@ -1002,7 +1008,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` @@ -1077,7 +1090,7 @@ Required. The name of the role to assign. If it cannot be found you can specify The service managed resource settings. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `sharedPrivateLinkResources` @@ -1091,7 +1104,15 @@ The list of shared private link resources in this workspace. Specifies the SKU, also referred as 'edition' of the Azure Machine Learning workspace. - Required: Yes - Type: string -- Allowed: `[Basic, Free, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Free' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/machine-learning-services/workspace/compute/README.md b/modules/machine-learning-services/workspace/compute/README.md index 6970b0eab7..a25e4d7226 100644 --- a/modules/machine-learning-services/workspace/compute/README.md +++ b/modules/machine-learning-services/workspace/compute/README.md @@ -60,7 +60,21 @@ Location for the underlying compute. Ignored when attaching a compute resource, Set the object type. - Required: Yes - Type: string -- Allowed: `[AKS, AmlCompute, ComputeInstance, Databricks, DataFactory, DataLakeAnalytics, HDInsight, Kubernetes, SynapseSpark, VirtualMachine]` +- Allowed: + ```Bicep + [ + 'AKS' + 'AmlCompute' + 'ComputeInstance' + 'Databricks' + 'DataFactory' + 'DataLakeAnalytics' + 'HDInsight' + 'Kubernetes' + 'SynapseSpark' + 'VirtualMachine' + ] + ``` ### Parameter: `deployCompute` @@ -140,7 +154,7 @@ Name of the compute. The properties of the compute. Will be ignored in case "resourceId" is set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `resourceId` @@ -155,7 +169,16 @@ Specifies the sku, also referred as "edition". Required for creating a compute r - Required: No - Type: string - Default: `''` -- Allowed: `['', Basic, Free, Premium, Standard]` +- Allowed: + ```Bicep + [ + '' + 'Basic' + 'Free' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/machine-learning-services/workspace/compute/main.json b/modules/machine-learning-services/workspace/compute/main.json index 6926b95f8a..185b53e091 100644 --- a/modules/machine-learning-services/workspace/compute/main.json +++ b/modules/machine-learning-services/workspace/compute/main.json @@ -6,7 +6,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "12092776287732059217" + "templateHash": "4219662265444129565" }, "name": "Machine Learning Services Workspaces Computes", "description": "This module deploys a Machine Learning Services Workspaces Compute.\r\n\r\nAttaching a compute is not idempotent and will fail in case you try to redeploy over an existing compute in AML (see parameter `deployCompute`).", @@ -231,4 +231,4 @@ "value": "[reference('machineLearningWorkspaceCompute', '2022-10-01', 'full').location]" } } -} +} \ No newline at end of file diff --git a/modules/maintenance/maintenance-configuration/README.md b/modules/maintenance/maintenance-configuration/README.md index 66a31f66ed..ddce26921e 100644 --- a/modules/maintenance/maintenance-configuration/README.md +++ b/modules/maintenance/maintenance-configuration/README.md @@ -266,14 +266,14 @@ Enable telemetry via a Globally Unique Identifier (GUID). Gets or sets extensionProperties of the maintenanceConfiguration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `installPatches` Configuration settings for VM guest patching with Azure Update Manager. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` @@ -315,14 +315,24 @@ Gets or sets maintenanceScope of the configuration. - Required: No - Type: string - Default: `'Host'` -- Allowed: `[Extension, Host, InGuestPatch, OSImage, SQLDB, SQLManagedInstance]` +- Allowed: + ```Bicep + [ + 'Extension' + 'Host' + 'InGuestPatch' + 'OSImage' + 'SQLDB' + 'SQLManagedInstance' + ] + ``` ### Parameter: `maintenanceWindow` Definition of a MaintenanceWindow. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` @@ -417,7 +427,14 @@ Gets or sets the visibility of the configuration. The default value is 'Custom'. - Required: No - Type: string - Default: `''` -- Allowed: `['', Custom, Public]` +- Allowed: + ```Bicep + [ + '' + 'Custom' + 'Public' + ] + ``` ## Outputs diff --git a/modules/net-app/net-app-account/capacity-pool/README.md b/modules/net-app/net-app-account/capacity-pool/README.md index bdeec9f849..376ed58ced 100644 --- a/modules/net-app/net-app-account/capacity-pool/README.md +++ b/modules/net-app/net-app-account/capacity-pool/README.md @@ -66,7 +66,13 @@ Encryption type of the capacity pool, set encryption type for data at rest for t - Required: No - Type: string - Default: `'Single'` -- Allowed: `[Double, Single]` +- Allowed: + ```Bicep + [ + 'Double' + 'Single' + ] + ``` ### Parameter: `location` @@ -93,7 +99,13 @@ The qos type of the pool. - Required: No - Type: string - Default: `'Auto'` -- Allowed: `[Auto, Manual]` +- Allowed: + ```Bicep + [ + 'Auto' + 'Manual' + ] + ``` ### Parameter: `roleAssignments` @@ -169,7 +181,15 @@ The pool service level. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Premium, Standard, StandardZRS, Ultra]` +- Allowed: + ```Bicep + [ + 'Premium' + 'Standard' + 'StandardZRS' + 'Ultra' + ] + ``` ### Parameter: `size` diff --git a/modules/net-app/net-app-account/capacity-pool/volume/README.md b/modules/net-app/net-app-account/capacity-pool/volume/README.md index 9e060fc9af..ebfb90556a 100644 --- a/modules/net-app/net-app-account/capacity-pool/volume/README.md +++ b/modules/net-app/net-app-account/capacity-pool/volume/README.md @@ -172,7 +172,15 @@ The pool service level. Must match the one of the parent capacity pool. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Premium, Standard, StandardZRS, Ultra]` +- Allowed: + ```Bicep + [ + 'Premium' + 'Standard' + 'StandardZRS' + 'Ultra' + ] + ``` ### Parameter: `subnetResourceId` diff --git a/modules/network/application-gateway-web-application-firewall-policy/README.md b/modules/network/application-gateway-web-application-firewall-policy/README.md index 368139a3d1..5aedf8a85a 100644 --- a/modules/network/application-gateway-web-application-firewall-policy/README.md +++ b/modules/network/application-gateway-web-application-firewall-policy/README.md @@ -174,7 +174,7 @@ Location for all resources. Describes the managedRules structure. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` @@ -187,7 +187,7 @@ Name of the Application Gateway WAF policy. The PolicySettings for policy. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `tags` diff --git a/modules/network/application-gateway/README.md b/modules/network/application-gateway/README.md index 920ca3d003..f429cc90cb 100644 --- a/modules/network/application-gateway/README.md +++ b/modules/network/application-gateway/README.md @@ -1621,7 +1621,18 @@ The name of the SKU for the Application Gateway. - Required: No - Type: string - Default: `'WAF_Medium'` -- Allowed: `[Standard_Large, Standard_Medium, Standard_Small, Standard_v2, WAF_Large, WAF_Medium, WAF_v2]` +- Allowed: + ```Bicep + [ + 'Standard_Large' + 'Standard_Medium' + 'Standard_Small' + 'Standard_v2' + 'WAF_Large' + 'WAF_Medium' + 'WAF_v2' + ] + ``` ### Parameter: `sslCertificates` @@ -1635,8 +1646,46 @@ SSL certificates of the application gateway resource. Ssl cipher suites to be enabled in the specified order to application gateway. - Required: No - Type: array -- Default: `[TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384]` -- Allowed: `[TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_GCM_SHA384]` +- Default: + ```Bicep + [ + 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' + 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' + ] + ``` +- Allowed: + ```Bicep + [ + 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' + 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' + 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' + 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' + 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' + 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' + 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' + 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' + 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' + 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' + 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' + 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' + 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' + 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' + 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' + 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' + 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' + 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' + 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' + 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' + 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' + 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' + 'TLS_RSA_WITH_AES_128_CBC_SHA' + 'TLS_RSA_WITH_AES_128_CBC_SHA256' + 'TLS_RSA_WITH_AES_128_GCM_SHA256' + 'TLS_RSA_WITH_AES_256_CBC_SHA' + 'TLS_RSA_WITH_AES_256_CBC_SHA256' + 'TLS_RSA_WITH_AES_256_GCM_SHA384' + ] + ``` ### Parameter: `sslPolicyMinProtocolVersion` @@ -1644,7 +1693,15 @@ Ssl protocol enums. - Required: No - Type: string - Default: `'TLSv1_2'` -- Allowed: `[TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3]` +- Allowed: + ```Bicep + [ + 'TLSv1_0' + 'TLSv1_1' + 'TLSv1_2' + 'TLSv1_3' + ] + ``` ### Parameter: `sslPolicyName` @@ -1652,7 +1709,17 @@ Ssl predefined policy name enums. - Required: No - Type: string - Default: `''` -- Allowed: `['', AppGwSslPolicy20150501, AppGwSslPolicy20170401, AppGwSslPolicy20170401S, AppGwSslPolicy20220101, AppGwSslPolicy20220101S]` +- Allowed: + ```Bicep + [ + '' + 'AppGwSslPolicy20150501' + 'AppGwSslPolicy20170401' + 'AppGwSslPolicy20170401S' + 'AppGwSslPolicy20220101' + 'AppGwSslPolicy20220101S' + ] + ``` ### Parameter: `sslPolicyType` @@ -1660,7 +1727,14 @@ Type of Ssl Policy. - Required: No - Type: string - Default: `'Custom'` -- Allowed: `[Custom, CustomV2, Predefined]` +- Allowed: + ```Bicep + [ + 'Custom' + 'CustomV2' + 'Predefined' + ] + ``` ### Parameter: `sslProfiles` @@ -1701,7 +1775,7 @@ URL path map of the application gateway resource. Application gateway web application firewall configuration. Should be configured for security reasons. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `zones` diff --git a/modules/network/azure-firewall/README.md b/modules/network/azure-firewall/README.md index cda3fedb91..c58b8068b9 100644 --- a/modules/network/azure-firewall/README.md +++ b/modules/network/azure-firewall/README.md @@ -807,7 +807,14 @@ Tier of an Azure Firewall. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Basic, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `diagnosticSettings` @@ -943,7 +950,7 @@ Resource ID of the Firewall Policy that should be attached. IP addresses associated with AzureFirewall. Required if `virtualHubId` is supplied. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` @@ -984,7 +991,7 @@ Optional. Specify the name of lock. Specifies the properties of the Management Public IP to create and be used by Azure Firewall. If it's not provided and managementIPResourceID is empty, a '-mip' suffix will be appended to the Firewall's name. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `managementIPResourceID` @@ -1018,7 +1025,12 @@ Collection of network rule collections used by Azure Firewall. Specifies the properties of the Public IP to create and be used by the Firewall, if no existing public IP was provided. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + name: '[format(\'{0}-pip\' parameters(\'name\'))]' + } + ``` ### Parameter: `publicIPResourceID` @@ -1107,7 +1119,14 @@ The operation mode for Threat Intel. - Required: No - Type: string - Default: `'Deny'` -- Allowed: `[Alert, Deny, Off]` +- Allowed: + ```Bicep + [ + 'Alert' + 'Deny' + 'Off' + ] + ``` ### Parameter: `virtualHubId` @@ -1128,7 +1147,14 @@ Shared services Virtual Network resource ID. The virtual network ID containing A Zone numbers e.g. 1,2,3. - Required: No - Type: array -- Default: `[1, 2, 3]` +- Default: + ```Bicep + [ + '1' + '2' + '3' + ] + ``` ## Outputs diff --git a/modules/network/bastion-host/README.md b/modules/network/bastion-host/README.md index e0c9205ba4..625f27b070 100644 --- a/modules/network/bastion-host/README.md +++ b/modules/network/bastion-host/README.md @@ -570,7 +570,12 @@ Name of the Azure Bastion resource. Specifies the properties of the Public IP to create and be used by Azure Bastion, if no existing public IP was provided. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + name: '[format(\'{0}-pip\' parameters(\'name\'))]' + } + ``` ### Parameter: `roleAssignments` @@ -653,7 +658,13 @@ The SKU of this Bastion Host. - Required: No - Type: string - Default: `'Basic'` -- Allowed: `[Basic, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/network/connection/README.md b/modules/network/connection/README.md index cc392ea1ae..d8f8169acb 100644 --- a/modules/network/connection/README.md +++ b/modules/network/connection/README.md @@ -171,7 +171,14 @@ The connection connectionMode for this connection. Available for IPSec connectio - Required: No - Type: string - Default: `'Default'` -- Allowed: `[Default, InitiatorOnly, ResponderOnly]` +- Allowed: + ```Bicep + [ + 'Default' + 'InitiatorOnly' + 'ResponderOnly' + ] + ``` ### Parameter: `connectionProtocol` @@ -179,7 +186,13 @@ Connection connectionProtocol used for this connection. Available for IPSec conn - Required: No - Type: string - Default: `'IKEv2'` -- Allowed: `[IKEv1, IKEv2]` +- Allowed: + ```Bicep + [ + 'IKEv1' + 'IKEv2' + ] + ``` ### Parameter: `connectionType` @@ -187,14 +200,34 @@ Gateway connection connectionType. - Required: No - Type: string - Default: `'IPsec'` -- Allowed: `[ExpressRoute, IPsec, Vnet2Vnet, VPNClient]` +- Allowed: + ```Bicep + [ + 'ExpressRoute' + 'IPsec' + 'Vnet2Vnet' + 'VPNClient' + ] + ``` ### Parameter: `customIPSecPolicy` The IPSec Policies to be considered by this connection. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + dhGroup: '' + ikeEncryption: '' + ikeIntegrity: '' + ipsecEncryption: '' + ipsecIntegrity: '' + pfsGroup: '' + saDataSizeKilobytes: 0 + saLifeTimeSeconds: 0 + } + ``` ### Parameter: `dpdTimeoutSeconds` @@ -236,7 +269,7 @@ Bypass ExpressRoute Gateway for data forwarding. Only available when connection The local network gateway. Used for connection type [IPsec]. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` @@ -283,7 +316,7 @@ Remote connection name. The remote peer. Used for connection connectionType [ExpressRoute]. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `routingWeight` @@ -323,7 +356,7 @@ The primary Virtual Network Gateway. The remote Virtual Network Gateway. Used for connection connectionType [Vnet2Vnet]. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `vpnSharedKey` diff --git a/modules/network/dns-forwarding-ruleset/forwarding-rule/README.md b/modules/network/dns-forwarding-ruleset/forwarding-rule/README.md index 7f9b46b23d..39dd2043dd 100644 --- a/modules/network/dns-forwarding-ruleset/forwarding-rule/README.md +++ b/modules/network/dns-forwarding-ruleset/forwarding-rule/README.md @@ -65,7 +65,13 @@ The state of forwarding rule. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `location` @@ -79,7 +85,7 @@ Location for all resources. Metadata attached to the forwarding rule. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/dns-zone/a/README.md b/modules/network/dns-zone/a/README.md index 8f6ad2bc21..222006ccc6 100644 --- a/modules/network/dns-zone/a/README.md +++ b/modules/network/dns-zone/a/README.md @@ -66,7 +66,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/dns-zone/aaaa/README.md b/modules/network/dns-zone/aaaa/README.md index 75adf53933..fb0bcad96e 100644 --- a/modules/network/dns-zone/aaaa/README.md +++ b/modules/network/dns-zone/aaaa/README.md @@ -66,7 +66,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/dns-zone/caa/README.md b/modules/network/dns-zone/caa/README.md index 29980a362d..bd705d06a7 100644 --- a/modules/network/dns-zone/caa/README.md +++ b/modules/network/dns-zone/caa/README.md @@ -65,7 +65,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/dns-zone/cname/README.md b/modules/network/dns-zone/cname/README.md index 2f06be8f3a..063728513a 100644 --- a/modules/network/dns-zone/cname/README.md +++ b/modules/network/dns-zone/cname/README.md @@ -46,7 +46,7 @@ This module deploys a Public DNS Zone CNAME record. A CNAME record. Cannot be used in conjuction with the "targetResource" property. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `dnsZoneName` @@ -66,7 +66,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/dns-zone/mx/README.md b/modules/network/dns-zone/mx/README.md index a2f9f80afd..7aaa4e37fe 100644 --- a/modules/network/dns-zone/mx/README.md +++ b/modules/network/dns-zone/mx/README.md @@ -58,7 +58,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `mxRecords` diff --git a/modules/network/dns-zone/ns/README.md b/modules/network/dns-zone/ns/README.md index 8a48a9ed9e..4330bd1fd0 100644 --- a/modules/network/dns-zone/ns/README.md +++ b/modules/network/dns-zone/ns/README.md @@ -58,7 +58,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/dns-zone/ptr/README.md b/modules/network/dns-zone/ptr/README.md index fb72f7e423..6609c1ff35 100644 --- a/modules/network/dns-zone/ptr/README.md +++ b/modules/network/dns-zone/ptr/README.md @@ -58,7 +58,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/dns-zone/soa/README.md b/modules/network/dns-zone/soa/README.md index a9c838ea26..155270e1da 100644 --- a/modules/network/dns-zone/soa/README.md +++ b/modules/network/dns-zone/soa/README.md @@ -58,7 +58,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` @@ -139,7 +139,7 @@ Required. The name of the role to assign. If it cannot be found you can specify A SOA record. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `ttl` diff --git a/modules/network/dns-zone/srv/README.md b/modules/network/dns-zone/srv/README.md index 32dd9091a8..0143e63e5d 100644 --- a/modules/network/dns-zone/srv/README.md +++ b/modules/network/dns-zone/srv/README.md @@ -58,7 +58,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/dns-zone/txt/README.md b/modules/network/dns-zone/txt/README.md index bfc46bccd2..35897fbd07 100644 --- a/modules/network/dns-zone/txt/README.md +++ b/modules/network/dns-zone/txt/README.md @@ -58,7 +58,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/express-route-circuit/README.md b/modules/network/express-route-circuit/README.md index 4bd12d9edc..3372a9e824 100644 --- a/modules/network/express-route-circuit/README.md +++ b/modules/network/express-route-circuit/README.md @@ -488,7 +488,13 @@ BGP peering type for the Circuit. Choose from AzurePrivatePeering, AzurePublicPe - Required: No - Type: string - Default: `'AzurePrivatePeering'` -- Allowed: `[AzurePrivatePeering, MicrosoftPeering]` +- Allowed: + ```Bicep + [ + 'AzurePrivatePeering' + 'MicrosoftPeering' + ] + ``` ### Parameter: `primaryPeerAddressPrefix` @@ -591,7 +597,13 @@ Chosen SKU family of ExpressRoute circuit. Choose from MeteredData or UnlimitedD - Required: No - Type: string - Default: `'MeteredData'` -- Allowed: `[MeteredData, UnlimitedData]` +- Allowed: + ```Bicep + [ + 'MeteredData' + 'UnlimitedData' + ] + ``` ### Parameter: `skuTier` @@ -599,7 +611,14 @@ Chosen SKU Tier of ExpressRoute circuit. Choose from Local, Premium or Standard - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Local, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Local' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/network/firewall-policy/README.md b/modules/network/firewall-policy/README.md index fdc06817f0..8c99b839b8 100644 --- a/modules/network/firewall-policy/README.md +++ b/modules/network/firewall-policy/README.md @@ -273,7 +273,13 @@ The operation mode for automatically learning private ranges to not be SNAT. - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `basePolicyResourceId` @@ -376,7 +382,14 @@ The configuring of intrusion detection. - Required: No - Type: string - Default: `'Off'` -- Allowed: `[Alert, Deny, Off]` +- Allowed: + ```Bicep + [ + 'Alert' + 'Deny' + 'Off' + ] + ``` ### Parameter: `name` @@ -431,7 +444,14 @@ The operation mode for Threat Intel. - Required: No - Type: string - Default: `'Off'` -- Allowed: `[Alert, Deny, Off]` +- Allowed: + ```Bicep + [ + 'Alert' + 'Deny' + 'Off' + ] + ``` ### Parameter: `tier` @@ -439,7 +459,13 @@ Tier of Firewall Policy. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Premium' + 'Standard' + ] + ``` ### Parameter: `workspaces` diff --git a/modules/network/front-door-web-application-firewall-policy/README.md b/modules/network/front-door-web-application-firewall-policy/README.md index 81f51e5a93..09ab8eda51 100644 --- a/modules/network/front-door-web-application-firewall-policy/README.md +++ b/modules/network/front-door-web-application-firewall-policy/README.md @@ -325,7 +325,30 @@ module frontDoorWebApplicationFirewallPolicy 'br:bicep/modules/network.front-doo The custom rules inside the policy. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + rules: [ + { + action: 'Block' + enabledState: 'Enabled' + matchConditions: [ + { + matchValue: [ + 'ZZ' + ] + matchVariable: 'RemoteAddr' + negateCondition: true + operator: 'GeoMatch' + } + ] + name: 'ApplyGeoFilter' + priority: 100 + ruleType: 'MatchRule' + } + ] + } + ``` ### Parameter: `enableDefaultTelemetry` @@ -373,7 +396,26 @@ Optional. Specify the name of lock. Describes the managedRules structure. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + managedRuleSets: [ + { + exclusions: [] + ruleGroupOverrides: [] + ruleSetAction: 'Block' + ruleSetType: 'Microsoft_DefaultRuleSet' + ruleSetVersion: '2.1' + } + { + exclusions: [] + ruleGroupOverrides: [] + ruleSetType: 'Microsoft_BotManagerRuleSet' + ruleSetVersion: '1.0' + } + ] + } + ``` ### Parameter: `name` @@ -386,7 +428,13 @@ Name of the Front Door WAF policy. The PolicySettings for policy. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + enabledState: 'Enabled' + mode: 'Prevention' + } + ``` ### Parameter: `roleAssignments` @@ -462,7 +510,13 @@ The pricing tier of the WAF profile. - Required: No - Type: string - Default: `'Standard_AzureFrontDoor'` -- Allowed: `[Premium_AzureFrontDoor, Standard_AzureFrontDoor]` +- Allowed: + ```Bicep + [ + 'Premium_AzureFrontDoor' + 'Standard_AzureFrontDoor' + ] + ``` ### Parameter: `tags` diff --git a/modules/network/load-balancer/README.md b/modules/network/load-balancer/README.md index f372102f21..f6c2ff8e44 100644 --- a/modules/network/load-balancer/README.md +++ b/modules/network/load-balancer/README.md @@ -885,7 +885,13 @@ Name of a load balancer SKU. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Basic, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/network/load-balancer/backend-address-pool/README.md b/modules/network/load-balancer/backend-address-pool/README.md index 99b752c0a9..98c95d3b23 100644 --- a/modules/network/load-balancer/backend-address-pool/README.md +++ b/modules/network/load-balancer/backend-address-pool/README.md @@ -78,7 +78,14 @@ Backend address synchronous mode for the backend pool. - Required: No - Type: string - Default: `''` -- Allowed: `['', Automatic, Manual]` +- Allowed: + ```Bicep + [ + '' + 'Automatic' + 'Manual' + ] + ``` ### Parameter: `tunnelInterfaces` diff --git a/modules/network/load-balancer/inbound-nat-rule/README.md b/modules/network/load-balancer/inbound-nat-rule/README.md index 012c32a79f..5cd6e7873d 100644 --- a/modules/network/load-balancer/inbound-nat-rule/README.md +++ b/modules/network/load-balancer/inbound-nat-rule/README.md @@ -131,7 +131,14 @@ The transport protocol for the endpoint. - Required: No - Type: string - Default: `'Tcp'` -- Allowed: `[All, Tcp, Udp]` +- Allowed: + ```Bicep + [ + 'All' + 'Tcp' + 'Udp' + ] + ``` ## Outputs diff --git a/modules/network/network-interface/README.md b/modules/network/network-interface/README.md index 469e4b7aee..2827d18f97 100644 --- a/modules/network/network-interface/README.md +++ b/modules/network/network-interface/README.md @@ -294,7 +294,14 @@ Auxiliary mode of Network Interface resource. Not all regions are enabled for Au - Required: No - Type: string - Default: `'None'` -- Allowed: `[Floating, MaxConnections, None]` +- Allowed: + ```Bicep + [ + 'Floating' + 'MaxConnections' + 'None' + ] + ``` ### Parameter: `auxiliarySku` @@ -302,7 +309,16 @@ Auxiliary sku of Network Interface resource. Not all regions are enabled for Aux - Required: No - Type: string - Default: `'None'` -- Allowed: `[A1, A2, A4, A8, None]` +- Allowed: + ```Bicep + [ + 'A1' + 'A2' + 'A4' + 'A8' + 'None' + ] + ``` ### Parameter: `diagnosticSettings` diff --git a/modules/network/network-manager/connectivity-configuration/README.md b/modules/network/network-manager/connectivity-configuration/README.md index cf5ff24e23..82d0de0287 100644 --- a/modules/network/network-manager/connectivity-configuration/README.md +++ b/modules/network/network-manager/connectivity-configuration/README.md @@ -54,7 +54,13 @@ Network Groups for the configuration. Connectivity topology type. - Required: Yes - Type: string -- Allowed: `[HubAndSpoke, Mesh]` +- Allowed: + ```Bicep + [ + 'HubAndSpoke' + 'Mesh' + ] + ``` ### Parameter: `deleteExistingPeering` @@ -62,7 +68,13 @@ Flag if need to remove current existing peerings. If set to "True", all peerings - Required: No - Type: string - Default: `'False'` -- Allowed: `[False, True]` +- Allowed: + ```Bicep + [ + 'False' + 'True' + ] + ``` ### Parameter: `description` @@ -91,7 +103,13 @@ Flag if global mesh is supported. By default, mesh connectivity is applied to vi - Required: No - Type: string - Default: `'False'` -- Allowed: `[False, True]` +- Allowed: + ```Bicep + [ + 'False' + 'True' + ] + ``` ### Parameter: `name` diff --git a/modules/network/network-manager/security-admin-configuration/README.md b/modules/network/network-manager/security-admin-configuration/README.md index c6cb473a8a..e49e0a6867 100644 --- a/modules/network/network-manager/security-admin-configuration/README.md +++ b/modules/network/network-manager/security-admin-configuration/README.md @@ -46,8 +46,20 @@ A security admin configuration contains a set of rule collections. Each rule col Enum list of network intent policy based services. - Required: No - Type: array -- Default: `[None]` -- Allowed: `[All, AllowRulesOnly, None]` +- Default: + ```Bicep + [ + 'None' + ] + ``` +- Allowed: + ```Bicep + [ + 'All' + 'AllowRulesOnly' + 'None' + ] + ``` ### Parameter: `description` diff --git a/modules/network/network-manager/security-admin-configuration/rule-collection/rule/README.md b/modules/network/network-manager/security-admin-configuration/rule-collection/rule/README.md index 6f0eb7a62f..dfb454ced3 100644 --- a/modules/network/network-manager/security-admin-configuration/rule-collection/rule/README.md +++ b/modules/network/network-manager/security-admin-configuration/rule-collection/rule/README.md @@ -52,7 +52,14 @@ A security admin configuration contains a set of rule collections. Each rule col Indicates the access allowed for this particular rule. "Allow" means traffic matching this rule will be allowed. "Deny" means traffic matching this rule will be blocked. "AlwaysAllow" means that traffic matching this rule will be allowed regardless of other rules with lower priority or user-defined NSGs. - Required: Yes - Type: string -- Allowed: `[Allow, AlwaysAllow, Deny]` +- Allowed: + ```Bicep + [ + 'Allow' + 'AlwaysAllow' + 'Deny' + ] + ``` ### Parameter: `description` @@ -80,7 +87,13 @@ The destnations filter can be an IP Address or a service tag. Each filter contai Indicates if the traffic matched against the rule in inbound or outbound. - Required: Yes - Type: string -- Allowed: `[Inbound, Outbound]` +- Allowed: + ```Bicep + [ + 'Inbound' + 'Outbound' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -112,7 +125,17 @@ The priority of the rule. The value can be between 1 and 4096. The priority numb Network protocol this rule applies to. - Required: Yes - Type: string -- Allowed: `[Ah, Any, Esp, Icmp, Tcp, Udp]` +- Allowed: + ```Bicep + [ + 'Ah' + 'Any' + 'Esp' + 'Icmp' + 'Tcp' + 'Udp' + ] + ``` ### Parameter: `ruleCollectionName` diff --git a/modules/network/network-security-group/security-rule/README.md b/modules/network/network-security-group/security-rule/README.md index bac421ca53..98658edd16 100644 --- a/modules/network/network-security-group/security-rule/README.md +++ b/modules/network/network-security-group/security-rule/README.md @@ -56,7 +56,13 @@ Whether network traffic is allowed or denied. - Required: No - Type: string - Default: `'Deny'` -- Allowed: `[Allow, Deny]` +- Allowed: + ```Bicep + [ + 'Allow' + 'Deny' + ] + ``` ### Parameter: `description` @@ -105,7 +111,13 @@ The destination port ranges. The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. - Required: Yes - Type: string -- Allowed: `[Inbound, Outbound]` +- Allowed: + ```Bicep + [ + 'Inbound' + 'Outbound' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -137,7 +149,17 @@ The priority of the rule. The value can be between 100 and 4096. The priority nu Network protocol this rule applies to. - Required: Yes - Type: string -- Allowed: `[*, Ah, Esp, Icmp, Tcp, Udp]` +- Allowed: + ```Bicep + [ + '*' + 'Ah' + 'Esp' + 'Icmp' + 'Tcp' + 'Udp' + ] + ``` ### Parameter: `sourceAddressPrefix` diff --git a/modules/network/network-watcher/flow-log/README.md b/modules/network/network-watcher/flow-log/README.md index f9b2dddaf0..512cbc68db 100644 --- a/modules/network/network-watcher/flow-log/README.md +++ b/modules/network/network-watcher/flow-log/README.md @@ -60,7 +60,13 @@ The flow log format version. - Required: No - Type: int - Default: `2` -- Allowed: `[1, 2]` +- Allowed: + ```Bicep + [ + 1 + 2 + ] + ``` ### Parameter: `location` @@ -114,7 +120,13 @@ The interval in minutes which would decide how frequently TA service should do f - Required: No - Type: int - Default: `60` -- Allowed: `[10, 60]` +- Allowed: + ```Bicep + [ + 10 + 60 + ] + ``` ### Parameter: `workspaceResourceId` diff --git a/modules/network/private-dns-zone/a/README.md b/modules/network/private-dns-zone/a/README.md index e7413b50ac..9c8802653e 100644 --- a/modules/network/private-dns-zone/a/README.md +++ b/modules/network/private-dns-zone/a/README.md @@ -59,7 +59,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/private-dns-zone/aaaa/README.md b/modules/network/private-dns-zone/aaaa/README.md index fecf313e79..d825a7c1c4 100644 --- a/modules/network/private-dns-zone/aaaa/README.md +++ b/modules/network/private-dns-zone/aaaa/README.md @@ -59,7 +59,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/private-dns-zone/cname/README.md b/modules/network/private-dns-zone/cname/README.md index a22ac7e936..0a2e3b151b 100644 --- a/modules/network/private-dns-zone/cname/README.md +++ b/modules/network/private-dns-zone/cname/README.md @@ -45,7 +45,7 @@ This module deploys a Private DNS Zone CNAME record. A CNAME record. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -59,7 +59,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/private-dns-zone/mx/README.md b/modules/network/private-dns-zone/mx/README.md index 86277ddc26..f8ec7f7dfa 100644 --- a/modules/network/private-dns-zone/mx/README.md +++ b/modules/network/private-dns-zone/mx/README.md @@ -52,7 +52,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `mxRecords` diff --git a/modules/network/private-dns-zone/ptr/README.md b/modules/network/private-dns-zone/ptr/README.md index 0aac5aedb4..58f270d3c3 100644 --- a/modules/network/private-dns-zone/ptr/README.md +++ b/modules/network/private-dns-zone/ptr/README.md @@ -52,7 +52,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/private-dns-zone/soa/README.md b/modules/network/private-dns-zone/soa/README.md index 253483e9db..827a5007c3 100644 --- a/modules/network/private-dns-zone/soa/README.md +++ b/modules/network/private-dns-zone/soa/README.md @@ -52,7 +52,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` @@ -139,7 +139,7 @@ Required. The name of the role to assign. If it cannot be found you can specify A SOA record. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `ttl` diff --git a/modules/network/private-dns-zone/srv/README.md b/modules/network/private-dns-zone/srv/README.md index d216712172..650c311142 100644 --- a/modules/network/private-dns-zone/srv/README.md +++ b/modules/network/private-dns-zone/srv/README.md @@ -52,7 +52,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/private-dns-zone/txt/README.md b/modules/network/private-dns-zone/txt/README.md index 78aaaf1497..600c4871f0 100644 --- a/modules/network/private-dns-zone/txt/README.md +++ b/modules/network/private-dns-zone/txt/README.md @@ -52,7 +52,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The metadata attached to the record set. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/network/private-link-service/README.md b/modules/network/private-link-service/README.md index a9dbe52c17..0255a52263 100644 --- a/modules/network/private-link-service/README.md +++ b/modules/network/private-link-service/README.md @@ -305,7 +305,7 @@ module privateLinkService 'br:bicep/modules/network.private-link-service:1.0.0' The auto-approval list of the private link service. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -326,7 +326,7 @@ Lets the service provider use tcp proxy v2 to retrieve connection information ab The extended location of the load balancer. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `fqdns` @@ -468,7 +468,7 @@ Tags to be applied on all resources/resource groups in this deployment. Controls the exposure settings for your Private Link service. Service providers can choose to limit the exposure to their service to subscriptions with Azure role-based access control (Azure RBAC) permissions, a restricted set of subscriptions, or all Azure subscriptions. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/network/public-ip-address/README.md b/modules/network/public-ip-address/README.md index 4f3ad77e59..8d6d6c6221 100644 --- a/modules/network/public-ip-address/README.md +++ b/modules/network/public-ip-address/README.md @@ -374,7 +374,16 @@ The domain name label scope. If a domain name label and a domain name label scop - Required: No - Type: string - Default: `''` -- Allowed: `['', NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse]` +- Allowed: + ```Bicep + [ + '' + 'NoReuse' + 'ResourceGroupReuse' + 'SubscriptionReuse' + 'TenantReuse' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -436,7 +445,13 @@ IP address version. - Required: No - Type: string - Default: `'IPv4'` -- Allowed: `[IPv4, IPv6]` +- Allowed: + ```Bicep + [ + 'IPv4' + 'IPv6' + ] + ``` ### Parameter: `publicIPAllocationMethod` @@ -444,7 +459,13 @@ The public IP address allocation method. - Required: No - Type: string - Default: `'Static'` -- Allowed: `[Dynamic, Static]` +- Allowed: + ```Bicep + [ + 'Dynamic' + 'Static' + ] + ``` ### Parameter: `publicIPPrefixResourceId` @@ -534,7 +555,13 @@ Name of a public IP address SKU. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Basic, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Standard' + ] + ``` ### Parameter: `skuTier` @@ -542,7 +569,13 @@ Tier of a public IP address SKU. - Required: No - Type: string - Default: `'Regional'` -- Allowed: `[Global, Regional]` +- Allowed: + ```Bicep + [ + 'Global' + 'Regional' + ] + ``` ### Parameter: `tags` diff --git a/modules/network/public-ip-prefix/README.md b/modules/network/public-ip-prefix/README.md index b4f5ab4c19..b9575104a9 100644 --- a/modules/network/public-ip-prefix/README.md +++ b/modules/network/public-ip-prefix/README.md @@ -197,7 +197,7 @@ module publicIpPrefix 'br:bicep/modules/network.public-ip-prefix:1.0.0' = { The customIpPrefix that this prefix is associated with. A custom IP address prefix is a contiguous range of IP addresses owned by an external customer and provisioned into a subscription. When a custom IP prefix is in Provisioned, Commissioning, or Commissioned state, a linked public IP prefix can be created. Either as a subset of the custom IP prefix range or the entire range. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` diff --git a/modules/network/trafficmanagerprofile/README.md b/modules/network/trafficmanagerprofile/README.md index 90a4577d8b..e1247c8513 100644 --- a/modules/network/trafficmanagerprofile/README.md +++ b/modules/network/trafficmanagerprofile/README.md @@ -398,7 +398,14 @@ Maximum number of endpoints to be returned for MultiValue routing type. The endpoint monitoring settings of the Traffic Manager profile. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + path: '/' + port: '80' + protocol: 'http' + } + ``` ### Parameter: `name` @@ -412,7 +419,13 @@ The status of the Traffic Manager profile. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `relativeName` @@ -500,7 +513,17 @@ The traffic routing method of the Traffic Manager profile. - Required: No - Type: string - Default: `'Performance'` -- Allowed: `[Geographic, MultiValue, Performance, Priority, Subnet, Weighted]` +- Allowed: + ```Bicep + [ + 'Geographic' + 'MultiValue' + 'Performance' + 'Priority' + 'Subnet' + 'Weighted' + ] + ``` ### Parameter: `trafficViewEnrollmentStatus` @@ -508,7 +531,13 @@ Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manage - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `ttl` diff --git a/modules/network/virtual-hub/README.md b/modules/network/virtual-hub/README.md index 8524210391..9d543ddf8f 100644 --- a/modules/network/virtual-hub/README.md +++ b/modules/network/virtual-hub/README.md @@ -349,7 +349,15 @@ The preferred routing gateway types. - Required: No - Type: string - Default: `''` -- Allowed: `['', ExpressRoute, None, VpnGateway]` +- Allowed: + ```Bicep + [ + '' + 'ExpressRoute' + 'None' + 'VpnGateway' + ] + ``` ### Parameter: `routeTableRoutes` @@ -378,7 +386,13 @@ The sku of this VirtualHub. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Basic, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/network/virtual-hub/hub-virtual-network-connection/README.md b/modules/network/virtual-hub/hub-virtual-network-connection/README.md index 91988c38ee..f591dc99f6 100644 --- a/modules/network/virtual-hub/hub-virtual-network-connection/README.md +++ b/modules/network/virtual-hub/hub-virtual-network-connection/README.md @@ -69,7 +69,7 @@ Resource ID of the virtual network to link to. Routing Configuration indicating the associated and propagated route tables for this connection. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `virtualHubName` diff --git a/modules/network/virtual-network-gateway/README.md b/modules/network/virtual-network-gateway/README.md index 763d5b9fb3..c43561c8b2 100644 --- a/modules/network/virtual-network-gateway/README.md +++ b/modules/network/virtual-network-gateway/README.md @@ -882,7 +882,13 @@ Specifies the name of the Public IP used by the Virtual Network Gateway. If it's Specifies the gateway type. E.g. VPN, ExpressRoute. - Required: Yes - Type: string -- Allowed: `[ExpressRoute, Vpn]` +- Allowed: + ```Bicep + [ + 'ExpressRoute' + 'Vpn' + ] + ``` ### Parameter: `location` @@ -1133,7 +1139,28 @@ Required. The name of the role to assign. If it cannot be found you can specify The SKU of the Gateway. - Required: Yes - Type: string -- Allowed: `[Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ]` +- Allowed: + ```Bicep + [ + 'Basic' + 'ErGw1AZ' + 'ErGw2AZ' + 'ErGw3AZ' + 'HighPerformance' + 'Standard' + 'UltraPerformance' + 'VpnGw1' + 'VpnGw1AZ' + 'VpnGw2' + 'VpnGw2AZ' + 'VpnGw3' + 'VpnGw3AZ' + 'VpnGw4' + 'VpnGw4AZ' + 'VpnGw5' + 'VpnGw5AZ' + ] + ``` ### Parameter: `tags` @@ -1152,7 +1179,7 @@ Virtual Network resource ID. Configuration for AAD Authentication for P2S Tunnel Type, Cannot be configured if clientRootCertData is provided. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `vpnClientAddressPoolPrefix` @@ -1167,7 +1194,14 @@ The generation for this VirtualNetworkGateway. Must be None if virtualNetworkGat - Required: No - Type: string - Default: `'None'` -- Allowed: `[Generation1, Generation2, None]` +- Allowed: + ```Bicep + [ + 'Generation1' + 'Generation2' + 'None' + ] + ``` ### Parameter: `vpnType` @@ -1175,7 +1209,13 @@ Specifies the VPN type. - Required: No - Type: string - Default: `'RouteBased'` -- Allowed: `[PolicyBased, RouteBased]` +- Allowed: + ```Bicep + [ + 'PolicyBased' + 'RouteBased' + ] + ``` ## Outputs diff --git a/modules/network/virtual-network-gateway/nat-rule/README.md b/modules/network/virtual-network-gateway/nat-rule/README.md index 9bb8945e60..854cb64616 100644 --- a/modules/network/virtual-network-gateway/nat-rule/README.md +++ b/modules/network/virtual-network-gateway/nat-rule/README.md @@ -74,7 +74,14 @@ The type of NAT rule for Virtual Network NAT. IngressSnat mode (also known as In - Required: No - Type: string - Default: `''` -- Allowed: `['', EgressSnat, IngressSnat]` +- Allowed: + ```Bicep + [ + '' + 'EgressSnat' + 'IngressSnat' + ] + ``` ### Parameter: `name` @@ -88,7 +95,14 @@ The type of NAT rule for Virtual Network NAT. Static one-to-one NAT establishes - Required: No - Type: string - Default: `''` -- Allowed: `['', Dynamic, Static]` +- Allowed: + ```Bicep + [ + '' + 'Dynamic' + 'Static' + ] + ``` ### Parameter: `virtualNetworkGatewayName` diff --git a/modules/network/virtual-network/README.md b/modules/network/virtual-network/README.md index 6ae0427141..c001ac80f3 100644 --- a/modules/network/virtual-network/README.md +++ b/modules/network/virtual-network/README.md @@ -745,7 +745,13 @@ If the encrypted VNet allows VM that does not support encryption. Can only be us - Required: No - Type: string - Default: `'AllowUnencrypted'` -- Allowed: `[AllowUnencrypted, DropUnencrypted]` +- Allowed: + ```Bicep + [ + 'AllowUnencrypted' + 'DropUnencrypted' + ] + ``` ## Outputs diff --git a/modules/network/virtual-network/subnet/README.md b/modules/network/virtual-network/subnet/README.md index b499e44cee..21a6956f67 100644 --- a/modules/network/virtual-network/subnet/README.md +++ b/modules/network/virtual-network/subnet/README.md @@ -117,7 +117,14 @@ enable or disable apply network policies on private endpoint in the subnet. - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `privateLinkServiceNetworkPolicies` @@ -125,7 +132,14 @@ enable or disable apply network policies on private link service in the subnet. - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/network/virtual-wan/README.md b/modules/network/virtual-wan/README.md index 4a43dbc3ca..1d107f2932 100644 --- a/modules/network/virtual-wan/README.md +++ b/modules/network/virtual-wan/README.md @@ -350,7 +350,13 @@ The type of the Virtual WAN. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Basic, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Standard' + ] + ``` ## Outputs diff --git a/modules/network/vpn-gateway/README.md b/modules/network/vpn-gateway/README.md index c9b7d5e440..8ad433891d 100644 --- a/modules/network/vpn-gateway/README.md +++ b/modules/network/vpn-gateway/README.md @@ -263,7 +263,7 @@ module vpnGateway 'br:bicep/modules/network.vpn-gateway:1.0.0' = { BGP settings details. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableBgpRouteTranslationForNat` diff --git a/modules/network/vpn-gateway/nat-rule/README.md b/modules/network/vpn-gateway/nat-rule/README.md index 8ce3c4b7a9..a14fb65749 100644 --- a/modules/network/vpn-gateway/nat-rule/README.md +++ b/modules/network/vpn-gateway/nat-rule/README.md @@ -74,7 +74,14 @@ The type of NAT rule for VPN NAT. IngressSnat mode (also known as Ingress Source - Required: No - Type: string - Default: `''` -- Allowed: `['', EgressSnat, IngressSnat]` +- Allowed: + ```Bicep + [ + '' + 'EgressSnat' + 'IngressSnat' + ] + ``` ### Parameter: `name` @@ -88,7 +95,14 @@ The type of NAT rule for VPN NAT. Static one-to-one NAT establishes a one-to-one - Required: No - Type: string - Default: `''` -- Allowed: `['', Dynamic, Static]` +- Allowed: + ```Bicep + [ + '' + 'Dynamic' + 'Static' + ] + ``` ### Parameter: `vpnGatewayName` diff --git a/modules/network/vpn-gateway/vpn-connection/README.md b/modules/network/vpn-gateway/vpn-connection/README.md index 76988787ad..d533488822 100644 --- a/modules/network/vpn-gateway/vpn-connection/README.md +++ b/modules/network/vpn-gateway/vpn-connection/README.md @@ -110,7 +110,7 @@ Reference to a VPN site to link to. Routing configuration indicating the associated and propagated route tables for this connection. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `routingWeight` @@ -153,7 +153,13 @@ Gateway connection protocol. - Required: No - Type: string - Default: `'IKEv2'` -- Allowed: `[IKEv1, IKEv2]` +- Allowed: + ```Bicep + [ + 'IKEv1' + 'IKEv2' + ] + ``` ### Parameter: `vpnGatewayName` diff --git a/modules/network/vpn-site/README.md b/modules/network/vpn-site/README.md index 13a2a17025..b6da21771a 100644 --- a/modules/network/vpn-site/README.md +++ b/modules/network/vpn-site/README.md @@ -314,14 +314,14 @@ An array of IP address ranges that can be used by subnets of the virtual network BGP settings details. Note: This is a deprecated property, please use the corresponding VpnSiteLinks property instead. Required if no addressPrefixes or VPNSiteLinks are configured. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `deviceProperties` List of properties of the device. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -389,7 +389,7 @@ Name of the VPN Site. The Office365 breakout policy. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `roleAssignments` diff --git a/modules/operational-insights/workspace/README.md b/modules/operational-insights/workspace/README.md index 48f25812c4..02c536f329 100644 --- a/modules/operational-insights/workspace/README.md +++ b/modules/operational-insights/workspace/README.md @@ -1340,7 +1340,13 @@ The network access type for accessing Log Analytics ingestion. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `publicNetworkAccessForQuery` @@ -1348,7 +1354,13 @@ The network access type for accessing Log Analytics query. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` @@ -1438,7 +1450,19 @@ The name of the SKU. - Required: No - Type: string - Default: `'PerGB2018'` -- Allowed: `[CapacityReservation, Free, LACluster, PerGB2018, PerNode, Premium, Standalone, Standard]` +- Allowed: + ```Bicep + [ + 'CapacityReservation' + 'Free' + 'LACluster' + 'PerGB2018' + 'PerNode' + 'Premium' + 'Standalone' + 'Standard' + ] + ``` ### Parameter: `storageInsightsConfigs` diff --git a/modules/operational-insights/workspace/data-export/README.md b/modules/operational-insights/workspace/data-export/README.md index 74a748b284..71d77ffb7f 100644 --- a/modules/operational-insights/workspace/data-export/README.md +++ b/modules/operational-insights/workspace/data-export/README.md @@ -43,7 +43,7 @@ This module deploys a Log Analytics Workspace Data Export. Destination properties. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enable` diff --git a/modules/operational-insights/workspace/data-source/README.md b/modules/operational-insights/workspace/data-source/README.md index 73c7fb8958..99c4331190 100644 --- a/modules/operational-insights/workspace/data-source/README.md +++ b/modules/operational-insights/workspace/data-source/README.md @@ -96,7 +96,19 @@ The kind of the DataSource. - Required: No - Type: string - Default: `'AzureActivityLog'` -- Allowed: `[AzureActivityLog, IISLogs, LinuxPerformanceCollection, LinuxPerformanceObject, LinuxSyslog, LinuxSyslogCollection, WindowsEvent, WindowsPerformanceCounter]` +- Allowed: + ```Bicep + [ + 'AzureActivityLog' + 'IISLogs' + 'LinuxPerformanceCollection' + 'LinuxPerformanceObject' + 'LinuxSyslog' + 'LinuxSyslogCollection' + 'WindowsEvent' + 'WindowsPerformanceCounter' + ] + ``` ### Parameter: `linkedResourceId` diff --git a/modules/operational-insights/workspace/linked-storage-account/README.md b/modules/operational-insights/workspace/linked-storage-account/README.md index c29ee8ed40..97a318c405 100644 --- a/modules/operational-insights/workspace/linked-storage-account/README.md +++ b/modules/operational-insights/workspace/linked-storage-account/README.md @@ -54,7 +54,15 @@ The name of the parent Log Analytics workspace. Required if the template is used Name of the link. - Required: Yes - Type: string -- Allowed: `[Alerts, AzureWatson, CustomLogs, Query]` +- Allowed: + ```Bicep + [ + 'Alerts' + 'AzureWatson' + 'CustomLogs' + 'Query' + ] + ``` ### Parameter: `resourceId` diff --git a/modules/operational-insights/workspace/table/README.md b/modules/operational-insights/workspace/table/README.md index d3d75c4af5..eb3e62a8d1 100644 --- a/modules/operational-insights/workspace/table/README.md +++ b/modules/operational-insights/workspace/table/README.md @@ -60,14 +60,20 @@ Instruct the system how to handle and charge the logs ingested to this table. - Required: No - Type: string - Default: `'Analytics'` -- Allowed: `[Analytics, Basic]` +- Allowed: + ```Bicep + [ + 'Analytics' + 'Basic' + ] + ``` ### Parameter: `restoredLogs` Restore parameters. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `retentionInDays` @@ -81,14 +87,14 @@ The table retention in days, between 4 and 730. Setting this property to -1 will Table's schema. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `searchResults` Parameters of the search job that initiated this table. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `totalRetentionInDays` diff --git a/modules/policy-insights/remediation/README.md b/modules/policy-insights/remediation/README.md index 58d11035d5..1140dd6368 100644 --- a/modules/policy-insights/remediation/README.md +++ b/modules/policy-insights/remediation/README.md @@ -522,7 +522,13 @@ The way resources to remediate are discovered. Defaults to ExistingNonCompliant - Required: No - Type: string - Default: `'ExistingNonCompliant'` -- Allowed: `[ExistingNonCompliant, ReEvaluateCompliance]` +- Allowed: + ```Bicep + [ + 'ExistingNonCompliant' + 'ReEvaluateCompliance' + ] + ``` ### Parameter: `resourceGroupName` diff --git a/modules/policy-insights/remediation/management-group/README.md b/modules/policy-insights/remediation/management-group/README.md index f7bb79c449..f93cf15102 100644 --- a/modules/policy-insights/remediation/management-group/README.md +++ b/modules/policy-insights/remediation/management-group/README.md @@ -104,7 +104,13 @@ The way resources to remediate are discovered. Defaults to ExistingNonCompliant - Required: No - Type: string - Default: `'ExistingNonCompliant'` -- Allowed: `[ExistingNonCompliant, ReEvaluateCompliance]` +- Allowed: + ```Bicep + [ + 'ExistingNonCompliant' + 'ReEvaluateCompliance' + ] + ``` ## Outputs diff --git a/modules/policy-insights/remediation/resource-group/README.md b/modules/policy-insights/remediation/resource-group/README.md index a354a06627..4878811b31 100644 --- a/modules/policy-insights/remediation/resource-group/README.md +++ b/modules/policy-insights/remediation/resource-group/README.md @@ -104,7 +104,13 @@ The way resources to remediate are discovered. Defaults to ExistingNonCompliant - Required: No - Type: string - Default: `'ExistingNonCompliant'` -- Allowed: `[ExistingNonCompliant, ReEvaluateCompliance]` +- Allowed: + ```Bicep + [ + 'ExistingNonCompliant' + 'ReEvaluateCompliance' + ] + ``` ## Outputs diff --git a/modules/policy-insights/remediation/subscription/README.md b/modules/policy-insights/remediation/subscription/README.md index 0ed9328e97..b121a0f8d5 100644 --- a/modules/policy-insights/remediation/subscription/README.md +++ b/modules/policy-insights/remediation/subscription/README.md @@ -104,7 +104,13 @@ The way resources to remediate are discovered. Defaults to ExistingNonCompliant - Required: No - Type: string - Default: `'ExistingNonCompliant'` -- Allowed: `[ExistingNonCompliant, ReEvaluateCompliance]` +- Allowed: + ```Bicep + [ + 'ExistingNonCompliant' + 'ReEvaluateCompliance' + ] + ``` ## Outputs diff --git a/modules/power-bi-dedicated/capacity/README.md b/modules/power-bi-dedicated/capacity/README.md index b014f55a63..b70a3883f6 100644 --- a/modules/power-bi-dedicated/capacity/README.md +++ b/modules/power-bi-dedicated/capacity/README.md @@ -264,7 +264,13 @@ Mode of the resource. - Required: No - Type: string - Default: `'Gen2'` -- Allowed: `[Gen1, Gen2]` +- Allowed: + ```Bicep + [ + 'Gen1' + 'Gen2' + ] + ``` ### Parameter: `name` @@ -352,7 +358,17 @@ SkuCapacity of the resource. - Required: No - Type: string - Default: `'A1'` -- Allowed: `[A1, A2, A3, A4, A5, A6]` +- Allowed: + ```Bicep + [ + 'A1' + 'A2' + 'A3' + 'A4' + 'A5' + 'A6' + ] + ``` ### Parameter: `skuTier` @@ -360,7 +376,14 @@ SkuCapacity of the resource. - Required: No - Type: string - Default: `'PBIE_Azure'` -- Allowed: `[AutoPremiumHost, PBIE_Azure, Premium]` +- Allowed: + ```Bicep + [ + 'AutoPremiumHost' + 'PBIE_Azure' + 'Premium' + ] + ``` ### Parameter: `tags` diff --git a/modules/purview/account/README.md b/modules/purview/account/README.md index 005541e314..7d2d34a463 100644 --- a/modules/purview/account/README.md +++ b/modules/purview/account/README.md @@ -616,7 +616,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `'NotSpecified'` -- Allowed: `[Disabled, Enabled, NotSpecified]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + 'NotSpecified' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/recovery-services/vault/README.md b/modules/recovery-services/vault/README.md index 3d02aec005..fe12831915 100644 --- a/modules/recovery-services/vault/README.md +++ b/modules/recovery-services/vault/README.md @@ -985,7 +985,7 @@ module vault 'br:bicep/modules/recovery-services.vault:1.0.0' = { The backup configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `backupPolicies` @@ -999,7 +999,7 @@ List of all backup policies. The storage configuration for the Azure Recovery Service Vault. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `diagnosticSettings` @@ -1188,7 +1188,7 @@ Optional. The resource ID(s) to assign to the resource. Monitoring Settings of the vault. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` @@ -1377,14 +1377,20 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `replicationAlertSettings` Replication alert settings. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `replicationFabrics` @@ -1473,7 +1479,7 @@ Required. The name of the role to assign. If it cannot be found you can specify Security Settings of the vault. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `tags` diff --git a/modules/recovery-services/vault/backup-config/README.md b/modules/recovery-services/vault/backup-config/README.md index 5ce1b92970..aec1ccbf4b 100644 --- a/modules/recovery-services/vault/backup-config/README.md +++ b/modules/recovery-services/vault/backup-config/README.md @@ -50,7 +50,13 @@ Enable this setting to protect hybrid backups against accidental deletes and add - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `isSoftDeleteFeatureStateEditable` @@ -85,7 +91,13 @@ Enable this setting to protect backup data for Azure VM, SQL Server in Azure VM - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `storageModelType` @@ -93,7 +105,15 @@ Storage type. - Required: No - Type: string - Default: `'GeoRedundant'` -- Allowed: `[GeoRedundant, LocallyRedundant, ReadAccessGeoZoneRedundant, ZoneRedundant]` +- Allowed: + ```Bicep + [ + 'GeoRedundant' + 'LocallyRedundant' + 'ReadAccessGeoZoneRedundant' + 'ZoneRedundant' + ] + ``` ### Parameter: `storageType` @@ -101,7 +121,15 @@ Storage type. - Required: No - Type: string - Default: `'GeoRedundant'` -- Allowed: `[GeoRedundant, LocallyRedundant, ReadAccessGeoZoneRedundant, ZoneRedundant]` +- Allowed: + ```Bicep + [ + 'GeoRedundant' + 'LocallyRedundant' + 'ReadAccessGeoZoneRedundant' + 'ZoneRedundant' + ] + ``` ### Parameter: `storageTypeState` @@ -109,7 +137,13 @@ Once a machine is registered against a resource, the storageTypeState is always - Required: No - Type: string - Default: `'Locked'` -- Allowed: `[Locked, Unlocked]` +- Allowed: + ```Bicep + [ + 'Locked' + 'Unlocked' + ] + ``` ## Outputs diff --git a/modules/recovery-services/vault/backup-fabric/protection-container/README.md b/modules/recovery-services/vault/backup-fabric/protection-container/README.md index 0c7bbeeb33..98712cd47b 100644 --- a/modules/recovery-services/vault/backup-fabric/protection-container/README.md +++ b/modules/recovery-services/vault/backup-fabric/protection-container/README.md @@ -48,7 +48,21 @@ Backup management type to execute the current Protection Container job. - Required: No - Type: string - Default: `''` -- Allowed: `['', AzureBackupServer, AzureIaasVM, AzureSql, AzureStorage, AzureWorkload, DefaultBackup, DPM, Invalid, MAB]` +- Allowed: + ```Bicep + [ + '' + 'AzureBackupServer' + 'AzureIaasVM' + 'AzureSql' + 'AzureStorage' + 'AzureWorkload' + 'DefaultBackup' + 'DPM' + 'Invalid' + 'MAB' + ] + ``` ### Parameter: `containerType` @@ -56,7 +70,21 @@ Type of the container. - Required: No - Type: string - Default: `''` -- Allowed: `['', AzureBackupServerContainer, AzureSqlContainer, GenericContainer, Microsoft.ClassicCompute/virtualMachines, Microsoft.Compute/virtualMachines, SQLAGWorkLoadContainer, StorageContainer, VMAppContainer, Windows]` +- Allowed: + ```Bicep + [ + '' + 'AzureBackupServerContainer' + 'AzureSqlContainer' + 'GenericContainer' + 'Microsoft.ClassicCompute/virtualMachines' + 'Microsoft.Compute/virtualMachines' + 'SQLAGWorkLoadContainer' + 'StorageContainer' + 'VMAppContainer' + 'Windows' + ] + ``` ### Parameter: `enableDefaultTelemetry` diff --git a/modules/recovery-services/vault/backup-fabric/protection-container/protected-item/README.md b/modules/recovery-services/vault/backup-fabric/protection-container/protected-item/README.md index 64cd46a689..2c15bf89ea 100644 --- a/modules/recovery-services/vault/backup-fabric/protection-container/protected-item/README.md +++ b/modules/recovery-services/vault/backup-fabric/protection-container/protected-item/README.md @@ -71,7 +71,21 @@ ID of the backup policy with which this item is backed up. The backup item type. - Required: Yes - Type: string -- Allowed: `[AzureFileShareProtectedItem, AzureVmWorkloadSAPAseDatabase, AzureVmWorkloadSAPHanaDatabase, AzureVmWorkloadSQLDatabase, DPMProtectedItem, GenericProtectedItem, MabFileFolderProtectedItem, Microsoft.ClassicCompute/virtualMachines, Microsoft.Compute/virtualMachines, Microsoft.Sql/servers/databases]` +- Allowed: + ```Bicep + [ + 'AzureFileShareProtectedItem' + 'AzureVmWorkloadSAPAseDatabase' + 'AzureVmWorkloadSAPHanaDatabase' + 'AzureVmWorkloadSQLDatabase' + 'DPMProtectedItem' + 'GenericProtectedItem' + 'MabFileFolderProtectedItem' + 'Microsoft.ClassicCompute/virtualMachines' + 'Microsoft.Compute/virtualMachines' + 'Microsoft.Sql/servers/databases' + ] + ``` ### Parameter: `protectionContainerName` diff --git a/modules/recovery-services/vault/backup-storage-config/README.md b/modules/recovery-services/vault/backup-storage-config/README.md index 44c5b030b3..e049b9e89d 100644 --- a/modules/recovery-services/vault/backup-storage-config/README.md +++ b/modules/recovery-services/vault/backup-storage-config/README.md @@ -65,7 +65,15 @@ Change Vault Storage Type (Works if vault has not registered any backup instance - Required: No - Type: string - Default: `'GeoRedundant'` -- Allowed: `[GeoRedundant, LocallyRedundant, ReadAccessGeoZoneRedundant, ZoneRedundant]` +- Allowed: + ```Bicep + [ + 'GeoRedundant' + 'LocallyRedundant' + 'ReadAccessGeoZoneRedundant' + 'ZoneRedundant' + ] + ``` ## Outputs diff --git a/modules/recovery-services/vault/replication-alert-setting/README.md b/modules/recovery-services/vault/replication-alert-setting/README.md index c756a3ce98..d0067568b8 100644 --- a/modules/recovery-services/vault/replication-alert-setting/README.md +++ b/modules/recovery-services/vault/replication-alert-setting/README.md @@ -73,7 +73,13 @@ The value indicating whether to send email to subscription administrator. - Required: No - Type: string - Default: `'Send'` -- Allowed: `[DoNotSend, Send]` +- Allowed: + ```Bicep + [ + 'DoNotSend' + 'Send' + ] + ``` ## Outputs diff --git a/modules/recovery-services/vault/replication-policy/README.md b/modules/recovery-services/vault/replication-policy/README.md index 81a72c1aa8..5a36589e2b 100644 --- a/modules/recovery-services/vault/replication-policy/README.md +++ b/modules/recovery-services/vault/replication-policy/README.md @@ -68,7 +68,13 @@ A value indicating whether multi-VM sync has to be enabled. - Required: No - Type: string - Default: `'Enable'` -- Allowed: `[Disable, Enable]` +- Allowed: + ```Bicep + [ + 'Disable' + 'Enable' + ] + ``` ### Parameter: `name` diff --git a/modules/relay/namespace/README.md b/modules/relay/namespace/README.md index 8bec8c2e9e..d4cf7ea214 100644 --- a/modules/relay/namespace/README.md +++ b/modules/relay/namespace/README.md @@ -495,7 +495,19 @@ module namespace 'br:bicep/modules/relay.namespace:1.0.0' = { Authorization Rules for the Relay namespace. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'RootManageSharedAccessKey' + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + ] + ``` ### Parameter: `diagnosticSettings` @@ -671,7 +683,7 @@ Name of the Relay Namespace. Configure networking options for Relay. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `privateEndpoints` @@ -915,7 +927,12 @@ Name of this SKU. - Required: No - Type: string - Default: `'Standard'` -- Allowed: `[Standard]` +- Allowed: + ```Bicep + [ + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/relay/namespace/authorization-rule/README.md b/modules/relay/namespace/authorization-rule/README.md index c66fadfdbe..468bfb15dc 100644 --- a/modules/relay/namespace/authorization-rule/README.md +++ b/modules/relay/namespace/authorization-rule/README.md @@ -61,7 +61,14 @@ The rights associated with the rule. - Required: No - Type: array - Default: `[]` -- Allowed: `[Listen, Manage, Send]` +- Allowed: + ```Bicep + [ + 'Listen' + 'Manage' + 'Send' + ] + ``` ## Outputs diff --git a/modules/relay/namespace/hybrid-connection/README.md b/modules/relay/namespace/hybrid-connection/README.md index bc08a7c81c..b243f4adc7 100644 --- a/modules/relay/namespace/hybrid-connection/README.md +++ b/modules/relay/namespace/hybrid-connection/README.md @@ -48,7 +48,31 @@ This module deploys a Relay Namespace Hybrid Connection. Authorization Rules for the Relay Hybrid Connection. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'RootManageSharedAccessKey' + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + { + name: 'defaultListener' + rights: [ + 'Listen' + ] + } + { + name: 'defaultSender' + rights: [ + 'Send' + ] + } + ] + ``` ### Parameter: `enableDefaultTelemetry` diff --git a/modules/relay/namespace/hybrid-connection/authorization-rule/README.md b/modules/relay/namespace/hybrid-connection/authorization-rule/README.md index 38f6f986a1..369f7fd917 100644 --- a/modules/relay/namespace/hybrid-connection/authorization-rule/README.md +++ b/modules/relay/namespace/hybrid-connection/authorization-rule/README.md @@ -68,7 +68,14 @@ The rights associated with the rule. - Required: No - Type: array - Default: `[]` -- Allowed: `[Listen, Manage, Send]` +- Allowed: + ```Bicep + [ + 'Listen' + 'Manage' + 'Send' + ] + ``` ## Outputs diff --git a/modules/relay/namespace/network-rule-set/README.md b/modules/relay/namespace/network-rule-set/README.md index 999a9f0bd2..6e4c2dcf28 100644 --- a/modules/relay/namespace/network-rule-set/README.md +++ b/modules/relay/namespace/network-rule-set/README.md @@ -38,7 +38,13 @@ Default Action for Network Rule Set. Default is "Allow". It will not be set if p - Required: No - Type: string - Default: `'Allow'` -- Allowed: `[Allow, Deny]` +- Allowed: + ```Bicep + [ + 'Allow' + 'Deny' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -66,7 +72,13 @@ This determines if traffic is allowed over public network. Default is "Enabled". - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ## Outputs diff --git a/modules/relay/namespace/wcf-relay/README.md b/modules/relay/namespace/wcf-relay/README.md index 05e08fa254..d79d0ecc46 100644 --- a/modules/relay/namespace/wcf-relay/README.md +++ b/modules/relay/namespace/wcf-relay/README.md @@ -50,7 +50,31 @@ This module deploys a Relay Namespace WCF Relay. Authorization Rules for the WCF Relay. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable, System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'RootManageSharedAccessKey' + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + { + name: 'defaultListener' + rights: [ + 'Listen' + ] + } + { + name: 'defaultSender' + rights: [ + 'Send' + ] + } + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -103,7 +127,13 @@ The name of the parent Relay Namespace for the WCF Relay. Required if the templa Type of WCF Relay. - Required: Yes - Type: string -- Allowed: `[Http, NetTcp]` +- Allowed: + ```Bicep + [ + 'Http' + 'NetTcp' + ] + ``` ### Parameter: `requiresClientAuthorization` diff --git a/modules/relay/namespace/wcf-relay/authorization-rule/README.md b/modules/relay/namespace/wcf-relay/authorization-rule/README.md index 4fbcc69f86..0cd03c7520 100644 --- a/modules/relay/namespace/wcf-relay/authorization-rule/README.md +++ b/modules/relay/namespace/wcf-relay/authorization-rule/README.md @@ -62,7 +62,14 @@ The rights associated with the rule. - Required: No - Type: array - Default: `[]` -- Allowed: `[Listen, Manage, Send]` +- Allowed: + ```Bicep + [ + 'Listen' + 'Manage' + 'Send' + ] + ``` ### Parameter: `wcfRelayName` diff --git a/modules/resources/deployment-script/README.md b/modules/resources/deployment-script/README.md index 4623399942..858feffb91 100644 --- a/modules/resources/deployment-script/README.md +++ b/modules/resources/deployment-script/README.md @@ -339,7 +339,14 @@ The clean up preference when the script execution gets in a terminal state. Spec - Required: No - Type: string - Default: `'Always'` -- Allowed: `[Always, OnExpiration, OnSuccess]` +- Allowed: + ```Bicep + [ + 'Always' + 'OnExpiration' + 'OnSuccess' + ] + ``` ### Parameter: `containerGroupName` @@ -360,7 +367,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The environment variables to pass over to the script. The list is passed as an object with a key name "secureList" and the value is the list of environment variables (array). The list must have a 'name' and a 'value' or a 'secretValue' property for each object. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `kind` @@ -368,7 +375,13 @@ Type of the script. AzurePowerShell, AzureCLI. - Required: No - Type: string - Default: `'AzurePowerShell'` -- Allowed: `[AzureCLI, AzurePowerShell]` +- Allowed: + ```Bicep + [ + 'AzureCLI' + 'AzurePowerShell' + ] + ``` ### Parameter: `location` diff --git a/modules/search/search-service/README.md b/modules/search/search-service/README.md index ca85fa4f71..c7adce3abd 100644 --- a/modules/search/search-service/README.md +++ b/modules/search/search-service/README.md @@ -432,7 +432,7 @@ module searchService 'br:bicep/modules/search.search-service:1.0.0' = { Defines the options for how the data plane API of a Search service authenticates requests. Must remain an empty object {} if 'disableLocalAuth' is set to true. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `cmkEnforcement` @@ -440,7 +440,14 @@ Describes a policy that determines how resources within the search service are t - Required: No - Type: string - Default: `'Unspecified'` -- Allowed: `[Disabled, Enabled, Unspecified]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + 'Unspecified' + ] + ``` ### Parameter: `diagnosticSettings` @@ -577,7 +584,13 @@ Applicable only for the standard3 SKU. You can set this property to enable up to - Required: No - Type: string - Default: `'default'` -- Allowed: `[default, highDensity]` +- Allowed: + ```Bicep + [ + 'default' + 'highDensity' + ] + ``` ### Parameter: `location` @@ -642,7 +655,7 @@ The name of the Azure Cognitive Search service to create or update. Search servi Network specific rules that determine how the Azure Cognitive Search service may be reached. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `partitionCount` @@ -825,7 +838,13 @@ This value can be set to 'enabled' to avoid breaking changes on existing custome - Required: No - Type: string - Default: `'enabled'` -- Allowed: `[disabled, enabled]` +- Allowed: + ```Bicep + [ + 'disabled' + 'enabled' + ] + ``` ### Parameter: `replicaCount` @@ -915,7 +934,18 @@ Defines the SKU of an Azure Cognitive Search Service, which determines price tie - Required: No - Type: string - Default: `'standard'` -- Allowed: `[basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2]` +- Allowed: + ```Bicep + [ + 'basic' + 'free' + 'standard' + 'standard2' + 'standard3' + 'storage_optimized_l1' + 'storage_optimized_l2' + ] + ``` ### Parameter: `tags` diff --git a/modules/security/azure-security-center/README.md b/modules/security/azure-security-center/README.md index 9c0167a1ef..042f824136 100644 --- a/modules/security/azure-security-center/README.md +++ b/modules/security/azure-security-center/README.md @@ -133,7 +133,13 @@ The pricing tier value for AppServices. Azure Security Center is provided in two - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `armPricingTier` @@ -141,7 +147,13 @@ The pricing tier value for ARM. Azure Security Center is provided in two pricing - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `autoProvision` @@ -149,7 +161,13 @@ Describes what kind of security agent provisioning action to take. - On or Off. - Required: No - Type: string - Default: `'On'` -- Allowed: `[Off, On]` +- Allowed: + ```Bicep + [ + 'Off' + 'On' + ] + ``` ### Parameter: `containerRegistryPricingTier` @@ -157,7 +175,13 @@ The pricing tier value for ContainerRegistry. Azure Security Center is provided - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `containersTier` @@ -165,7 +189,13 @@ The pricing tier value for containers. Azure Security Center is provided in two - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `cosmosDbsTier` @@ -173,14 +203,20 @@ The pricing tier value for CosmosDbs. Azure Security Center is provided in two p - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `deviceSecurityGroupProperties` Device Security group data. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `dnsPricingTier` @@ -188,7 +224,13 @@ The pricing tier value for DNS. Azure Security Center is provided in two pricing - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -202,7 +244,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). Security Solution data. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `keyVaultsPricingTier` @@ -210,7 +252,13 @@ The pricing tier value for KeyVaults. Azure Security Center is provided in two p - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `kubernetesServicePricingTier` @@ -218,7 +266,13 @@ The pricing tier value for KubernetesService. Azure Security Center is provided - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `location` @@ -233,7 +287,13 @@ The pricing tier value for OpenSourceRelationalDatabases. Azure Security Center - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `scope` @@ -246,7 +306,7 @@ All the VMs in this scope will send their security data to the mentioned workspa Security contact data. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `sqlServersPricingTier` @@ -254,7 +314,13 @@ The pricing tier value for SqlServers. Azure Security Center is provided in two - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `sqlServerVirtualMachinesPricingTier` @@ -262,7 +328,13 @@ The pricing tier value for SqlServerVirtualMachines. Azure Security Center is pr - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `storageAccountsPricingTier` @@ -270,7 +342,13 @@ The pricing tier value for StorageAccounts. Azure Security Center is provided in - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `virtualMachinesPricingTier` @@ -278,7 +356,13 @@ The pricing tier value for VMs. Azure Security Center is provided in two pricing - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `workspaceId` diff --git a/modules/service-bus/namespace/README.md b/modules/service-bus/namespace/README.md index a000e89570..2aaebcf0c7 100644 --- a/modules/service-bus/namespace/README.md +++ b/modules/service-bus/namespace/README.md @@ -812,7 +812,19 @@ Alternate name for namespace. Authorization Rules for the Service Bus namespace. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'RootManageSharedAccessKey' + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + ] + ``` ### Parameter: `cMKKeyName` @@ -969,7 +981,7 @@ This property disables SAS authentication for the Service Bus namespace. The disaster recovery configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -1043,7 +1055,7 @@ Optional. The resource ID(s) to assign to the resource. The migration configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `minimumTlsVersion` @@ -1051,7 +1063,14 @@ The minimum TLS version for the cluster to support. - Required: No - Type: string - Default: `'1.2'` -- Allowed: `[1.0, 1.1, 1.2]` +- Allowed: + ```Bicep + [ + '1.0' + '1.1' + '1.2' + ] + ``` ### Parameter: `name` @@ -1064,7 +1083,7 @@ Name of the Service Bus Namespace. Configure networking options for Premium SKU Service Bus. This object contains IPs/Subnets to allow or restrict access to private endpoints only. For security reasons, it is recommended to configure this object on the Namespace. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `premiumMessagingPartitions` @@ -1247,7 +1266,15 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled, SecuredByPerimeter]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + 'SecuredByPerimeter' + ] + ``` ### Parameter: `queues` @@ -1337,7 +1364,17 @@ The specified messaging units for the tier. Only used for Premium Sku tier. - Required: No - Type: int - Default: `1` -- Allowed: `[1, 2, 4, 8, 16, 32]` +- Allowed: + ```Bicep + [ + 1 + 2 + 4 + 8 + 16 + 32 + ] + ``` ### Parameter: `skuName` @@ -1345,7 +1382,14 @@ Name of this SKU. - Basic, Standard, Premium. - Required: No - Type: string - Default: `'Basic'` -- Allowed: `[Basic, Premium, Standard]` +- Allowed: + ```Bicep + [ + 'Basic' + 'Premium' + 'Standard' + ] + ``` ### Parameter: `tags` diff --git a/modules/service-bus/namespace/authorization-rule/README.md b/modules/service-bus/namespace/authorization-rule/README.md index b4bec73526..6596ebe9bf 100644 --- a/modules/service-bus/namespace/authorization-rule/README.md +++ b/modules/service-bus/namespace/authorization-rule/README.md @@ -61,7 +61,14 @@ The rights associated with the rule. - Required: No - Type: array - Default: `[]` -- Allowed: `[Listen, Manage, Send]` +- Allowed: + ```Bicep + [ + 'Listen' + 'Manage' + 'Send' + ] + ``` ## Outputs diff --git a/modules/service-bus/namespace/network-rule-set/README.md b/modules/service-bus/namespace/network-rule-set/README.md index e24150422b..86f7241c3b 100644 --- a/modules/service-bus/namespace/network-rule-set/README.md +++ b/modules/service-bus/namespace/network-rule-set/README.md @@ -40,7 +40,13 @@ Default Action for Network Rule Set. Default is "Allow". It will not be set if p - Required: No - Type: string - Default: `'Allow'` -- Allowed: `[Allow, Deny]` +- Allowed: + ```Bicep + [ + 'Allow' + 'Deny' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -68,7 +74,13 @@ This determines if traffic is allowed over public network. Default is "Enabled". - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `trustedServiceAccessEnabled` diff --git a/modules/service-bus/namespace/queue/README.md b/modules/service-bus/namespace/queue/README.md index c7a0916536..a99b09cfd8 100644 --- a/modules/service-bus/namespace/queue/README.md +++ b/modules/service-bus/namespace/queue/README.md @@ -62,7 +62,21 @@ This module deploys a Service Bus Namespace Queue. Authorization Rules for the Service Bus Queue. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'RootManageSharedAccessKey' + properties: { + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + } + ] + ``` ### Parameter: `autoDeleteOnIdle` @@ -289,7 +303,20 @@ Enumerates the possible values for the status of a messaging entity. - Active, D - Required: No - Type: string - Default: `'Active'` -- Allowed: `[Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown]` +- Allowed: + ```Bicep + [ + 'Active' + 'Creating' + 'Deleting' + 'Disabled' + 'ReceiveDisabled' + 'Renaming' + 'Restoring' + 'SendDisabled' + 'Unknown' + ] + ``` ## Outputs diff --git a/modules/service-bus/namespace/queue/authorization-rule/README.md b/modules/service-bus/namespace/queue/authorization-rule/README.md index 953b3a3459..c607332987 100644 --- a/modules/service-bus/namespace/queue/authorization-rule/README.md +++ b/modules/service-bus/namespace/queue/authorization-rule/README.md @@ -68,7 +68,14 @@ The rights associated with the rule. - Required: No - Type: array - Default: `[]` -- Allowed: `[Listen, Manage, Send]` +- Allowed: + ```Bicep + [ + 'Listen' + 'Manage' + 'Send' + ] + ``` ## Outputs diff --git a/modules/service-bus/namespace/topic/README.md b/modules/service-bus/namespace/topic/README.md index 17d9eba79b..0e2bfa7837 100644 --- a/modules/service-bus/namespace/topic/README.md +++ b/modules/service-bus/namespace/topic/README.md @@ -57,7 +57,21 @@ This module deploys a Service Bus Namespace Topic. Authorization Rules for the Service Bus Topic. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'RootManageSharedAccessKey' + properties: { + rights: [ + 'Listen' + 'Manage' + 'Send' + ] + } + } + ] + ``` ### Parameter: `autoDeleteOnIdle` @@ -242,7 +256,20 @@ Enumerates the possible values for the status of a messaging entity. - Active, D - Required: No - Type: string - Default: `'Active'` -- Allowed: `[Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown]` +- Allowed: + ```Bicep + [ + 'Active' + 'Creating' + 'Deleting' + 'Disabled' + 'ReceiveDisabled' + 'Renaming' + 'Restoring' + 'SendDisabled' + 'Unknown' + ] + ``` ### Parameter: `supportOrdering` diff --git a/modules/service-bus/namespace/topic/authorization-rule/README.md b/modules/service-bus/namespace/topic/authorization-rule/README.md index ec255bfbe3..583c624576 100644 --- a/modules/service-bus/namespace/topic/authorization-rule/README.md +++ b/modules/service-bus/namespace/topic/authorization-rule/README.md @@ -62,7 +62,14 @@ The rights associated with the rule. - Required: No - Type: array - Default: `[]` -- Allowed: `[Listen, Manage, Send]` +- Allowed: + ```Bicep + [ + 'Listen' + 'Manage' + 'Send' + ] + ``` ### Parameter: `topicName` diff --git a/modules/service-fabric/cluster/README.md b/modules/service-fabric/cluster/README.md index c572b02a48..4f8ed6b890 100644 --- a/modules/service-fabric/cluster/README.md +++ b/modules/service-fabric/cluster/README.md @@ -702,7 +702,15 @@ The list of add-on features to enable in the cluster. - Required: No - Type: array - Default: `[]` -- Allowed: `[BackupRestoreService, DnsService, RepairManager, ResourceMonitorService]` +- Allowed: + ```Bicep + [ + 'BackupRestoreService' + 'DnsService' + 'RepairManager' + 'ResourceMonitorService' + ] + ``` ### Parameter: `applicationTypes` @@ -716,21 +724,21 @@ Array of Service Fabric cluster application types. The settings to enable AAD authentication on the cluster. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `certificate` Describes the certificate details like thumbprint of the primary certificate, thumbprint of the secondary certificate and the local certificate store location. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `certificateCommonNames` Describes a list of server certificates referenced by common name that are used to secure the cluster. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `clientCertificateCommonNames` @@ -758,7 +766,7 @@ The Service Fabric runtime version of the cluster. This property can only by set The storage account information for storing Service Fabric diagnostic logs. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -859,21 +867,30 @@ Indicates a list of notification channels for cluster events. The reliability level sets the replica set size of system services. Learn about ReliabilityLevel (https://learn.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. - Required: Yes - Type: string -- Allowed: `[Bronze, Gold, None, Platinum, Silver]` +- Allowed: + ```Bicep + [ + 'Bronze' + 'Gold' + 'None' + 'Platinum' + 'Silver' + ] + ``` ### Parameter: `reverseProxyCertificate` Describes the certificate details. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `reverseProxyCertificateCommonNames` Describes a list of server certificates referenced by common name that are used to secure the cluster. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `roleAssignments` @@ -949,7 +966,13 @@ This property controls the logical grouping of VMs in upgrade domains (UDs). Thi - Required: No - Type: string - Default: `'Hierarchical'` -- Allowed: `[Hierarchical, Parallel]` +- Allowed: + ```Bicep + [ + 'Hierarchical' + 'Parallel' + ] + ``` ### Parameter: `tags` @@ -962,7 +985,7 @@ Tags of the resource. Describes the policy used when upgrading the cluster. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `upgradeMode` @@ -970,7 +993,13 @@ The upgrade mode of the cluster when new Service Fabric runtime version is avail - Required: No - Type: string - Default: `'Automatic'` -- Allowed: `[Automatic, Manual]` +- Allowed: + ```Bicep + [ + 'Automatic' + 'Manual' + ] + ``` ### Parameter: `upgradePauseEndTimestampUtc` @@ -992,7 +1021,14 @@ Indicates when new cluster runtime version upgrades will be applied after they a - Required: No - Type: string - Default: `'Wave0'` -- Allowed: `[Wave0, Wave1, Wave2]` +- Allowed: + ```Bicep + [ + 'Wave0' + 'Wave1' + 'Wave2' + ] + ``` ### Parameter: `vmImage` @@ -1007,7 +1043,13 @@ This property defines the upgrade mode for the virtual machine scale set, it is - Required: No - Type: string - Default: `'Hierarchical'` -- Allowed: `[Hierarchical, Parallel]` +- Allowed: + ```Bicep + [ + 'Hierarchical' + 'Parallel' + ] + ``` ### Parameter: `waveUpgradePaused` diff --git a/modules/signal-r-service/signal-r/README.md b/modules/signal-r-service/signal-r/README.md index 4a59945bf2..aae17d50ed 100644 --- a/modules/signal-r-service/signal-r/README.md +++ b/modules/signal-r-service/signal-r/README.md @@ -309,7 +309,12 @@ module signalR 'br:bicep/modules/signal-r-service.signal-r:1.0.0' = { The allowed origin settings of the resource. - Required: No - Type: array -- Default: `[*]` +- Default: + ```Bicep + [ + '*' + ] + ``` ### Parameter: `capacity` @@ -351,7 +356,15 @@ Enable telemetry via a Globally Unique Identifier (GUID). The features settings of the resource, `ServiceMode` is the only required feature. See https://learn.microsoft.com/en-us/azure/templates/microsoft.signalrservice/signalr?pivots=deployment-language-bicep#signalrfeature for more information. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + flag: 'ServiceMode' + value: 'Serverless' + } + ] + ``` ### Parameter: `kind` @@ -359,15 +372,33 @@ The kind of the service. - Required: No - Type: string - Default: `'SignalR'` -- Allowed: `[RawWebSockets, SignalR]` +- Allowed: + ```Bicep + [ + 'RawWebSockets' + 'SignalR' + ] + ``` ### Parameter: `liveTraceCatagoriesToEnable` Control permission for data plane traffic coming from public networks while private endpoint is enabled. - Required: No - Type: array -- Default: `[ConnectivityLogs, MessagingLogs]` -- Allowed: `[ConnectivityLogs, MessagingLogs]` +- Default: + ```Bicep + [ + 'ConnectivityLogs' + 'MessagingLogs' + ] + ``` +- Allowed: + ```Bicep + [ + 'ConnectivityLogs' + 'MessagingLogs' + ] + ``` ### Parameter: `location` @@ -414,7 +445,7 @@ The name of the SignalR Service resource. Networks ACLs, this value contains IPs to allow and/or Subnet information. Can only be set if the 'SKU' is not 'Free_F1'. For security reasons, it is recommended to set the DefaultAction Deny. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `privateEndpoints` @@ -590,15 +621,34 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `resourceLogConfigurationsToEnable` Control permission for data plane traffic coming from public networks while private endpoint is enabled. - Required: No - Type: array -- Default: `[ConnectivityLogs, MessagingLogs]` -- Allowed: `[ConnectivityLogs, MessagingLogs]` +- Default: + ```Bicep + [ + 'ConnectivityLogs' + 'MessagingLogs' + ] + ``` +- Allowed: + ```Bicep + [ + 'ConnectivityLogs' + 'MessagingLogs' + ] + ``` ### Parameter: `roleAssignments` @@ -674,7 +724,18 @@ The SKU of the service. - Required: No - Type: string - Default: `'Standard_S1'` -- Allowed: `[Free_F1, Premium_P1, Premium_P2, Premium_P3, Standard_S1, Standard_S2, Standard_S3]` +- Allowed: + ```Bicep + [ + 'Free_F1' + 'Premium_P1' + 'Premium_P2' + 'Premium_P3' + 'Standard_S1' + 'Standard_S2' + 'Standard_S3' + ] + ``` ### Parameter: `tags` diff --git a/modules/signal-r-service/web-pub-sub/README.md b/modules/signal-r-service/web-pub-sub/README.md index c4aa82598c..63e9aa3529 100644 --- a/modules/signal-r-service/web-pub-sub/README.md +++ b/modules/signal-r-service/web-pub-sub/README.md @@ -502,7 +502,7 @@ The name of the Web PubSub Service resource. Networks ACLs, this value contains IPs to allow and/or Subnet information. Can only be set if the 'SKU' is not 'Free_F1'. For security reasons, it is recommended to set the DefaultAction Deny. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `privateEndpoints` @@ -678,15 +678,34 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `resourceLogConfigurationsToEnable` Control permission for data plane traffic coming from public networks while private endpoint is enabled. - Required: No - Type: array -- Default: `[ConnectivityLogs, MessagingLogs]` -- Allowed: `[ConnectivityLogs, MessagingLogs]` +- Default: + ```Bicep + [ + 'ConnectivityLogs' + 'MessagingLogs' + ] + ``` +- Allowed: + ```Bicep + [ + 'ConnectivityLogs' + 'MessagingLogs' + ] + ``` ### Parameter: `roleAssignments` @@ -762,7 +781,13 @@ Pricing tier of the resource. - Required: No - Type: string - Default: `'Standard_S1'` -- Allowed: `[Free_F1, Standard_S1]` +- Allowed: + ```Bicep + [ + 'Free_F1' + 'Standard_S1' + ] + ``` ### Parameter: `tags` diff --git a/modules/sql/managed-instance/README.md b/modules/sql/managed-instance/README.md index 332f0dcb64..d7edde8263 100644 --- a/modules/sql/managed-instance/README.md +++ b/modules/sql/managed-instance/README.md @@ -577,7 +577,7 @@ The password given to the admin user. The administrator configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `collation` @@ -727,7 +727,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The encryption protection configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `hardwareFamily` @@ -756,7 +756,13 @@ The license type. Possible values are 'LicenseIncluded' (regular price inclusive - Required: No - Type: string - Default: `'LicenseIncluded'` -- Allowed: `[BasePrice, LicenseIncluded]` +- Allowed: + ```Bicep + [ + 'BasePrice' + 'LicenseIncluded' + ] + ``` ### Parameter: `location` @@ -824,7 +830,13 @@ Specifies the mode of database creation. Default: Regular instance creation. Res - Required: No - Type: string - Default: `'Default'` -- Allowed: `[Default, PointInTimeRestore]` +- Allowed: + ```Bicep + [ + 'Default' + 'PointInTimeRestore' + ] + ``` ### Parameter: `minimalTlsVersion` @@ -832,7 +844,15 @@ Minimal TLS version allowed. - Required: No - Type: string - Default: `'1.2'` -- Allowed: `[1.0, 1.1, 1.2, None]` +- Allowed: + ```Bicep + [ + '1.0' + '1.1' + '1.2' + 'None' + ] + ``` ### Parameter: `name` @@ -853,7 +873,14 @@ Connection type used for connecting to the instance. - Required: No - Type: string - Default: `'Proxy'` -- Allowed: `[Default, Proxy, Redirect]` +- Allowed: + ```Bicep + [ + 'Default' + 'Proxy' + 'Redirect' + ] + ``` ### Parameter: `publicDataEndpointEnabled` @@ -868,7 +895,15 @@ The storage account type used to store backups for this database. - Required: No - Type: string - Default: `'Geo'` -- Allowed: `[Geo, GeoZone, Local, Zone]` +- Allowed: + ```Bicep + [ + 'Geo' + 'GeoZone' + 'Local' + 'Zone' + ] + ``` ### Parameter: `restorePointInTime` @@ -950,7 +985,7 @@ Required. The name of the role to assign. If it cannot be found you can specify The security alert policy configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `servicePrincipal` @@ -958,7 +993,13 @@ Service principal type. If using AD Authentication and applying Admin, must be s - Required: No - Type: string - Default: `'None'` -- Allowed: `[None, SystemAssigned]` +- Allowed: + ```Bicep + [ + 'None' + 'SystemAssigned' + ] + ``` ### Parameter: `skuName` @@ -1019,7 +1060,7 @@ The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. The vulnerability assessment configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `zoneRedundant` diff --git a/modules/sql/managed-instance/database/README.md b/modules/sql/managed-instance/database/README.md index ce3569342e..12e6fb4709 100644 --- a/modules/sql/managed-instance/database/README.md +++ b/modules/sql/managed-instance/database/README.md @@ -60,14 +60,14 @@ This module deploys a SQL Managed Instance Database. The configuration for the backup long term retention policy definition. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `backupShortTermRetentionPoliciesObj` The configuration for the backup short term retention policy definition. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `catalogCollation` @@ -89,7 +89,16 @@ Managed database create mode. PointInTimeRestore: Create a database by restoring - Required: No - Type: string - Default: `'Default'` -- Allowed: `[Default, PointInTimeRestore, Recovery, RestoreExternalBackup, RestoreLongTermRetentionBackup]` +- Allowed: + ```Bicep + [ + 'Default' + 'PointInTimeRestore' + 'Recovery' + 'RestoreExternalBackup' + 'RestoreLongTermRetentionBackup' + ] + ``` ### Parameter: `diagnosticSettings` diff --git a/modules/sql/managed-instance/encryption-protector/README.md b/modules/sql/managed-instance/encryption-protector/README.md index 2b4cd9b2f6..13cdbd792b 100644 --- a/modules/sql/managed-instance/encryption-protector/README.md +++ b/modules/sql/managed-instance/encryption-protector/README.md @@ -69,7 +69,13 @@ The encryption protector type like "ServiceManaged", "AzureKeyVault". - Required: No - Type: string - Default: `'ServiceManaged'` -- Allowed: `[AzureKeyVault, ServiceManaged]` +- Allowed: + ```Bicep + [ + 'AzureKeyVault' + 'ServiceManaged' + ] + ``` ## Outputs diff --git a/modules/sql/managed-instance/key/README.md b/modules/sql/managed-instance/key/README.md index d820e021e8..327b954416 100644 --- a/modules/sql/managed-instance/key/README.md +++ b/modules/sql/managed-instance/key/README.md @@ -62,7 +62,13 @@ The encryption protector type like "ServiceManaged", "AzureKeyVault". - Required: No - Type: string - Default: `'ServiceManaged'` -- Allowed: `[AzureKeyVault, ServiceManaged]` +- Allowed: + ```Bicep + [ + 'AzureKeyVault' + 'ServiceManaged' + ] + ``` ### Parameter: `uri` diff --git a/modules/sql/managed-instance/security-alert-policy/README.md b/modules/sql/managed-instance/security-alert-policy/README.md index 5d5bf9b072..436ccd6b78 100644 --- a/modules/sql/managed-instance/security-alert-policy/README.md +++ b/modules/sql/managed-instance/security-alert-policy/README.md @@ -69,7 +69,13 @@ Enables advanced data security features, like recuring vulnerability assesment s - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ## Outputs diff --git a/modules/sql/server/README.md b/modules/sql/server/README.md index da79dd63a3..239660e8da 100644 --- a/modules/sql/server/README.md +++ b/modules/sql/server/README.md @@ -794,7 +794,7 @@ The administrator login password. Required if no `administrators` object for AAD The Azure Active Directory (AAD) administrator authentication. Required if no `administratorLogin` & `administratorLoginPassword` is provided. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `databases` @@ -822,7 +822,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). The encryption protection configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `firewallRules` @@ -904,7 +904,14 @@ Minimal TLS version allowed. - Required: No - Type: string - Default: `'1.2'` -- Allowed: `[1.0, 1.1, 1.2]` +- Allowed: + ```Bicep + [ + '1.0' + '1.1' + '1.2' + ] + ``` ### Parameter: `name` @@ -1093,7 +1100,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `restrictOutboundNetworkAccess` @@ -1101,7 +1115,14 @@ Whether or not to restrict outbound network access for this server. - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `roleAssignments` @@ -1196,7 +1217,7 @@ The virtual network rules to create in the server. The vulnerability assessment configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/sql/server/database/README.md b/modules/sql/server/database/README.md index 588563b5fb..4909365a8f 100644 --- a/modules/sql/server/database/README.md +++ b/modules/sql/server/database/README.md @@ -79,14 +79,14 @@ Time in minutes after which database is automatically paused. A value of -1 mean The long term backup retention policy to create for the database. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `backupShortTermRetentionPolicy` The short term backup retention policy to create for the database. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `collation` @@ -101,7 +101,19 @@ Specifies the mode of database creation. - Required: No - Type: string - Default: `'Default'` -- Allowed: `[Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreLongTermRetentionBackup, Secondary]` +- Allowed: + ```Bicep + [ + 'Copy' + 'Default' + 'OnlineSecondary' + 'PointInTimeRestore' + 'Recovery' + 'Restore' + 'RestoreLongTermRetentionBackup' + 'Secondary' + ] + ``` ### Parameter: `diagnosticSettings` @@ -293,7 +305,14 @@ Type of enclave requested on the database i.e. Default or VBS enclaves. - Required: No - Type: string - Default: `''` -- Allowed: `['', Default, VBS]` +- Allowed: + ```Bicep + [ + '' + 'Default' + 'VBS' + ] + ``` ### Parameter: `readScale` @@ -301,7 +320,13 @@ The state of read-only routing. - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `recoveryServicesRecoveryPointResourceId` @@ -316,7 +341,15 @@ The storage account type to be used to store backups for this database. - Required: No - Type: string - Default: `''` -- Allowed: `['', Geo, Local, Zone]` +- Allowed: + ```Bicep + [ + '' + 'Geo' + 'Local' + 'Zone' + ] + ``` ### Parameter: `restorePointInTime` diff --git a/modules/sql/server/elastic-pool/README.md b/modules/sql/server/elastic-pool/README.md index c979ff564a..f4489258fb 100644 --- a/modules/sql/server/elastic-pool/README.md +++ b/modules/sql/server/elastic-pool/README.md @@ -82,7 +82,13 @@ The license type to apply for this elastic pool. - Required: No - Type: string - Default: `'LicenseIncluded'` -- Allowed: `[BasePrice, LicenseIncluded]` +- Allowed: + ```Bicep + [ + 'BasePrice' + 'LicenseIncluded' + ] + ``` ### Parameter: `location` diff --git a/modules/sql/server/encryption-protector/README.md b/modules/sql/server/encryption-protector/README.md index 1b0d3b9083..241d32d52d 100644 --- a/modules/sql/server/encryption-protector/README.md +++ b/modules/sql/server/encryption-protector/README.md @@ -63,7 +63,13 @@ The encryption protector type. - Required: No - Type: string - Default: `'ServiceManaged'` -- Allowed: `[AzureKeyVault, ServiceManaged]` +- Allowed: + ```Bicep + [ + 'AzureKeyVault' + 'ServiceManaged' + ] + ``` ### Parameter: `sqlServerName` diff --git a/modules/sql/server/key/README.md b/modules/sql/server/key/README.md index b5f44125a5..778972e853 100644 --- a/modules/sql/server/key/README.md +++ b/modules/sql/server/key/README.md @@ -56,7 +56,13 @@ The encryption protector type like "ServiceManaged", "AzureKeyVault". - Required: No - Type: string - Default: `'ServiceManaged'` -- Allowed: `[AzureKeyVault, ServiceManaged]` +- Allowed: + ```Bicep + [ + 'AzureKeyVault' + 'ServiceManaged' + ] + ``` ### Parameter: `serverName` diff --git a/modules/sql/server/security-alert-policy/README.md b/modules/sql/server/security-alert-policy/README.md index aea40673ca..208dc6904b 100644 --- a/modules/sql/server/security-alert-policy/README.md +++ b/modules/sql/server/security-alert-policy/README.md @@ -95,7 +95,13 @@ Specifies the state of the policy, whether it is enabled or disabled or a policy - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `storageAccountAccessKey` diff --git a/modules/storage/storage-account/README.md b/modules/storage/storage-account/README.md index 3d53bcb9fd..856962bbaf 100644 --- a/modules/storage/storage-account/README.md +++ b/modules/storage/storage-account/README.md @@ -1174,7 +1174,14 @@ Required if the Storage Account kind is set to BlobStorage. The access tier is u - Required: No - Type: string - Default: `'Hot'` -- Allowed: `[Cool, Hot, Premium]` +- Allowed: + ```Bicep + [ + 'Cool' + 'Hot' + 'Premium' + ] + ``` ### Parameter: `allowBlobPublicAccess` @@ -1196,7 +1203,14 @@ Restrict copy to and from Storage Accounts within an AAD tenant or with Private - Required: No - Type: string - Default: `''` -- Allowed: `['', AAD, PrivateLink]` +- Allowed: + ```Bicep + [ + '' + 'AAD' + 'PrivateLink' + ] + ``` ### Parameter: `allowSharedKeyAccess` @@ -1210,14 +1224,14 @@ Indicates whether the storage account permits requests to be authorized with the Provides the identity based authentication settings for Azure Files. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `blobServices` Blob service and containers to deploy. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `cMKKeyName` @@ -1361,7 +1375,14 @@ Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a - Required: No - Type: string - Default: `''` -- Allowed: `['', AzureDnsZone, Standard]` +- Allowed: + ```Bicep + [ + '' + 'AzureDnsZone' + 'Standard' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -1396,7 +1417,7 @@ If true, enables Secure File Transfer Protocol for the storage account. Requires File service and shares to deploy. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `isLocalUserEnabled` @@ -1411,7 +1432,16 @@ Type of Storage Account to create. - Required: No - Type: string - Default: `'StorageV2'` -- Allowed: `[BlobStorage, BlockBlobStorage, FileStorage, Storage, StorageV2]` +- Allowed: + ```Bicep + [ + 'BlobStorage' + 'BlockBlobStorage' + 'FileStorage' + 'Storage' + 'StorageV2' + ] + ``` ### Parameter: `largeFileSharesState` @@ -1419,7 +1449,13 @@ Allow large file shares if sets to 'Enabled'. It cannot be disabled once it is e - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `localUsers` @@ -1501,7 +1537,14 @@ Set the minimum TLS version on request to storage. - Required: No - Type: string - Default: `'TLS1_2'` -- Allowed: `[TLS1_0, TLS1_1, TLS1_2]` +- Allowed: + ```Bicep + [ + 'TLS1_0' + 'TLS1_1' + 'TLS1_2' + ] + ``` ### Parameter: `name` @@ -1514,7 +1557,7 @@ Name of the Storage Account. Networks ACLs, this value contains IPs to whitelist and/or Subnet information. For security reasons, it is recommended to set the DefaultAction Deny. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `privateEndpoints` @@ -1690,14 +1733,21 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `queueServices` Queue service and queues to create. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `requireInfrastructureEncryption` @@ -1787,7 +1837,19 @@ Storage Account Sku Name. - Required: No - Type: string - Default: `'Standard_GRS'` -- Allowed: `[Premium_LRS, Premium_ZRS, Standard_GRS, Standard_GZRS, Standard_LRS, Standard_RAGRS, Standard_RAGZRS, Standard_ZRS]` +- Allowed: + ```Bicep + [ + 'Premium_LRS' + 'Premium_ZRS' + 'Standard_GRS' + 'Standard_GZRS' + 'Standard_LRS' + 'Standard_RAGRS' + 'Standard_RAGZRS' + 'Standard_ZRS' + ] + ``` ### Parameter: `supportsHttpsTrafficOnly` @@ -1801,7 +1863,7 @@ Allows HTTPS traffic only to storage service if sets to true. Table service and tables to create. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `tags` diff --git a/modules/storage/storage-account/blob-service/container/README.md b/modules/storage/storage-account/blob-service/container/README.md index 117c034ea7..edaa79f02b 100644 --- a/modules/storage/storage-account/blob-service/container/README.md +++ b/modules/storage/storage-account/blob-service/container/README.md @@ -94,7 +94,7 @@ Name of the immutable policy. Configure immutability policy. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `immutableStorageWithVersioningEnabled` @@ -108,7 +108,7 @@ This is an immutable property, when set to true it enables object level immutabi A name-value pair to associate with the container as metadata. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` @@ -122,7 +122,14 @@ Specifies whether data in the container may be accessed publicly and the level o - Required: No - Type: string - Default: `'None'` -- Allowed: `[Blob, Container, None]` +- Allowed: + ```Bicep + [ + 'Blob' + 'Container' + 'None' + ] + ``` ### Parameter: `roleAssignments` diff --git a/modules/storage/storage-account/file-service/README.md b/modules/storage/storage-account/file-service/README.md index 34a25b6076..115e31eaf4 100644 --- a/modules/storage/storage-account/file-service/README.md +++ b/modules/storage/storage-account/file-service/README.md @@ -171,14 +171,20 @@ The name of the file service. Protocol settings for file service. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `shareDeleteRetentionPolicy` The service properties for soft delete. - Required: No - Type: object -- Default: `{object}` +- Default: + ```Bicep + { + days: 7 + enabled: true + } + ``` ### Parameter: `shares` diff --git a/modules/storage/storage-account/file-service/share/README.md b/modules/storage/storage-account/file-service/share/README.md index 932885db95..7ca6ac07bd 100644 --- a/modules/storage/storage-account/file-service/share/README.md +++ b/modules/storage/storage-account/file-service/share/README.md @@ -48,7 +48,15 @@ Access tier for specific share. Required if the Storage Account kind is set to F - Required: No - Type: string - Default: `'TransactionOptimized'` -- Allowed: `[Cool, Hot, Premium, TransactionOptimized]` +- Allowed: + ```Bicep + [ + 'Cool' + 'Hot' + 'Premium' + 'TransactionOptimized' + ] + ``` ### Parameter: `enableDefaultTelemetry` @@ -63,7 +71,13 @@ The authentication protocol that is used for the file share. Can only be specifi - Required: No - Type: string - Default: `'SMB'` -- Allowed: `[NFS, SMB]` +- Allowed: + ```Bicep + [ + 'NFS' + 'SMB' + ] + ``` ### Parameter: `fileServicesName` @@ -152,7 +166,14 @@ Permissions for NFS file shares are enforced by the client OS rather than the Az - Required: No - Type: string - Default: `'NoRootSquash'` -- Allowed: `[AllSquash, NoRootSquash, RootSquash]` +- Allowed: + ```Bicep + [ + 'AllSquash' + 'NoRootSquash' + 'RootSquash' + ] + ``` ### Parameter: `shareQuota` diff --git a/modules/storage/storage-account/queue-service/queue/README.md b/modules/storage/storage-account/queue-service/queue/README.md index 94bba1bc19..80f73fb29e 100644 --- a/modules/storage/storage-account/queue-service/queue/README.md +++ b/modules/storage/storage-account/queue-service/queue/README.md @@ -50,7 +50,7 @@ Enable telemetry via a Globally Unique Identifier (GUID). A name-value pair that represents queue metadata. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `name` diff --git a/modules/synapse/workspace/README.md b/modules/synapse/workspace/README.md index da6f7bd74d..57e6c09409 100644 --- a/modules/synapse/workspace/README.md +++ b/modules/synapse/workspace/README.md @@ -999,7 +999,13 @@ Enable or Disable public network access to workspace. - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `purviewResourceID` @@ -1100,14 +1106,14 @@ Tags of the resource. The ID(s) to assign to the resource. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workspaceRepositoryConfiguration` Git integration settings. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/synapse/workspace/integration-runtime/README.md b/modules/synapse/workspace/integration-runtime/README.md index 584577e12b..11fb0c65fe 100644 --- a/modules/synapse/workspace/integration-runtime/README.md +++ b/modules/synapse/workspace/integration-runtime/README.md @@ -55,14 +55,20 @@ The name of the Integration Runtime. The type of Integration Runtime. - Required: Yes - Type: string -- Allowed: `[Managed, SelfHosted]` +- Allowed: + ```Bicep + [ + 'Managed' + 'SelfHosted' + ] + ``` ### Parameter: `typeProperties` Integration Runtime type properties. Required if type is "Managed". - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `workspaceName` diff --git a/modules/virtual-machine-images/image-template/README.md b/modules/virtual-machine-images/image-template/README.md index b8eaf937ae..eb1f5bfbfb 100644 --- a/modules/virtual-machine-images/image-template/README.md +++ b/modules/virtual-machine-images/image-template/README.md @@ -530,7 +530,13 @@ Storage account type to be used to store the image in the Azure Compute Gallery. - Required: No - Type: string - Default: `'Standard_LRS'` -- Allowed: `[Standard_LRS, Standard_ZRS]` +- Allowed: + ```Bicep + [ + 'Standard_LRS' + 'Standard_ZRS' + ] + ``` ### Parameter: `subnetId` diff --git a/modules/web/connection/README.md b/modules/web/connection/README.md index 9c3e5d2bb1..d993463be0 100644 --- a/modules/web/connection/README.md +++ b/modules/web/connection/README.md @@ -157,14 +157,14 @@ module connection 'br:bicep/modules/web.connection:1.0.0' = { Specific values for some API connections. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `customParameterValues` Customized parameter values for specific connections. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `displayName` @@ -224,14 +224,14 @@ Connection name for connection. Example: 'azureblob' when using blobs. It can c Dictionary of nonsecret parameter values. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `parameterValues` Connection strings or access keys for connection. Example: 'accountName' and 'accessKey' when using blobs. It can change depending on the resource. - Required: No - Type: secureObject -- Default: `{object}` +- Default: `{}` ### Parameter: `roleAssignments` diff --git a/modules/web/hosting-environment/README.md b/modules/web/hosting-environment/README.md index 0a55538ca4..306a671493 100644 --- a/modules/web/hosting-environment/README.md +++ b/modules/web/hosting-environment/README.md @@ -414,7 +414,15 @@ Property to enable and disable new private endpoint connection creation on ASE. Custom settings for changing the behavior of the App Service Environment. - Required: No - Type: array -- Default: `[System.Management.Automation.OrderedHashtable]` +- Default: + ```Bicep + [ + { + name: 'DisableTls1.0' + value: '1' + } + ] + ``` ### Parameter: `customDnsSuffix` @@ -580,7 +588,15 @@ Specifies which endpoints to serve internally in the Virtual Network for the App - Required: No - Type: string - Default: `'None'` -- Allowed: `[None, Publishing, Web, Web, Publishing]` +- Allowed: + ```Bicep + [ + 'None' + 'Publishing' + 'Web' + 'Web Publishing' + ] + ``` ### Parameter: `ipsslAddressCount` @@ -595,7 +611,13 @@ Kind of resource. - Required: No - Type: string - Default: `'ASEv3'` -- Allowed: `[ASEv2, ASEv3]` +- Allowed: + ```Bicep + [ + 'ASEv2' + 'ASEv3' + ] + ``` ### Parameter: `location` @@ -663,7 +685,22 @@ Frontend VM size. Cannot be used when kind is set to ASEv3. - Required: No - Type: string - Default: `''` -- Allowed: `['', ExtraLarge, Large, Medium, Standard_D1_V2, Standard_D2, Standard_D2_V2, Standard_D3, Standard_D3_V2, Standard_D4, Standard_D4_V2]` +- Allowed: + ```Bicep + [ + '' + 'ExtraLarge' + 'Large' + 'Medium' + 'Standard_D1_V2' + 'Standard_D2' + 'Standard_D2_V2' + 'Standard_D3' + 'Standard_D3_V2' + 'Standard_D4' + 'Standard_D4_V2' + ] + ``` ### Parameter: `name` @@ -764,7 +801,15 @@ Specify preference for when and how the planned maintenance is applied. - Required: No - Type: string - Default: `'None'` -- Allowed: `[Early, Late, Manual, None]` +- Allowed: + ```Bicep + [ + 'Early' + 'Late' + 'Manual' + 'None' + ] + ``` ### Parameter: `userWhitelistedIpRanges` diff --git a/modules/web/serverfarm/README.md b/modules/web/serverfarm/README.md index 0e8f31571a..1f13295b37 100644 --- a/modules/web/serverfarm/README.md +++ b/modules/web/serverfarm/README.md @@ -303,7 +303,16 @@ Kind of server OS. - Required: No - Type: string - Default: `'Windows'` -- Allowed: `[App, Elastic, FunctionApp, Linux, Windows]` +- Allowed: + ```Bicep + [ + 'App' + 'Elastic' + 'FunctionApp' + 'Linux' + 'Windows' + ] + ``` ### Parameter: `location` @@ -459,7 +468,14 @@ The instance size of the hosting plan (small, medium, or large). - Required: No - Type: int - Default: `0` -- Allowed: `[0, 1, 2]` +- Allowed: + ```Bicep + [ + 0 + 1 + 2 + ] + ``` ### Parameter: `workerTierName` diff --git a/modules/web/site/README.md b/modules/web/site/README.md index 4a1fef0403..8cabfb7b27 100644 --- a/modules/web/site/README.md +++ b/modules/web/site/README.md @@ -893,14 +893,14 @@ The resource ID of the app service environment to use for this resource. The app settings-value pairs except for AzureWebJobsStorage, AzureWebJobsDashboard, APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `authSettingV2Configuration` The auth settings V2 configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `basicPublishingCredentialsPolicies` @@ -936,14 +936,21 @@ This composes with ClientCertEnabled setting.

- ClientCertEnabled: false mean - Required: No - Type: string - Default: `'Optional'` -- Allowed: `[Optional, OptionalInteractiveUser, Required]` +- Allowed: + ```Bicep + [ + 'Optional' + 'OptionalInteractiveUser' + 'Required' + ] + ``` ### Parameter: `cloningInfo` If specified during app creation, the app is cloned from a source app. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `containerSize` @@ -1135,7 +1142,16 @@ The resource ID of the assigned identity to be used to access a key vault with. Type of site to deploy. - Required: Yes - Type: string -- Allowed: `[app, functionapp, functionapp,linux, functionapp,workflowapp, functionapp,workflowapp,linux]` +- Allowed: + ```Bicep + [ + 'app' + 'functionapp' + 'functionapplinux' + 'functionappworkflowapp' + 'functionappworkflowapplinux' + ] + ``` ### Parameter: `location` @@ -1377,7 +1393,14 @@ Whether or not public network access is allowed for this resource. For security - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `redundancyMode` @@ -1385,7 +1408,16 @@ Site redundancy mode. - Required: No - Type: string - Default: `'None'` -- Allowed: `[ActiveActive, Failover, GeoRedundant, Manual, None]` +- Allowed: + ```Bicep + [ + 'ActiveActive' + 'Failover' + 'GeoRedundant' + 'Manual' + 'None' + ] + ``` ### Parameter: `roleAssignments` @@ -1480,7 +1512,7 @@ For function apps. If true the app settings "AzureWebJobsDashboard" will be set. The site config object. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `slots` diff --git a/modules/web/site/basic-publishing-credentials-policy/README.md b/modules/web/site/basic-publishing-credentials-policy/README.md index e6cfbc594b..59fe52102c 100644 --- a/modules/web/site/basic-publishing-credentials-policy/README.md +++ b/modules/web/site/basic-publishing-credentials-policy/README.md @@ -55,7 +55,13 @@ Location for all Resources. The name of the resource. - Required: Yes - Type: string -- Allowed: `[ftp, scm]` +- Allowed: + ```Bicep + [ + 'ftp' + 'scm' + ] + ``` ### Parameter: `webAppName` diff --git a/modules/web/site/config--appsettings/README.md b/modules/web/site/config--appsettings/README.md index 2e08ed883c..3b93bb02ce 100644 --- a/modules/web/site/config--appsettings/README.md +++ b/modules/web/site/config--appsettings/README.md @@ -58,7 +58,7 @@ The name of the parent site resource. Required if the template is used in a stan The app settings key-value pairs except for AzureWebJobsStorage, AzureWebJobsDashboard, APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -72,7 +72,16 @@ Enable telemetry via a Globally Unique Identifier (GUID). Type of site to deploy. - Required: Yes - Type: string -- Allowed: `[app, functionapp, functionapp,linux, functionapp,workflowapp, functionapp,workflowapp,linux]` +- Allowed: + ```Bicep + [ + 'app' + 'functionapp' + 'functionapplinux' + 'functionappworkflowapp' + 'functionappworkflowapplinux' + ] + ``` ### Parameter: `setAzureWebJobsDashboard` diff --git a/modules/web/site/config--authsettingsv2/README.md b/modules/web/site/config--authsettingsv2/README.md index 345ad28201..da797e6048 100644 --- a/modules/web/site/config--authsettingsv2/README.md +++ b/modules/web/site/config--authsettingsv2/README.md @@ -60,7 +60,16 @@ Enable telemetry via a Globally Unique Identifier (GUID). Type of site to deploy. - Required: Yes - Type: string -- Allowed: `[app, functionapp, functionapp,linux, functionapp,workflowapp, functionapp,workflowapp,linux]` +- Allowed: + ```Bicep + [ + 'app' + 'functionapp' + 'functionapplinux' + 'functionappworkflowapp' + 'functionappworkflowapplinux' + ] + ``` ## Outputs diff --git a/modules/web/site/slot/README.md b/modules/web/site/slot/README.md index 5f79c8d56f..1769b4cec1 100644 --- a/modules/web/site/slot/README.md +++ b/modules/web/site/slot/README.md @@ -105,14 +105,14 @@ The resource ID of the app service environment to use for this resource. The app settings-value pairs except for AzureWebJobsStorage, AzureWebJobsDashboard, APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `authSettingV2Configuration` The auth settings V2 configuration. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `clientAffinityEnabled` @@ -141,14 +141,21 @@ This composes with ClientCertEnabled setting.

- ClientCertEnabled: false mean - Required: No - Type: string - Default: `'Optional'` -- Allowed: `[Optional, OptionalInteractiveUser, Required]` +- Allowed: + ```Bicep + [ + 'Optional' + 'OptionalInteractiveUser' + 'Required' + ] + ``` ### Parameter: `cloningInfo` If specified during app creation, the app is cloned from a source app. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `containerSize` @@ -340,7 +347,16 @@ The resource ID of the assigned identity to be used to access a key vault with. Type of slot to deploy. - Required: Yes - Type: string -- Allowed: `[app, functionapp, functionapp,linux, functionapp,workflowapp, functionapp,workflowapp,linux]` +- Allowed: + ```Bicep + [ + 'app' + 'functionapp' + 'functionapplinux' + 'functionappworkflowapp' + 'functionappworkflowapplinux' + ] + ``` ### Parameter: `location` @@ -582,7 +598,14 @@ Allow or block all public traffic. - Required: No - Type: string - Default: `''` -- Allowed: `['', Disabled, Enabled]` +- Allowed: + ```Bicep + [ + '' + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `redundancyMode` @@ -590,7 +613,16 @@ Site redundancy mode. - Required: No - Type: string - Default: `'None'` -- Allowed: `[ActiveActive, Failover, GeoRedundant, Manual, None]` +- Allowed: + ```Bicep + [ + 'ActiveActive' + 'Failover' + 'GeoRedundant' + 'Manual' + 'None' + ] + ``` ### Parameter: `roleAssignments` @@ -679,7 +711,7 @@ For function apps. If true the app settings "AzureWebJobsDashboard" will be set. The site config object. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `storageAccountRequired` diff --git a/modules/web/site/slot/config--appsettings/README.md b/modules/web/site/slot/config--appsettings/README.md index 4301a04146..ffdebce0c4 100644 --- a/modules/web/site/slot/config--appsettings/README.md +++ b/modules/web/site/slot/config--appsettings/README.md @@ -59,7 +59,7 @@ The name of the parent site resource. Required if the template is used in a stan The app settings key-value pairs except for AzureWebJobsStorage, AzureWebJobsDashboard, APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `enableDefaultTelemetry` @@ -73,7 +73,16 @@ Enable telemetry via the Customer Usage Attribution ID (GUID). Type of slot to deploy. - Required: Yes - Type: string -- Allowed: `[app, functionapp, functionapp,linux, functionapp,workflowapp, functionapp,workflowapp,linux]` +- Allowed: + ```Bicep + [ + 'app' + 'functionapp' + 'functionapplinux' + 'functionappworkflowapp' + 'functionappworkflowapplinux' + ] + ``` ### Parameter: `setAzureWebJobsDashboard` diff --git a/modules/web/site/slot/config--authsettingsv2/README.md b/modules/web/site/slot/config--authsettingsv2/README.md index f2620b132c..2d99aeaef9 100644 --- a/modules/web/site/slot/config--authsettingsv2/README.md +++ b/modules/web/site/slot/config--authsettingsv2/README.md @@ -61,7 +61,16 @@ Enable telemetry via the Customer Usage Attribution ID (GUID). Type of slot to deploy. - Required: Yes - Type: string -- Allowed: `[app, functionapp, functionapp,linux, functionapp,workflowapp, functionapp,workflowapp,linux]` +- Allowed: + ```Bicep + [ + 'app' + 'functionapp' + 'functionapplinux' + 'functionappworkflowapp' + 'functionappworkflowapplinux' + ] + ``` ### Parameter: `slotName` diff --git a/modules/web/site/slot/main.json b/modules/web/site/slot/main.json index a0dd2e433f..a5e671ef73 100644 --- a/modules/web/site/slot/main.json +++ b/modules/web/site/slot/main.json @@ -6,7 +6,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "11996079594340351559" + "templateHash": "2776575331575111691" }, "name": "Web/Function App Deployment Slots", "description": "This module deploys a Web or Function App Deployment Slot.", @@ -1842,4 +1842,4 @@ "value": "[reference('slot', '2022-09-01', 'full').location]" } } -} +} \ No newline at end of file diff --git a/modules/web/static-site/README.md b/modules/web/static-site/README.md index 0cc50ab558..c499a7a46a 100644 --- a/modules/web/static-site/README.md +++ b/modules/web/static-site/README.md @@ -301,7 +301,7 @@ False if config file is locked for this static web app; otherwise, true. Static site app settings. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `branch` @@ -315,7 +315,7 @@ The branch name of the GitHub repository. Build properties for the static site. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `customDomains` @@ -337,21 +337,29 @@ State indicating the status of the enterprise grade CDN serving traffic to the s - Required: No - Type: string - Default: `'Disabled'` -- Allowed: `[Disabled, Disabling, Enabled, Enabling]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Disabling' + 'Enabled' + 'Enabling' + ] + ``` ### Parameter: `functionAppSettings` Function app settings. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `linkedBackend` Object with "resourceId" and "location" of the a user defined function app. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ### Parameter: `location` @@ -682,7 +690,13 @@ Type of static site to deploy. - Required: No - Type: string - Default: `'Free'` -- Allowed: `[Free, Standard]` +- Allowed: + ```Bicep + [ + 'Free' + 'Standard' + ] + ``` ### Parameter: `stagingEnvironmentPolicy` @@ -690,7 +704,13 @@ State indicating whether staging environments are allowed or not allowed for a s - Required: No - Type: string - Default: `'Enabled'` -- Allowed: `[Disabled, Enabled]` +- Allowed: + ```Bicep + [ + 'Disabled' + 'Enabled' + ] + ``` ### Parameter: `tags` @@ -703,7 +723,7 @@ Tags of the resource. Template Options for the static site. - Required: No - Type: object -- Default: `{object}` +- Default: `{}` ## Outputs diff --git a/modules/web/static-site/config/README.md b/modules/web/static-site/config/README.md index ac76bb3933..e17e11da76 100644 --- a/modules/web/static-site/config/README.md +++ b/modules/web/static-site/config/README.md @@ -49,7 +49,13 @@ Enable telemetry via a Globally Unique Identifier (GUID). Type of settings to apply. - Required: Yes - Type: string -- Allowed: `[appsettings, functionappsettings]` +- Allowed: + ```Bicep + [ + 'appsettings' + 'functionappsettings' + ] + ``` ### Parameter: `location` diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index fb9fdbfd9f..5d80020522 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -226,39 +226,64 @@ function Set-ParametersSection { # 3. Add individual parameters foreach ($parameter in $categoryParameters) { + + $isRequired = Get-IsParameterRequired -TemplateFileContent $TemplateFileContent -Parameter $parameter + + # Default values + if ($parameter.defaultValue -is [array]) { + if ($parameter.defaultValue.count -eq 0) { + $defaultValue = '[]' + } else { + $bicepJSONDefaultParameterObject = @{ $parameter.name = ($parameter.defaultValue ?? @()) } # Wrapping on object to work with formatted Bicep script + $bicepRawformattedDefault = ConvertTo-FormattedBicep -JSONParameters $bicepJSONDefaultParameterObject + $leadingSpacesToTrim = ($bicepRawformattedDefault -match '^(\s+).+') ? $matches[1].Length : 0 + $bicepCleanedFormattedDefault = $bicepRawformattedDefault -replace ('{0}: ' -f $parameter.name) # Unwrapping the object + $defaultValue = $bicepCleanedFormattedDefault -split '\n' | ForEach-Object { $_ -replace "^\s{$leadingSpacesToTrim}" } # Removing excess leading spaces + } + } elseif ($parameter.defaultValue -is [hashtable]) { + if ($parameter.defaultValue.count -eq 0) { + $defaultValue = '{}' + } else { + $bicepDefaultValue = ConvertTo-FormattedBicep -JSONParameters $parameter.defaultValue + $defaultValue = "{`n$bicepDefaultValue`n}" + } + } elseif ($parameter.defaultValue -is [string] -and ($parameter.defaultValue -notmatch '\[\w+\(.*\).*\]')) { + $defaultValue = '''' + $parameter.defaultValue + '''' + } else { + $defaultValue = $parameter.defaultValue + } + # User defined type if ($null -eq $parameter.type -and $parameter.ContainsKey('$ref')) { $identifier = Split-Path $parameter.'$ref' -Leaf $definition = $TemplateFileContent.definitions[$identifier] - $type = $definition['type'] - $isRequired = (-not $definition['nullable']) - $defaultValue = $null $rawAllowedValues = $definition['allowedValues'] } else { $type = $parameter.type - - if ($parameter.defaultValue -is [array]) { - $defaultValue = '[{0}]' -f (($parameter.defaultValue | Sort-Object) -join ', ') - } elseif ($parameter.defaultValue -is [hashtable]) { - $defaultValue = '{object}' - } elseif ($parameter.defaultValue -is [string] -and ($parameter.defaultValue -notmatch '\[\w+\(.*\).*\]')) { - $defaultValue = '''' + $parameter.defaultValue + '''' - } else { - $defaultValue = $parameter.defaultValue - } - - $isRequired = Get-IsParameterRequired -TemplateFileContent $TemplateFileContent -Parameter $parameter $rawAllowedValues = $parameter.allowedValues } + # Allowed values + if ($rawAllowedValues -is [array]) { + $bicepJSONAllowedParameterObject = @{ $parameter.name = ($rawAllowedValues ?? @()) } # Wrapping on object to work with formatted Bicep script + $bicepRawformattedAllowed = ConvertTo-FormattedBicep -JSONParameters $bicepJSONAllowedParameterObject + $leadingSpacesToTrim = ($bicepRawformattedAllowed -match '^(\s+).+') ? $matches[1].Length : 0 + $bicepCleanedFormattedAllowed = $bicepRawformattedAllowed -replace ('{0}: ' -f $parameter.name) # Unwrapping the object + $allowedValues = $bicepCleanedFormattedAllowed -split '\n' | ForEach-Object { $_ -replace "^\s{$leadingSpacesToTrim}" } # Removing excess leading spaces + } elseif ($rawAllowedValues -is [hashtable]) { + $bicepAllowedValues = ConvertTo-FormattedBicep -JSONParameters $rawAllowedValues + $allowedValues = "{`n$bicepAllowedValues`n}" + } else { + $allowedValues = $rawAllowedValues + } + # Prepare the links to local headers $paramHeader = '### Parameter: `{0}`' -f $parameter.name $paramIdentifier = ('#{0}' -f $paramHeader.TrimStart('#').Trim().ToLower()) -replace '[:|`]' -replace ' ', '-' # Add external single quotes to all default values of type string except for those using functions $description = $parameter.metadata.description.Replace("`r`n", '

').Replace("`n", '

') - $allowedValues = ($rawAllowedValues -is [array]) ? ('[{0}]' -f (($rawAllowedValues | Sort-Object) -join ', ')) : (($rawAllowedValues -is [hashtable]) ? '{object}' : $rawAllowedValues) # Further, replace all "empty string" default values with actual visible quotes if ([regex]::Match($allowedValues, '^(\[\s*,.+)|(\[.+,\s*,)|(.+,\s*\])$').Captures.Count -gt 0) { $allowedValues = $allowedValues -replace '\[\s*,', "[''," -replace ',\s*,', ", ''," -replace ',\s*\]', ", '']" @@ -269,6 +294,36 @@ function Set-ParametersSection { $description = $description.substring("$category. ".Length) $newSectionContent += ('| [`{0}`]({1}) | {2} | {3} |' -f $parameter.name, $paramIdentifier, $type, $description) + if (-not [String]::IsNullOrEmpty($defaultValue)) { + if (($defaultValue -split '\n').count -eq 1) { + $formattedDefaultValue = '- Default: `{0}`' -f $defaultValue + } else { + $formattedDefaultValue = @( + '- Default:', + ' ```Bicep', + ($defaultValue -split '\n' | ForEach-Object { " $_" } | Out-String).TrimEnd(), + ' ```' + ) + } + } else { + $formattedDefaultValue = $null + } + + if (-not [String]::IsNullOrEmpty($allowedValues)) { + if (($allowedValues -split '\n').count -eq 1) { + $formattedAllowedValues = '- Default: `{0}`' -f $allowedValues + } else { + $formattedAllowedValues = @( + '- Allowed:', + ' ```Bicep', + ($allowedValues -split '\n' | Where-Object { -not [String]::IsNullOrEmpty($_) } | ForEach-Object { " $_" } | Out-String).TrimEnd(), + ' ```' + ) + } + } else { + $formattedAllowedValues = $null + } + $parameterList += @{ $paramIdentifier = @( $paramHeader, @@ -276,8 +331,8 @@ function Set-ParametersSection { $description, ('- Required: {0}' -f ($isRequired ? 'Yes' : 'No')), ('- Type: {0}' -f $type), - ((-not [String]::IsNullOrEmpty($defaultValue)) ? ('- Default: `{0}`' -f $defaultValue) : $null), - ((-not [String]::IsNullOrEmpty($allowedValues)) ? ('- Allowed: `{0}`' -f $allowedValues) : $null), + ((-not [String]::IsNullOrEmpty($formattedDefaultValue)) ? $formattedDefaultValue : $null), + ((-not [String]::IsNullOrEmpty($formattedAllowedValues)) ? $formattedAllowedValues : $null), '', (($parameterUsageContentMap.Keys -contains $parameter.name) ? $parameterUsageContentMap[$parameter.name] : $null) ) | Where-Object { $null -ne $_ } @@ -582,8 +637,8 @@ Add type comments to given bicep params string, using one required parameter 'na name: 'carml' // Non-required parameters lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' + kind: 'CanNotDelete' + name: 'myCustomLockName' } ' #> @@ -660,8 +715,8 @@ Order the given JSON object alphabetically. Would result into: @{ name: 'carml' lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' + kind: 'CanNotDelete' + name: 'myCustomLockName' } } #> @@ -1562,7 +1617,6 @@ function Set-ModuleReadMe { . (Join-Path $PSScriptRoot 'helper' 'ConvertTo-OrderedHashtable.ps1') . (Join-Path (Split-Path $PSScriptRoot -Parent) 'resourcePublish' 'Get-PrivateRegistryRepositoryName.ps1') - # Check template & make full path $TemplateFilePath = Resolve-Path -Path $TemplateFilePath -ErrorAction Stop @@ -1711,7 +1765,7 @@ function Set-ModuleReadMe { Write-Verbose "File [$ReadMeFilePath] updated" -Verbose } else { if ($PSCmdlet.ShouldProcess("File in path [$ReadMeFilePath]", 'Create')) { - $null = New-Item -Path $ReadMeFilePath -Value $readMeFileContent -Force + $null = New-Item -Path $ReadMeFilePath -Value ($readMeFileContent | Out-String) -Force } Write-Verbose "File [$ReadMeFilePath] created" -Verbose }