Microsoft.Network networkProfiles 2020-06-01

The networkProfiles resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Network/networkProfiles resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Network/networkProfiles@2020-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    containerNetworkInterfaceConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          containerNetworkInterfaces: [
            {
              id: 'string'
            }
          ]
          ipConfigurations: [
            {
              id: 'string'
              name: 'string'
              properties: {
                subnet: {
                  id: 'string'
                  name: 'string'
                  properties: {
                    addressPrefix: 'string'
                    addressPrefixes: [ 'string' ]
                    delegations: [
                      {
                        id: 'string'
                        name: 'string'
                        properties: {
                          serviceName: 'string'
                        }
                      }
                    ]
                    ipAllocations: [
                      {
                        id: 'string'
                      }
                    ]
                    natGateway: {
                      id: 'string'
                    }
                    networkSecurityGroup: {
                      id: 'string'
                      location: 'string'
                      properties: {
                        securityRules: [
                          {
                            id: 'string'
                            name: 'string'
                            properties: {
                              access: 'string'
                              description: 'string'
                              destinationAddressPrefix: 'string'
                              destinationAddressPrefixes: [ 'string' ]
                              destinationApplicationSecurityGroups: [
                                {
                                  id: 'string'
                                  location: 'string'
                                  properties: {}
                                  tags: {
                                    tagName1: 'tagValue1'
                                    tagName2: 'tagValue2'
                                  }
                                }
                              ]
                              destinationPortRange: 'string'
                              destinationPortRanges: [ 'string' ]
                              direction: 'string'
                              priority: int
                              protocol: 'string'
                              sourceAddressPrefix: 'string'
                              sourceAddressPrefixes: [ 'string' ]
                              sourceApplicationSecurityGroups: [
                                {
                                  id: 'string'
                                  location: 'string'
                                  properties: {}
                                  tags: {
                                    tagName1: 'tagValue1'
                                    tagName2: 'tagValue2'
                                  }
                                }
                              ]
                              sourcePortRange: 'string'
                              sourcePortRanges: [ 'string' ]
                            }
                          }
                        ]
                      }
                      tags: {
                        tagName1: 'tagValue1'
                        tagName2: 'tagValue2'
                      }
                    }
                    privateEndpointNetworkPolicies: 'string'
                    privateLinkServiceNetworkPolicies: 'string'
                    routeTable: {
                      id: 'string'
                      location: 'string'
                      properties: {
                        disableBgpRoutePropagation: bool
                        routes: [
                          {
                            id: 'string'
                            name: 'string'
                            properties: {
                              addressPrefix: 'string'
                              nextHopIpAddress: 'string'
                              nextHopType: 'string'
                            }
                          }
                        ]
                      }
                      tags: {
                        tagName1: 'tagValue1'
                        tagName2: 'tagValue2'
                      }
                    }
                    serviceEndpointPolicies: [
                      {
                        id: 'string'
                        location: 'string'
                        properties: {
                          serviceEndpointPolicyDefinitions: [
                            {
                              id: 'string'
                              name: 'string'
                              properties: {
                                description: 'string'
                                service: 'string'
                                serviceResources: [ 'string' ]
                              }
                            }
                          ]
                        }
                        tags: {
                          tagName1: 'tagValue1'
                          tagName2: 'tagValue2'
                        }
                      }
                    ]
                    serviceEndpoints: [
                      {
                        locations: [ 'string' ]
                        service: 'string'
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

Property values

networkProfiles

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Network/networkProfiles'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-06-01'
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Network profile properties. NetworkProfilePropertiesFormat

NetworkProfilePropertiesFormat

Name Description Value
containerNetworkInterfaceConfigurations List of chid container network interface configurations. ContainerNetworkInterfaceConfiguration[]

ContainerNetworkInterfaceConfiguration

Name Description Value
id Resource ID. string
name The name of the resource. This name can be used to access the resource. string
properties Container network interface configuration properties. ContainerNetworkInterfaceConfigurationPropertiesFormat

ContainerNetworkInterfaceConfigurationPropertiesFormat

Name Description Value
containerNetworkInterfaces A list of container network interfaces created from this container network interface configuration. SubResource[]
ipConfigurations A list of ip configurations of the container network interface configuration. IPConfigurationProfile[]

SubResource

Name Description Value
id Resource ID. string

IPConfigurationProfile

Name Description Value
id Resource ID. string
name The name of the resource. This name can be used to access the resource. string
properties IP configuration profile properties. IPConfigurationProfilePropertiesFormat

IPConfigurationProfilePropertiesFormat

Name Description Value
subnet Subnet in a virtual network resource. Subnet

Subnet

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Properties of the subnet. SubnetPropertiesFormat

SubnetPropertiesFormat

Name Description Value
addressPrefix The address prefix for the subnet. string
addressPrefixes List of address prefixes for the subnet. string[]
delegations An array of references to the delegations on the subnet. Delegation[]
ipAllocations Array of IpAllocation which reference this subnet. SubResource[]
natGateway Reference to another subresource. SubResource
networkSecurityGroup NetworkSecurityGroup resource. NetworkSecurityGroup
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. string
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. string
routeTable Route table resource. RouteTable
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicy[]
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat[]

Delegation

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a subnet. This name can be used to access the resource. string
properties Properties of a service delegation. ServiceDelegationPropertiesFormat

ServiceDelegationPropertiesFormat

Name Description Value
serviceName The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). string

NetworkSecurityGroup

Name Description Value
id Resource ID. string
location Resource location. string
properties Network Security Group resource. NetworkSecurityGroupPropertiesFormat
tags Resource tags. Dictionary of tag names and values. See Tags in templates

NetworkSecurityGroupPropertiesFormat

Name Description Value
securityRules A collection of security rules of the network security group. SecurityRule[]

SecurityRule

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Security rule resource. SecurityRulePropertiesFormat

SecurityRulePropertiesFormat

Name Description Value
access Whether network traffic is allowed or denied. 'Allow'
'Deny'
description A description for this rule. Restricted to 140 chars. string
destinationAddressPrefix The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. string
destinationAddressPrefixes The destination address prefixes. CIDR or destination IP ranges. string[]
destinationApplicationSecurityGroups The application security group specified as destination. ApplicationSecurityGroup[]
destinationPortRange The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. string
destinationPortRanges The destination port ranges. string[]
direction The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. 'Inbound'
'Outbound'
priority The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. int
protocol Network protocol this rule applies to. '*'
'Ah'
'Esp'
'Icmp'
'Tcp'
'Udp'
sourceAddressPrefix The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. string
sourceAddressPrefixes The CIDR or source IP ranges. string[]
sourceApplicationSecurityGroups The application security group specified as source. ApplicationSecurityGroup[]
sourcePortRange The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. string
sourcePortRanges The source port ranges. string[]

ApplicationSecurityGroup

Name Description Value
id Resource ID. string
location Resource location. string
properties Application security group properties. ApplicationSecurityGroupPropertiesFormat
tags Resource tags. Dictionary of tag names and values. See Tags in templates

ApplicationSecurityGroupPropertiesFormat

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

RouteTable

Name Description Value
id Resource ID. string
location Resource location. string
properties Route Table resource. RouteTablePropertiesFormat
tags Resource tags. Dictionary of tag names and values. See Tags in templates

RouteTablePropertiesFormat

Name Description Value
disableBgpRoutePropagation Whether to disable the routes learned by BGP on that route table. True means disable. bool
routes Collection of routes contained within a route table. Route[]

Route

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Route resource. RoutePropertiesFormat

RoutePropertiesFormat

Name Description Value
addressPrefix The destination CIDR to which the route applies. string
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
nextHopType The type of Azure hop the packet should be sent to. 'Internet'
'None'
'VirtualAppliance'
'VirtualNetworkGateway'
'VnetLocal'

ServiceEndpointPolicy

Name Description Value
id Resource ID. string
location Resource location. string
properties Service Endpoint Policy resource. ServiceEndpointPolicyPropertiesFormat
tags Resource tags. Dictionary of tag names and values. See Tags in templates

ServiceEndpointPolicyPropertiesFormat

Name Description Value
serviceEndpointPolicyDefinitions A collection of service endpoint policy definitions of the service endpoint policy. ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Service Endpoint policy definition resource. ServiceEndpointPolicyDefinitionPropertiesFormat

ServiceEndpointPolicyDefinitionPropertiesFormat

Name Description Value
description A description for this rule. Restricted to 140 chars. string
service Service endpoint name. string
serviceResources A list of service resources. string[]

ServiceEndpointPropertiesFormat

Name Description Value
locations A list of locations. string[]
service The type of the endpoint service. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a WordPress site in a virtual network

Deploy to Azure
This template creates a WordPress site on Container Instance in a virtual network. And output a public site FQDN which could access WordPress site.
Azure Cloud Shell - VNet

Deploy to Azure
This template deploys Azure Cloud Shell resources into an Azure virtual network.
Azure Container Instances - VNet

Deploy to Azure
Deploy a container instance into an Azure virtual network.
Front Door with Container Instances and Application Gateway

Deploy to Azure
This template creates a Front Door Standard/Premium (Preview) with a container group and Application Gateway.