Skip to content

Latest commit

 

History

History
734 lines (509 loc) · 42.6 KB

main.bicep.parameters.md

File metadata and controls

734 lines (509 loc) · 42.6 KB
Raw

main.bicep Parameters

This module is designed to accelerate deployment of landing zones (aka Subscriptions) within an Microsoft Entra Tenant.

Parameters

Parameter name Required Description
subscriptionAliasEnabled No Whether to create a new Subscription using the Subscription Alias resource. If false, supply an existing Subscription's ID in the parameter named existingSubscriptionId instead to deploy resources to an existing Subscription. - Type: Boolean
subscriptionDisplayName No The name of the subscription alias. The string must be comprised of a-z, A-Z, 0-9, - and _. The maximum length is 63 characters. The string must be comprised of a-z, A-Z, 0-9, -, _ and (space). The maximum length is 63 characters. > The value for this parameter and the parameter named subscriptionAliasName are usually set to the same value for simplicity. But they can be different if required for a reason. > Not required when providing an existing Subscription ID via the parameter existingSubscriptionId - Type: String - Default value: '' (empty string)
subscriptionAliasName No The name of the Subscription Alias, that will be created by this module. The string must be comprised of a-z, A-Z, 0-9, -, _ and (space). The maximum length is 63 characters. > Not required when providing an existing Subscription ID via the parameter existingSubscriptionId - Type: String - Default value: '' (empty string)
subscriptionBillingScope No The Billing Scope for the new Subscription alias, that will be created by this module. A valid Billing Scope starts with /providers/Microsoft.Billing/billingAccounts/ and is case sensitive. > See below example in parameter file for an example > Not required when providing an existing Subscription ID via the parameter existingSubscriptionId - Type: String - Default value: '' (empty string)
subscriptionWorkload No The workload type can be either Production or DevTest and is case sensitive. > Not required when providing an existing Subscription ID via the parameter existingSubscriptionId - Type: String
subscriptionTenantId No The Azure Active Directory Tenant ID (GUID) to which the Subscription should be attached to. > Leave blank unless following this scenario only Programmatically create MCA subscriptions across Azure Active Directory tenants. - Type: String - Default value: '' (empty string)
subscriptionOwnerId No The Azure Active Directory principals object ID (GUID) to whom should be the Subscription Owner. > Leave blank unless following this scenario only Programmatically create MCA subscriptions across Azure Active Directory tenants. - Type: String - Default value: '' (empty string)
existingSubscriptionId No An existing subscription ID. Use this when you do not want the module to create a new subscription. But do want to manage the management group membership. A subscription ID should be provided in the example format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. - Type: String - Default value: '' (empty string)
subscriptionManagementGroupAssociationEnabled No Whether to move the Subscription to the specified Management Group supplied in the parameter subscriptionManagementGroupId. - Type: Boolean
subscriptionManagementGroupId No The destination Management Group ID for the new Subscription that will be created by this module (or the existing one provided in the parameter existingSubscriptionId). IMPORTANT: Do not supply the display name of the Management Group. The Management Group ID forms part of the Azure Resource ID. e.g., /providers/Microsoft.Management/managementGroups/{managementGroupId}. > See below example in parameter file for an example - Type: String - Default value: '' (empty string)
subscriptionTags No An object of Tag key & value pairs to be appended to a Subscription. > NOTE: Tags will only be overwritten if existing tag exists with same key as provided in this parameter; values provided here win. - Type: {} Object - Default value: {} (empty object)
virtualNetworkEnabled No Whether to create a Virtual Network or not. If set to true ensure you also provide values for the following parameters at a minimum: - virtualNetworkResourceGroupName - virtualNetworkResourceGroupLockEnabled - virtualNetworkLocation - virtualNetworkName - virtualNetworkAddressSpace > Other parameters may need to be set based on other parameters that you enable that are listed above. Check each parameters documentation for further information. - Type: Boolean
virtualNetworkResourceGroupName No The name of the Resource Group to create the Virtual Network in that is created by this module. - Type: String - Default value: '' (empty string)
virtualNetworkResourceGroupTags No An object of Tag key & value pairs to be appended to the Resource Group that the Virtual Network is created in. > NOTE: Tags will only be overwritten if existing tag exists with same key as provided in this parameter; values provided here win. - Type: {} Object - Default value: {} (empty object)
virtualNetworkResourceGroupLockEnabled No Enables the deployment of a CanNotDelete resource locks to the Virtual Networks Resource Group that is created by this module. - Type: Boolean
virtualNetworkLocation No The location of the virtual network. Use region shortnames e.g. uksouth, eastus, etc. Defaults to the region where the ARM/Bicep deployment is targeted to unless overridden. - Type: String
virtualNetworkName No The name of the virtual network. The string must consist of a-z, A-Z, 0-9, -, _, and . (period) and be between 2 and 64 characters in length. - Type: String - Default value: '' (empty string)
virtualNetworkTags No An object of tag key/value pairs to be set on the Virtual Network that is created. > NOTE: Tags will be overwritten on resource if any exist already. - Type: {} Object - Default value: {} (empty object)
virtualNetworkAddressSpace No The address space of the Virtual Network that will be created by this module, supplied as multiple CIDR blocks in an array, e.g. ["10.0.0.0/16","172.16.0.0/12"] - Type: [] Array - Default value: [] (empty array)
virtualNetworkDnsServers No The custom DNS servers to use on the Virtual Network, e.g. ["10.4.1.4", "10.2.1.5"]. If left empty (default) then Azure DNS will be used for the Virtual Network. - Type: [] Array - Default value: [] (empty array)
virtualNetworkDdosPlanId No The resource ID of an existing DDoS Network Protection Plan that you wish to link to this Virtual Network. Example Expected Values: - '' (empty string) - DDoS Netowrk Protection Plan Resource ID: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/ddosProtectionPlans/xxxxxxxxxx - Type: String - Default value: '' (empty string)
virtualNetworkPeeringEnabled No Whether to enable peering/connection with the supplied hub Virtual Network or Virtual WAN Virtual Hub. - Type: Boolean
hubNetworkResourceId No The resource ID of the Virtual Network or Virtual WAN Hub in the hub to which the created Virtual Network, by this module, will be peered/connected to via Virtual Network Peering or a Virtual WAN Virtual Hub Connection. Example Expected Values: - '' (empty string) - Hub Virtual Network Resource ID: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualNetworks/xxxxxxxxxx - Virtual WAN Virtual Hub Resource ID: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualHubs/xxxxxxxxxx - Type: String - Default value: '' (empty string)
virtualNetworkUseRemoteGateways No Enables the use of remote gateways in the specified hub virtual network. > IMPORTANT: If no gateways exist in the hub virtual network, set this to false, otherwise peering will fail to create. - Type: Boolean
virtualNetworkVwanEnableInternetSecurity No Enables the ability for the Virtual WAN Hub Connection to learn the default route 0.0.0.0/0 from the Hub. - Type: Boolean
virtualNetworkVwanAssociatedRouteTableResourceId No The resource ID of the virtual hub route table to associate to the virtual hub connection (this virtual network). If left blank/empty the defaultRouteTable will be associated. - Type: String - Default value: '' (empty string) = Which means if the parameter virtualNetworkPeeringEnabled is true and also the parameter hubNetworkResourceId is not empty then the defaultRouteTable will be associated of the provided Virtual Hub in the parameter hubNetworkResourceId. - e.g. /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualHubs/xxxxxxxxx/hubRouteTables/defaultRouteTable
virtualNetworkVwanPropagatedRouteTablesResourceIds No An array of of objects of virtual hub route table resource IDs to propagate routes to. If left blank/empty the defaultRouteTable will be propagated to only. Each object must contain the following key: - id = The Resource ID of the Virtual WAN Virtual Hub Route Table IDs you wish to propagate too > See below example in parameter file > IMPORTANT: If you provide any Route Tables in this array of objects you must ensure you include also the defaultRouteTable Resource ID as an object in the array as it is not added by default when a value is provided for this parameter. - Type: [] Array - Default value: [] (empty array)
virtualNetworkVwanPropagatedLabels No An array of virtual hub route table labels to propagate routes to. If left blank/empty the default label will be propagated to only. - Type: [] Array - Default value: [] (empty array)
vHubRoutingIntentEnabled No Indicates whether routing intent is enabled on the Virtual Hub within the Virtual WAN. - Type: Boolean
roleAssignmentEnabled No Whether to create role assignments or not. If true, supply the array of role assignment objects in the parameter called roleAssignments. - Type: Boolean
roleAssignments No Supply an array of objects containing the details of the role assignments to create. Each object must contain the following keys: - principalId = The Object ID of the User, Group, SPN, Managed Identity to assign the RBAC role too. - definition = The Name of built-In RBAC Roles or a Resource ID of a Built-in or custom RBAC Role Definition. - relativeScope = 2 options can be provided for input value: 1. '' (empty string) = Make RBAC Role Assignment to Subscription scope 2. '/resourceGroups/<RESOURCE GROUP NAME>' = Make RBAC Role Assignment to specified Resource Group > See below example in parameter file of various combinations - Type: [] Array - Default value: [] (empty array)
disableTelemetry No Disable telemetry collection by this module. For more information on the telemetry collected by this module, that is controlled by this parameter, see this page in the wiki: Telemetry Tracking Using Customer Usage Attribution (PID)
deploymentScriptResourceGroupName No The name of the resource group to create the deployment script for resource providers registration.
deploymentScriptName No The name of the deployment script to register resource providers
deploymentScriptManagedIdentityName No The name of the user managed identity for the resource providers registration deployment script.
resourceProviders No An object of resource providers and resource providers features to register. If left blank/empty, a list of most common resource providers will be registered. - Type: {} Object - Default value: { 'Microsoft.ApiManagement' : [] 'Microsoft.AppPlatform' : [] 'Microsoft.Authorization' : [] 'Microsoft.Automation' : [] 'Microsoft.AVS' : [] 'Microsoft.Blueprint' : [] 'Microsoft.BotService' : [] 'Microsoft.Cache' : [] 'Microsoft.Cdn' : [] 'Microsoft.CognitiveServices' : [] 'Microsoft.Compute' : [] 'Microsoft.ContainerInstance' : [] 'Microsoft.ContainerRegistry' : [] 'Microsoft.ContainerService' : [] 'Microsoft.CostManagement' : [] 'Microsoft.CustomProviders' : [] 'Microsoft.Databricks' : [] 'Microsoft.DataLakeAnalytics' : [] 'Microsoft.DataLakeStore' : [] 'Microsoft.DataMigration' : [] 'Microsoft.DataProtection' : [] 'Microsoft.DBforMariaDB' : [] 'Microsoft.DBforMySQL' : [] 'Microsoft.DBforPostgreSQL' : [] 'Microsoft.DesktopVirtualization' : [] 'Microsoft.Devices' : [] 'Microsoft.DevTestLab' : [] 'Microsoft.DocumentDB' : [] 'Microsoft.EventGrid' : [] 'Microsoft.EventHub' : [] 'Microsoft.HDInsight' : [] 'Microsoft.HealthcareApis' : [] 'Microsoft.GuestConfiguration' : [] 'Microsoft.KeyVault' : [] 'Microsoft.Kusto' : [] 'microsoft.insights' : [] 'Microsoft.Logic' : [] 'Microsoft.MachineLearningServices' : [] 'Microsoft.Maintenance' : [] 'Microsoft.ManagedIdentity' : [] 'Microsoft.ManagedServices' : [] 'Microsoft.Management' : [] 'Microsoft.Maps' : [] 'Microsoft.MarketplaceOrdering' : [] 'Microsoft.Media' : [] 'Microsoft.MixedReality' : [] 'Microsoft.Network' : [] 'Microsoft.NotificationHubs' : [] 'Microsoft.OperationalInsights' : [] 'Microsoft.OperationsManagement' : [] 'Microsoft.PolicyInsights' : [] 'Microsoft.PowerBIDedicated' : [] 'Microsoft.Relay' : [] 'Microsoft.RecoveryServices' : [] 'Microsoft.Resources' : [] 'Microsoft.Search' : [] 'Microsoft.Security' : [] 'Microsoft.SecurityInsights' : [] 'Microsoft.ServiceBus' : [] 'Microsoft.ServiceFabric' : [] 'Microsoft.Sql' : [] 'Microsoft.Storage' : [] 'Microsoft.StreamAnalytics' : [] 'Microsoft.TimeSeriesInsights' : [] 'Microsoft.Web' : [] }

subscriptionAliasEnabled

Parameter Setting

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

  • Type: Boolean

  • Default value: True

subscriptionDisplayName

Parameter Setting

The name of the subscription alias. The string must be comprised of a-z, A-Z, 0-9, - and _. The maximum length is 63 characters.

The string must be comprised of a-z, A-Z, 0-9, -, _ and (space). The maximum length is 63 characters.

The value for this parameter and the parameter named subscriptionAliasName are usually set to the same value for simplicity. But they can be different if required for a reason.

Not required when providing an existing Subscription ID via the parameter existingSubscriptionId

  • Type: String
  • Default value: '' (empty string)

subscriptionAliasName

Parameter Setting

The name of the Subscription Alias, that will be created by this module.

The string must be comprised of a-z, A-Z, 0-9, -, _ and (space). The maximum length is 63 characters.

Not required when providing an existing Subscription ID via the parameter existingSubscriptionId

  • Type: String
  • Default value: '' (empty string)

subscriptionBillingScope

Parameter Setting

The Billing Scope for the new Subscription alias, that will be created by this module.

A valid Billing Scope starts with /providers/Microsoft.Billing/billingAccounts/ and is case sensitive.

See below example in parameter file for an example

Not required when providing an existing Subscription ID via the parameter existingSubscriptionId

  • Type: String
  • Default value: '' (empty string)

subscriptionWorkload

Parameter Setting

The workload type can be either Production or DevTest and is case sensitive.

Not required when providing an existing Subscription ID via the parameter existingSubscriptionId

  • Type: String

  • Default value: Production

  • Allowed values: DevTest, Production

subscriptionTenantId

Parameter Setting

The Azure Active Directory Tenant ID (GUID) to which the Subscription should be attached to.

Leave blank unless following this scenario only Programmatically create MCA subscriptions across Azure Active Directory tenants.

  • Type: String
  • Default value: '' (empty string)

subscriptionOwnerId

Parameter Setting

The Azure Active Directory principals object ID (GUID) to whom should be the Subscription Owner.

Leave blank unless following this scenario only Programmatically create MCA subscriptions across Azure Active Directory tenants.

  • Type: String
  • Default value: '' (empty string)

existingSubscriptionId

Parameter Setting

An existing subscription ID. Use this when you do not want the module to create a new subscription. But do want to manage the management group membership. A subscription ID should be provided in the example format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

  • Type: String
  • Default value: '' (empty string)

subscriptionManagementGroupAssociationEnabled

Parameter Setting

Whether to move the Subscription to the specified Management Group supplied in the parameter subscriptionManagementGroupId.

  • Type: Boolean

  • Default value: True

subscriptionManagementGroupId

Parameter Setting

The destination Management Group ID for the new Subscription that will be created by this module (or the existing one provided in the parameter existingSubscriptionId).

IMPORTANT: Do not supply the display name of the Management Group. The Management Group ID forms part of the Azure Resource ID. e.g., /providers/Microsoft.Management/managementGroups/{managementGroupId}.

See below example in parameter file for an example

  • Type: String
  • Default value: '' (empty string)

subscriptionTags

Parameter Setting

An object of Tag key & value pairs to be appended to a Subscription.

NOTE: Tags will only be overwritten if existing tag exists with same key as provided in this parameter; values provided here win.

  • Type: {} Object
  • Default value: {} (empty object)

virtualNetworkEnabled

Parameter Setting

Whether to create a Virtual Network or not.

If set to true ensure you also provide values for the following parameters at a minimum:

  • virtualNetworkResourceGroupName
  • virtualNetworkResourceGroupLockEnabled
  • virtualNetworkLocation
  • virtualNetworkName
  • virtualNetworkAddressSpace

Other parameters may need to be set based on other parameters that you enable that are listed above. Check each parameters documentation for further information.

  • Type: Boolean

  • Default value: False

virtualNetworkResourceGroupName

Parameter Setting

The name of the Resource Group to create the Virtual Network in that is created by this module.

  • Type: String
  • Default value: '' (empty string)

virtualNetworkResourceGroupTags

Parameter Setting

An object of Tag key & value pairs to be appended to the Resource Group that the Virtual Network is created in.

NOTE: Tags will only be overwritten if existing tag exists with same key as provided in this parameter; values provided here win.

  • Type: {} Object
  • Default value: {} (empty object)

virtualNetworkResourceGroupLockEnabled

Parameter Setting

Enables the deployment of a CanNotDelete resource locks to the Virtual Networks Resource Group that is created by this module.

  • Type: Boolean

  • Default value: True

virtualNetworkLocation

Parameter Setting

The location of the virtual network. Use region shortnames e.g. uksouth, eastus, etc. Defaults to the region where the ARM/Bicep deployment is targeted to unless overridden.

  • Type: String

  • Default value: [deployment().location]

virtualNetworkName

Parameter Setting

The name of the virtual network. The string must consist of a-z, A-Z, 0-9, -, _, and . (period) and be between 2 and 64 characters in length.

  • Type: String
  • Default value: '' (empty string)

virtualNetworkTags

Parameter Setting

An object of tag key/value pairs to be set on the Virtual Network that is created.

NOTE: Tags will be overwritten on resource if any exist already.

  • Type: {} Object
  • Default value: {} (empty object)

virtualNetworkAddressSpace

Parameter Setting

The address space of the Virtual Network that will be created by this module, supplied as multiple CIDR blocks in an array, e.g. ["10.0.0.0/16","172.16.0.0/12"]

  • Type: [] Array
  • Default value: [] (empty array)

virtualNetworkDnsServers

Parameter Setting

The custom DNS servers to use on the Virtual Network, e.g. ["10.4.1.4", "10.2.1.5"]. If left empty (default) then Azure DNS will be used for the Virtual Network.

  • Type: [] Array
  • Default value: [] (empty array)

virtualNetworkDdosPlanId

Parameter Setting

The resource ID of an existing DDoS Network Protection Plan that you wish to link to this Virtual Network.

Example Expected Values:

  • '' (empty string)

  • DDoS Netowrk Protection Plan Resource ID: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/ddosProtectionPlans/xxxxxxxxxx

  • Type: String

  • Default value: '' (empty string)

virtualNetworkPeeringEnabled

Parameter Setting

Whether to enable peering/connection with the supplied hub Virtual Network or Virtual WAN Virtual Hub.

  • Type: Boolean

  • Default value: False

hubNetworkResourceId

Parameter Setting

The resource ID of the Virtual Network or Virtual WAN Hub in the hub to which the created Virtual Network, by this module, will be peered/connected to via Virtual Network Peering or a Virtual WAN Virtual Hub Connection.

Example Expected Values:

  • '' (empty string)

  • Hub Virtual Network Resource ID: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualNetworks/xxxxxxxxxx

  • Virtual WAN Virtual Hub Resource ID: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualHubs/xxxxxxxxxx

  • Type: String

  • Default value: '' (empty string)

virtualNetworkUseRemoteGateways

Parameter Setting

Enables the use of remote gateways in the specified hub virtual network.

IMPORTANT: If no gateways exist in the hub virtual network, set this to false, otherwise peering will fail to create.

  • Type: Boolean

  • Default value: True

virtualNetworkVwanEnableInternetSecurity

Parameter Setting

Enables the ability for the Virtual WAN Hub Connection to learn the default route 0.0.0.0/0 from the Hub.

  • Type: Boolean

  • Default value: True

virtualNetworkVwanAssociatedRouteTableResourceId

Parameter Setting

The resource ID of the virtual hub route table to associate to the virtual hub connection (this virtual network). If left blank/empty the defaultRouteTable will be associated.

  • Type: String
  • Default value: '' (empty string) = Which means if the parameter virtualNetworkPeeringEnabled is true and also the parameter hubNetworkResourceId is not empty then the defaultRouteTable will be associated of the provided Virtual Hub in the parameter hubNetworkResourceId.
    • e.g. /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualHubs/xxxxxxxxx/hubRouteTables/defaultRouteTable

virtualNetworkVwanPropagatedRouteTablesResourceIds

Parameter Setting

An array of of objects of virtual hub route table resource IDs to propagate routes to. If left blank/empty the defaultRouteTable will be propagated to only.

Each object must contain the following key:

  • id = The Resource ID of the Virtual WAN Virtual Hub Route Table IDs you wish to propagate too

See below example in parameter file

IMPORTANT: If you provide any Route Tables in this array of objects you must ensure you include also the defaultRouteTable Resource ID as an object in the array as it is not added by default when a value is provided for this parameter.

  • Type: [] Array
  • Default value: [] (empty array)

virtualNetworkVwanPropagatedLabels

Parameter Setting

An array of virtual hub route table labels to propagate routes to. If left blank/empty the default label will be propagated to only.

  • Type: [] Array
  • Default value: [] (empty array)

vHubRoutingIntentEnabled

Parameter Setting

Indicates whether routing intent is enabled in the virtual hub. If it is enabled and this is not set the deployment will fail.

  • Type: Boolean

Default value

False

roleAssignmentEnabled

Parameter Setting

Whether to create role assignments or not. If true, supply the array of role assignment objects in the parameter called roleAssignments.

  • Type: Boolean

  • Default value: False

roleAssignments

Parameter Setting

Supply an array of objects containing the details of the role assignments to create.

Each object must contain the following keys:

  • principalId = The Object ID of the User, Group, SPN, Managed Identity to assign the RBAC role too.
  • definition = The Name of built-In RBAC Roles or a Resource ID of a Built-in or custom RBAC Role Definition.
  • relativeScope = 2 options can be provided for input value:
    1. '' (empty string) = Make RBAC Role Assignment to Subscription scope
    2. '/resourceGroups/<RESOURCE GROUP NAME>' = Make RBAC Role Assignment to specified Resource Group

See below example in parameter file of various combinations

  • Type: [] Array
  • Default value: [] (empty array)

disableTelemetry

Parameter Setting

Disable telemetry collection by this module.

For more information on the telemetry collected by this module, that is controlled by this parameter, see this page in the wiki: Telemetry Tracking Using Customer Usage Attribution (PID)

  • Default value: False

deploymentScriptResourceGroupName

Parameter Setting

The name of the resource group to create the deployment script for resource providers registration.

  • Default value: [format('rsg-{0}-ds', deployment().location)]

deploymentScriptName

Parameter Setting

The name of the deployment script to register resource providers

  • Default value: [format('ds-{0}', deployment().location)]

deploymentScriptManagedIdentityName

Parameter Setting

The name of the user managed identity for the resource providers registration deployment script.

  • Default value: [format('id-{0}', deployment().location)]

resourceProviders

Parameter Setting

An object of resource providers and resource providers features to register. If left blank/empty, a list of most common resource providers will be registered.

  • Type: {} Object

  • Default value: { 'Microsoft.ApiManagement' : [] 'Microsoft.AppPlatform' : [] 'Microsoft.Authorization' : [] 'Microsoft.Automation' : [] 'Microsoft.AVS' : [] 'Microsoft.Blueprint' : [] 'Microsoft.BotService' : [] 'Microsoft.Cache' : [] 'Microsoft.Cdn' : [] 'Microsoft.CognitiveServices' : [] 'Microsoft.Compute' : [] 'Microsoft.ContainerInstance' : [] 'Microsoft.ContainerRegistry' : [] 'Microsoft.ContainerService' : [] 'Microsoft.CostManagement' : [] 'Microsoft.CustomProviders' : [] 'Microsoft.Databricks' : [] 'Microsoft.DataLakeAnalytics' : [] 'Microsoft.DataLakeStore' : [] 'Microsoft.DataMigration' : [] 'Microsoft.DataProtection' : [] 'Microsoft.DBforMariaDB' : [] 'Microsoft.DBforMySQL' : [] 'Microsoft.DBforPostgreSQL' : [] 'Microsoft.DesktopVirtualization' : [] 'Microsoft.Devices' : [] 'Microsoft.DevTestLab' : [] 'Microsoft.DocumentDB' : [] 'Microsoft.EventGrid' : [] 'Microsoft.EventHub' : [] 'Microsoft.HDInsight' : [] 'Microsoft.HealthcareApis' : [] 'Microsoft.GuestConfiguration' : [] 'Microsoft.KeyVault' : [] 'Microsoft.Kusto' : [] 'microsoft.insights' : [] 'Microsoft.Logic' : [] 'Microsoft.MachineLearningServices' : [] 'Microsoft.Maintenance' : [] 'Microsoft.ManagedIdentity' : [] 'Microsoft.ManagedServices' : [] 'Microsoft.Management' : [] 'Microsoft.Maps' : [] 'Microsoft.MarketplaceOrdering' : [] 'Microsoft.Media' : [] 'Microsoft.MixedReality' : [] 'Microsoft.Network' : [] 'Microsoft.NotificationHubs' : [] 'Microsoft.OperationalInsights' : [] 'Microsoft.OperationsManagement' : [] 'Microsoft.PolicyInsights' : [] 'Microsoft.PowerBIDedicated' : [] 'Microsoft.Relay' : [] 'Microsoft.RecoveryServices' : [] 'Microsoft.Resources' : [] 'Microsoft.Search' : [] 'Microsoft.Security' : [] 'Microsoft.SecurityInsights' : [] 'Microsoft.ServiceBus' : [] 'Microsoft.ServiceFabric' : [] 'Microsoft.Sql' : [] 'Microsoft.Storage' : [] 'Microsoft.StreamAnalytics' : [] 'Microsoft.TimeSeriesInsights' : [] 'Microsoft.Web' : [] }

  • Default value: @{Microsoft.ApiManagement=System.Object[]; Microsoft.AppPlatform=System.Object[]; Microsoft.Authorization=System.Object[]; Microsoft.Automation=System.Object[]; Microsoft.AVS=System.Object[]; Microsoft.Blueprint=System.Object[]; Microsoft.BotService=System.Object[]; Microsoft.Cache=System.Object[]; Microsoft.Cdn=System.Object[]; Microsoft.CognitiveServices=System.Object[]; Microsoft.Compute=System.Object[]; Microsoft.ContainerInstance=System.Object[]; Microsoft.ContainerRegistry=System.Object[]; Microsoft.ContainerService=System.Object[]; Microsoft.CostManagement=System.Object[]; Microsoft.CustomProviders=System.Object[]; Microsoft.Databricks=System.Object[]; Microsoft.DataLakeAnalytics=System.Object[]; Microsoft.DataLakeStore=System.Object[]; Microsoft.DataMigration=System.Object[]; Microsoft.DataProtection=System.Object[]; Microsoft.DBforMariaDB=System.Object[]; Microsoft.DBforMySQL=System.Object[]; Microsoft.DBforPostgreSQL=System.Object[]; Microsoft.DesktopVirtualization=System.Object[]; Microsoft.Devices=System.Object[]; Microsoft.DevTestLab=System.Object[]; Microsoft.DocumentDB=System.Object[]; Microsoft.EventGrid=System.Object[]; Microsoft.EventHub=System.Object[]; Microsoft.HDInsight=System.Object[]; Microsoft.HealthcareApis=System.Object[]; Microsoft.GuestConfiguration=System.Object[]; Microsoft.KeyVault=System.Object[]; Microsoft.Kusto=System.Object[]; microsoft.insights=System.Object[]; Microsoft.Logic=System.Object[]; Microsoft.MachineLearningServices=System.Object[]; Microsoft.Maintenance=System.Object[]; Microsoft.ManagedIdentity=System.Object[]; Microsoft.ManagedServices=System.Object[]; Microsoft.Management=System.Object[]; Microsoft.Maps=System.Object[]; Microsoft.MarketplaceOrdering=System.Object[]; Microsoft.Media=System.Object[]; Microsoft.MixedReality=System.Object[]; Microsoft.Network=System.Object[]; Microsoft.NotificationHubs=System.Object[]; Microsoft.OperationalInsights=System.Object[]; Microsoft.OperationsManagement=System.Object[]; Microsoft.PolicyInsights=System.Object[]; Microsoft.PowerBIDedicated=System.Object[]; Microsoft.Relay=System.Object[]; Microsoft.RecoveryServices=System.Object[]; Microsoft.Resources=System.Object[]; Microsoft.Search=System.Object[]; Microsoft.Security=System.Object[]; Microsoft.SecurityInsights=System.Object[]; Microsoft.ServiceBus=System.Object[]; Microsoft.ServiceFabric=System.Object[]; Microsoft.Sql=System.Object[]; Microsoft.Storage=System.Object[]; Microsoft.StreamAnalytics=System.Object[]; Microsoft.TimeSeriesInsights=System.Object[]; Microsoft.Web=System.Object[]}

Outputs

Name Type Description
subscriptionId string The Subscription ID that has been created or provided.
subscriptionResourceId string The Subscription Resource ID that has been created or provided.
subscriptionAcceptOwnershipState string The Subscription Owner State. Only used when creating MCA Subscriptions across tenants
subscriptionAcceptOwnershipUrl string The Subscription Ownership URL. Only used when creating MCA Subscriptions across tenants
failedResourceProviders string The resource providers that failed to register
failedResourceProvidersFeatures string The resource providers features that failed to register

Snippets

Parameter file

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
    "contentVersion": "1.0.0.0",
    "metadata": {
        "template": "main.json"
    },
    "parameters": {
        "subscriptionAliasEnabled": {
            "value": true
        },
        "subscriptionDisplayName": {
            "value": "sub-bicep-lz-vending-example-001"
        },
        "subscriptionAliasName": {
            "value": "sub-bicep-lz-vending-example-001"
        },
        "subscriptionBillingScope": {
            "value": "providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/123456"
        },
        "subscriptionWorkload": {
            "value": "Production"
        },
        "subscriptionTenantId": {
            "value": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        },
        "subscriptionOwnerId": {
            "value": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        },
        "existingSubscriptionId": {
            "value": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        },
        "subscriptionManagementGroupAssociationEnabled": {
            "value": true
        },
        "subscriptionManagementGroupId": {
            "value": "alz-landingzones-corp"
        },
        "subscriptionTags": {
            "value": {
                "tagKey1": "value",
                "tag-key-2": "value"
            }
        },
        "virtualNetworkEnabled": {
            "value": true
        },
        "virtualNetworkResourceGroupName": {
            "value": "rg-networking-001"
        },
        "virtualNetworkResourceGroupTags": {
            "value": {
                "tagKey1": "value",
                "tag-key-2": "value"
            }
        },
        "virtualNetworkResourceGroupLockEnabled": {
            "value": true
        },
        "virtualNetworkLocation": {
            "value": "uksouth"
        },
        "virtualNetworkName": {
            "value": "vnet-example-001"
        },
        "virtualNetworkTags": {
            "value": {
                "tagKey1": "value",
                "tag-key-2": "value"
            }
        },
        "virtualNetworkAddressSpace": {
            "value": [
                "10.0.0.0/16"
            ]
        },
        "virtualNetworkDnsServers": {
            "value": [
                "10.4.1.4",
                "10.2.1.5"
            ]
        },
        "virtualNetworkDdosPlanId": {
            "value": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/ddosProtectionPlans/xxxxxxxxxx"
        },
        "virtualNetworkPeeringEnabled": {
            "value": true
        },
        "hubNetworkResourceId": {
            "value": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualNetworks/xxxxxxxxxx"
        },
        "virtualNetworkUseRemoteGateways": {
            "value": true
        },
        "virtualNetworkVwanEnableInternetSecurity": {
            "value": true
        },
        "virtualNetworkVwanAssociatedRouteTableResourceId": {
            "value": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualHubs/xxxxxxxxx/hubRouteTables/xxxxxxxxx"
        },
        "virtualNetworkVwanPropagatedRouteTablesResourceIds": {
            "value": [
                {
                    "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualHubs/xxxxxxxxx/hubRouteTables/defaultRouteTable"
                },
                {
                    "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxxxxxxx/providers/Microsoft.Network/virtualHubs/xxxxxxxxx/hubRouteTables/xxxxxxxxx"
                }
            ]
        },
        "virtualNetworkVwanPropagatedLabels": {
            "value": [
                "default",
                "anotherLabel"
            ]
        },
        "roleAssignmentEnabled": {
            "value": true
        },
        "roleAssignments": {
            "value": [
                {
                    "principalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                    "definition": "Contributor",
                    "relativeScope": ""
                },
                {
                    "principalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                    "definition": "/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                    "relativeScope": ""
                },
                {
                    "principalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                    "definition": "Reader",
                    "relativeScope": "/resourceGroups/rsg-networking-001"
                },
                {
                    "principalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                    "definition": "/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                    "relativeScope": "/resourceGroups/rsg-networking-001"
                }
            ]
        },
        "disableTelemetry": {
            "value": false
        },
        "deploymentScriptResourceGroupName": {
            "value": "[format('rsg-{0}-ds', deployment().location)]"
        },
        "deploymentScriptName": {
            "value": "[format('ds-{0}', deployment().location)]"
        },
        "deploymentScriptManagedIdentityName": {
            "value": "[format('id-{0}', deployment().location)]"
        },
        "resourceProviders": {
            "value": {
                "Microsoft.Compute": [
                    "InGuestHotPatchVMPreview"
                ],
                "Microsoft.Storage": []
            }
        }
    }
}