Azure Stack HCI Logical Network [Microsoft.AzureStackHCI/logicalNetworks]

This module deploys an Azure Stack HCI Logical Network.

Navigation

• Resource Types
• Usage examples
• Parameters
• Outputs
• Cross-referenced modules
• Data Collection

Resource Types

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/stack-hci-logical-network/main.bicep.

• Using only defaults
• WAF-aligned

Example 1: Using only defaults

This instance deploys the module with the minimum set of required parameters.

module logicalNetwork './packages/stack-hci-logical-network/main.bicep' = {
  name: 'logicalNetworkDeployment'
  params: {
    // Required parameters
    customLocationResourceId: '<customLocationResourceId>'
    name: 'ashlnminlogicalnetwork'
    vmSwitchName: 'ConvergedSwitch(management)'
    // Non-required parameters
    routeName: 'default'
    vlanId: '<vlanId>'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "customLocationResourceId": {
      "value": "<customLocationResourceId>"
    },
    "name": {
      "value": "ashlnminlogicalnetwork"
    },
    "vmSwitchName": {
      "value": "ConvergedSwitch(management)"
    },
    // Non-required parameters
    "routeName": {
      "value": "default"
    },
    "vlanId": {
      "value": "<vlanId>"
    }
  }
}

using './packages/stack-hci-logical-network/main.bicep'

// Required parameters
param customLocationResourceId = '<customLocationResourceId>'
param name = 'ashlnminlogicalnetwork'
param vmSwitchName = 'ConvergedSwitch(management)'
// Non-required parameters
param routeName = 'default'
param vlanId = '<vlanId>'

Example 2: WAF-aligned

This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.

module logicalNetwork './packages/stack-hci-logical-network/main.bicep' = {
  name: 'logicalNetworkDeployment'
  params: {
    // Required parameters
    customLocationResourceId: '<customLocationResourceId>'
    name: 'ashlnwaflogicalnetwork'
    vmSwitchName: 'ConvergedSwitch(management)'
    // Non-required parameters
    addressPrefix: '172.20.0.1/24'
    defaultGateway: '172.20.0.1'
    dnsServers: [
      '172.20.0.1'
    ]
    endingAddress: '172.20.0.190'
    ipAllocationMethod: 'Static'
    routeName: 'default'
    startingAddress: '172.20.0.171'
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
    vlanId: '<vlanId>'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "customLocationResourceId": {
      "value": "<customLocationResourceId>"
    },
    "name": {
      "value": "ashlnwaflogicalnetwork"
    },
    "vmSwitchName": {
      "value": "ConvergedSwitch(management)"
    },
    // Non-required parameters
    "addressPrefix": {
      "value": "172.20.0.1/24"
    },
    "defaultGateway": {
      "value": "172.20.0.1"
    },
    "dnsServers": {
      "value": [
        "172.20.0.1"
      ]
    },
    "endingAddress": {
      "value": "172.20.0.190"
    },
    "ipAllocationMethod": {
      "value": "Static"
    },
    "routeName": {
      "value": "default"
    },
    "startingAddress": {
      "value": "172.20.0.171"
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    },
    "vlanId": {
      "value": "<vlanId>"
    }
  }
}

using './packages/stack-hci-logical-network/main.bicep'

// Required parameters
param customLocationResourceId = '<customLocationResourceId>'
param name = 'ashlnwaflogicalnetwork'
param vmSwitchName = 'ConvergedSwitch(management)'
// Non-required parameters
param addressPrefix = '172.20.0.1/24'
param defaultGateway = '172.20.0.1'
param dnsServers = [
  '172.20.0.1'
]
param endingAddress = '172.20.0.190'
param ipAllocationMethod = 'Static'
param routeName = 'default'
param startingAddress = '172.20.0.171'
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}
param vlanId = '<vlanId>'

Parameters

Required parameters

Conditional parameters

Optional parameters

Parameter: customLocationResourceId

The custom location ID.

• Required: Yes
• Type: string

Parameter: name

Name of the resource to create.

• Required: Yes
• Type: string

Parameter: vmSwitchName

The VM switch name.

• Required: Yes
• Type: string

Parameter: addressPrefix

Address prefix for the logical network. Required if ipAllocationMethod is Static.

• Required: No
• Type: string

Parameter: defaultGateway

The default gateway for the network. Required if ipAllocationMethod is Static.

• Required: No
• Type: string

Parameter: dnsServers

The DNS servers list. Required if ipAllocationMethod is Static.

• Required: No
• Type: array
• Default: []

Parameter: endingAddress

The ending IP address of the IP address range. Required if ipAllocationMethod is Static.

• Required: No
• Type: string

Parameter: routeName

The route name. Required if ipAllocationMethod is Static.

• Required: No
• Type: string

Parameter: startingAddress

The starting IP address of the IP address range. Required if ipAllocationMethod is Static.

• Required: No
• Type: string

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: ipAllocationMethod

The IP allocation method.

• Required: No
• Type: string
• Default: 'Dynamic'
• Allowed:

  [
    'Dynamic'
    'Static'
  ]
  

Parameter: ipConfigurationReferences

A list of IP configuration references.

• Required: No
• Type: array

Required parameters

Parameter: ipConfigurationReferences.id

The ARM ID for a Network Interface.

• Required: Yes
• Type: string

Parameter: location

Location for all Resources.

• Required: No
• Type: string
• Default: [resourceGroup().location]

Parameter: roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'Contributor'
  • 'Owner'
  • 'Reader'
  • 'User Access Administrator'
  • 'Role Based Access Control Administrator'

Required parameters

Optional parameters

Parameter: roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: subnet0Name

The subnet name.

• Required: No
• Type: string
• Default: 'default'

Parameter: tags

Tags for the logical network.

• Required: No
• Type: object

Parameter: vlanId

VLan Id for the logical network.

• Required: No
• Type: int

Outputs

Cross-referenced modules

This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.