Bicep resource definition
The networkProfiles resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Network/networkProfiles resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkProfiles@2023-05-01' = {
location: 'string'
name: 'string'
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'
]
applicationGatewayIPConfigurations: [
{
id: 'string'
name: 'string'
properties: {
subnet: {
id: 'string'
}
}
}
]
defaultOutboundAccess: bool
delegations: [
{
id: 'string'
name: 'string'
properties: {
serviceName: 'string'
}
type: 'string'
}
]
ipAllocations: [
{
id: 'string'
}
]
natGateway: {
id: 'string'
}
networkSecurityGroup: {
id: 'string'
location: 'string'
properties: {
flushConnection: bool
securityRules: [
{
id: 'string'
name: 'string'
properties: {
access: 'string'
description: 'string'
destinationAddressPrefix: 'string'
destinationAddressPrefixes: [
'string'
]
destinationApplicationSecurityGroups: [
{
id: 'string'
location: 'string'
properties: {}
tags: {
{customized property}: 'string'
}
}
]
destinationPortRange: 'string'
destinationPortRanges: [
'string'
]
direction: 'string'
priority: int
protocol: 'string'
sourceAddressPrefix: 'string'
sourceAddressPrefixes: [
'string'
]
sourceApplicationSecurityGroups: [
{
id: 'string'
location: 'string'
properties: {}
tags: {
{customized property}: 'string'
}
}
]
sourcePortRange: 'string'
sourcePortRanges: [
'string'
]
}
type: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
privateEndpointNetworkPolicies: 'string'
privateLinkServiceNetworkPolicies: 'string'
routeTable: {
id: 'string'
location: 'string'
properties: {
disableBgpRoutePropagation: bool
routes: [
{
id: 'string'
name: 'string'
properties: {
addressPrefix: 'string'
nextHopIpAddress: 'string'
nextHopType: 'string'
}
type: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
serviceEndpointPolicies: [
{
id: 'string'
location: 'string'
properties: {
contextualServiceEndpointPolicies: [
'string'
]
serviceAlias: 'string'
serviceEndpointPolicyDefinitions: [
{
id: 'string'
name: 'string'
properties: {
description: 'string'
service: 'string'
serviceResources: [
'string'
]
}
type: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
]
serviceEndpoints: [
{
locations: [
'string'
]
service: 'string'
}
]
}
type: 'string'
}
}
}
]
}
}
]
}
tags: {
{customized property}: 'string'
}
}
ApplicationGatewayIPConfiguration
Expand table
Name
Description
Value
id
Resource ID.
string
name
Name of the IP configuration that is unique within an Application Gateway.
string
properties
Properties of the application gateway IP configuration.
ApplicationGatewayIPConfigurationPropertiesFormat
Expand table
Name
Description
Value
subnet
Reference to the subnet resource. A subnet from where application gateway gets its private address.
SubResource
Expand table
Expand table
ContainerNetworkInterfaceConfiguration
Expand table
Expand table
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 []
Expand table
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 the subnet.
ServiceDelegationPropertiesFormat
type
Resource type.
string
Expand table
Name
Description
Value
id
Resource ID.
string
name
The name of the resource. This name can be used to access the resource.
string
properties
Properties of the IP configuration profile.
IPConfigurationProfilePropertiesFormat
Expand table
Name
Description
Value
subnet
The reference to the subnet resource to create a container network interface ip configuration.
Subnet
Microsoft.Network/networkProfiles
Expand table
Name
Description
Value
location
Resource location.
string
name
The resource name
string (required)
properties
Network profile properties.
NetworkProfilePropertiesFormat
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
Expand table
Expand table
Expand table
Name
Description
Value
flushConnection
When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation.
bool
securityRules
A collection of security rules of the network security group.
SecurityRule []
Expand table
Expand table
Expand table
Expand table
Expand table
Expand table
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 route.
RoutePropertiesFormat
type
The type of the resource.
string
Expand table
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' (required)
Expand table
Expand table
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 []
Expand table
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 security rule.
SecurityRulePropertiesFormat
type
The type of the resource.
string
Expand table
Name
Description
Value
access
The network traffic is allowed or denied.
'Allow' 'Deny' (required)
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' (required)
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 (required)
protocol
Network protocol this rule applies to.
'*' 'Ah' 'Esp' 'Icmp' 'Tcp' 'Udp' (required)
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[]
Expand table
Name
Description
Value
serviceName
The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).
string
Expand table
ServiceEndpointPolicyDefinition
Expand table
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 service endpoint policy definition.
ServiceEndpointPolicyDefinitionPropertiesFormat
type
The type of the resource.
string
Expand table
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[]
Expand table
Name
Description
Value
contextualServiceEndpointPolicies
A collection of contextual service endpoint policy.
string[]
serviceAlias
The alias indicating if the policy belongs to a service
string
serviceEndpointPolicyDefinitions
A collection of service endpoint policy definitions of the service endpoint policy.
ServiceEndpointPolicyDefinition []
Expand table
Name
Description
Value
locations
A list of locations.
string[]
service
The type of the endpoint service.
string
Expand table
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
type
Resource type.
string
Expand table
Name
Description
Value
addressPrefix
The address prefix for the subnet.
string
addressPrefixes
List of address prefixes for the subnet.
string[]
applicationGatewayIPConfigurations
Application gateway IP configurations of virtual network resource.
ApplicationGatewayIPConfiguration []
defaultOutboundAccess
Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet.
bool
delegations
An array of references to the delegations on the subnet.
Delegation []
ipAllocations
Array of IpAllocation which reference this subnet.
SubResource []
natGateway
Nat gateway associated with this subnet.
SubResource
networkSecurityGroup
The reference to the NetworkSecurityGroup resource.
NetworkSecurityGroup
privateEndpointNetworkPolicies
Enable or Disable apply network policies on private end point in the subnet.
'Disabled' 'Enabled'
privateLinkServiceNetworkPolicies
Enable or Disable apply network policies on private link service in the subnet.
'Disabled' 'Enabled'
routeTable
The reference to the RouteTable resource.
RouteTable
serviceEndpointPolicies
An array of service endpoint policies.
ServiceEndpointPolicy []
serviceEndpoints
An array of service endpoints.
ServiceEndpointPropertiesFormat []
Expand table
Name
Description
Value
id
Resource ID.
string
The following quickstart samples deploy this resource type.
ARM template resource definition
The networkProfiles resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Network/networkProfiles resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkProfiles",
"apiVersion": "2023-05-01",
"name": "string",
"location": "string",
"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" ],
"applicationGatewayIPConfigurations": [
{
"id": "string",
"name": "string",
"properties": {
"subnet": {
"id": "string"
}
}
}
],
"defaultOutboundAccess": "bool",
"delegations": [
{
"id": "string",
"name": "string",
"properties": {
"serviceName": "string"
},
"type": "string"
}
],
"ipAllocations": [
{
"id": "string"
}
],
"natGateway": {
"id": "string"
},
"networkSecurityGroup": {
"id": "string",
"location": "string",
"properties": {
"flushConnection": "bool",
"securityRules": [
{
"id": "string",
"name": "string",
"properties": {
"access": "string",
"description": "string",
"destinationAddressPrefix": "string",
"destinationAddressPrefixes": [ "string" ],
"destinationApplicationSecurityGroups": [
{
"id": "string",
"location": "string",
"properties": {
},
"tags": {
"{customized property}": "string"
}
}
],
"destinationPortRange": "string",
"destinationPortRanges": [ "string" ],
"direction": "string",
"priority": "int",
"protocol": "string",
"sourceAddressPrefix": "string",
"sourceAddressPrefixes": [ "string" ],
"sourceApplicationSecurityGroups": [
{
"id": "string",
"location": "string",
"properties": {
},
"tags": {
"{customized property}": "string"
}
}
],
"sourcePortRange": "string",
"sourcePortRanges": [ "string" ]
},
"type": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
},
"privateEndpointNetworkPolicies": "string",
"privateLinkServiceNetworkPolicies": "string",
"routeTable": {
"id": "string",
"location": "string",
"properties": {
"disableBgpRoutePropagation": "bool",
"routes": [
{
"id": "string",
"name": "string",
"properties": {
"addressPrefix": "string",
"nextHopIpAddress": "string",
"nextHopType": "string"
},
"type": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
},
"serviceEndpointPolicies": [
{
"id": "string",
"location": "string",
"properties": {
"contextualServiceEndpointPolicies": [ "string" ],
"serviceAlias": "string",
"serviceEndpointPolicyDefinitions": [
{
"id": "string",
"name": "string",
"properties": {
"description": "string",
"service": "string",
"serviceResources": [ "string" ]
},
"type": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
],
"serviceEndpoints": [
{
"locations": [ "string" ],
"service": "string"
}
]
},
"type": "string"
}
}
}
]
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
ApplicationGatewayIPConfiguration
Expand table
Name
Description
Value
id
Resource ID.
string
name
Name of the IP configuration that is unique within an Application Gateway.
string
properties
Properties of the application gateway IP configuration.
ApplicationGatewayIPConfigurationPropertiesFormat
ApplicationGatewayIPConfigurationPropertiesFormat
Expand table
Name
Description
Value
subnet
Reference to the subnet resource. A subnet from where application gateway gets its private address.
SubResource
Expand table
ApplicationSecurityGroupPropertiesFormat
Expand table
ContainerNetworkInterfaceConfiguration
Expand table
ContainerNetworkInterfaceConfigurationPropertiesFormat
Expand table
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 []
Expand table
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 the subnet.
ServiceDelegationPropertiesFormat
type
Resource type.
string
Expand table
Name
Description
Value
id
Resource ID.
string
name
The name of the resource. This name can be used to access the resource.
string
properties
Properties of the IP configuration profile.
IPConfigurationProfilePropertiesFormat
IPConfigurationProfilePropertiesFormat
Expand table
Name
Description
Value
subnet
The reference to the subnet resource to create a container network interface ip configuration.
Subnet
Microsoft.Network/networkProfiles
Expand table
Name
Description
Value
apiVersion
The api version
'2023-05-01'
location
Resource location.
string
name
The resource name
string (required)
properties
Network profile properties.
NetworkProfilePropertiesFormat
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
type
The resource type
'Microsoft.Network/networkProfiles'
NetworkProfilePropertiesFormat
Expand table
Expand table
NetworkSecurityGroupPropertiesFormat
Expand table
Name
Description
Value
flushConnection
When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation.
bool
securityRules
A collection of security rules of the network security group.
SecurityRule []
Expand table
Expand table
Expand table
Expand table
Expand table
Expand table
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 route.
RoutePropertiesFormat
type
The type of the resource.
string
Expand table
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' (required)
Expand table
RouteTablePropertiesFormat
Expand table
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 []
Expand table
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 security rule.
SecurityRulePropertiesFormat
type
The type of the resource.
string
SecurityRulePropertiesFormat
Expand table
Name
Description
Value
access
The network traffic is allowed or denied.
'Allow' 'Deny' (required)
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' (required)
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 (required)
protocol
Network protocol this rule applies to.
'*' 'Ah' 'Esp' 'Icmp' 'Tcp' 'Udp' (required)
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[]
ServiceDelegationPropertiesFormat
Expand table
Name
Description
Value
serviceName
The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).
string
Expand table
ServiceEndpointPolicyDefinition
Expand table
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 service endpoint policy definition.
ServiceEndpointPolicyDefinitionPropertiesFormat
type
The type of the resource.
string
ServiceEndpointPolicyDefinitionPropertiesFormat
Expand table
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[]
ServiceEndpointPolicyPropertiesFormat
Expand table
Name
Description
Value
contextualServiceEndpointPolicies
A collection of contextual service endpoint policy.
string[]
serviceAlias
The alias indicating if the policy belongs to a service
string
serviceEndpointPolicyDefinitions
A collection of service endpoint policy definitions of the service endpoint policy.
ServiceEndpointPolicyDefinition []
ServiceEndpointPropertiesFormat
Expand table
Name
Description
Value
locations
A list of locations.
string[]
service
The type of the endpoint service.
string
Expand table
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
type
Resource type.
string
Expand table
Name
Description
Value
addressPrefix
The address prefix for the subnet.
string
addressPrefixes
List of address prefixes for the subnet.
string[]
applicationGatewayIPConfigurations
Application gateway IP configurations of virtual network resource.
ApplicationGatewayIPConfiguration []
defaultOutboundAccess
Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet.
bool
delegations
An array of references to the delegations on the subnet.
Delegation []
ipAllocations
Array of IpAllocation which reference this subnet.
SubResource []
natGateway
Nat gateway associated with this subnet.
SubResource
networkSecurityGroup
The reference to the NetworkSecurityGroup resource.
NetworkSecurityGroup
privateEndpointNetworkPolicies
Enable or Disable apply network policies on private end point in the subnet.
'Disabled' 'Enabled'
privateLinkServiceNetworkPolicies
Enable or Disable apply network policies on private link service in the subnet.
'Disabled' 'Enabled'
routeTable
The reference to the RouteTable resource.
RouteTable
serviceEndpointPolicies
An array of service endpoint policies.
ServiceEndpointPolicy []
serviceEndpoints
An array of service endpoints.
ServiceEndpointPropertiesFormat []
Expand table
Name
Description
Value
id
Resource ID.
string
The following quickstart templates deploy this resource type.
Terraform (AzAPI provider) resource definition
The networkProfiles resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Network/networkProfiles resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkProfiles@2023-05-01"
name = "string"
location = "string"
body = jsonencode({
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"
]
applicationGatewayIPConfigurations = [
{
id = "string"
name = "string"
properties = {
subnet = {
id = "string"
}
}
}
]
defaultOutboundAccess = bool
delegations = [
{
id = "string"
name = "string"
properties = {
serviceName = "string"
}
type = "string"
}
]
ipAllocations = [
{
id = "string"
}
]
natGateway = {
id = "string"
}
networkSecurityGroup = {
id = "string"
location = "string"
properties = {
flushConnection = bool
securityRules = [
{
id = "string"
name = "string"
properties = {
access = "string"
description = "string"
destinationAddressPrefix = "string"
destinationAddressPrefixes = [
"string"
]
destinationApplicationSecurityGroups = [
{
id = "string"
location = "string"
properties = {
}
tags = {
{customized property} = "string"
}
}
]
destinationPortRange = "string"
destinationPortRanges = [
"string"
]
direction = "string"
priority = int
protocol = "string"
sourceAddressPrefix = "string"
sourceAddressPrefixes = [
"string"
]
sourceApplicationSecurityGroups = [
{
id = "string"
location = "string"
properties = {
}
tags = {
{customized property} = "string"
}
}
]
sourcePortRange = "string"
sourcePortRanges = [
"string"
]
}
type = "string"
}
]
}
tags = {
{customized property} = "string"
}
}
privateEndpointNetworkPolicies = "string"
privateLinkServiceNetworkPolicies = "string"
routeTable = {
id = "string"
location = "string"
properties = {
disableBgpRoutePropagation = bool
routes = [
{
id = "string"
name = "string"
properties = {
addressPrefix = "string"
nextHopIpAddress = "string"
nextHopType = "string"
}
type = "string"
}
]
}
tags = {
{customized property} = "string"
}
}
serviceEndpointPolicies = [
{
id = "string"
location = "string"
properties = {
contextualServiceEndpointPolicies = [
"string"
]
serviceAlias = "string"
serviceEndpointPolicyDefinitions = [
{
id = "string"
name = "string"
properties = {
description = "string"
service = "string"
serviceResources = [
"string"
]
}
type = "string"
}
]
}
tags = {
{customized property} = "string"
}
}
]
serviceEndpoints = [
{
locations = [
"string"
]
service = "string"
}
]
}
type = "string"
}
}
}
]
}
}
]
}
})
tags = {
{customized property} = "string"
}
}
ApplicationGatewayIPConfiguration
Expand table
Name
Description
Value
id
Resource ID.
string
name
Name of the IP configuration that is unique within an Application Gateway.
string
properties
Properties of the application gateway IP configuration.
ApplicationGatewayIPConfigurationPropertiesFormat
ApplicationGatewayIPConfigurationPropertiesFormat
Expand table
Name
Description
Value
subnet
Reference to the subnet resource. A subnet from where application gateway gets its private address.
SubResource
Expand table
ApplicationSecurityGroupPropertiesFormat
Expand table
ContainerNetworkInterfaceConfiguration
Expand table
ContainerNetworkInterfaceConfigurationPropertiesFormat
Expand table
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 []
Expand table
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 the subnet.
ServiceDelegationPropertiesFormat
type
Resource type.
string
Expand table
Name
Description
Value
id
Resource ID.
string
name
The name of the resource. This name can be used to access the resource.
string
properties
Properties of the IP configuration profile.
IPConfigurationProfilePropertiesFormat
IPConfigurationProfilePropertiesFormat
Expand table
Name
Description
Value
subnet
The reference to the subnet resource to create a container network interface ip configuration.
Subnet
Microsoft.Network/networkProfiles
Expand table
Name
Description
Value
location
Resource location.
string
name
The resource name
string (required)
properties
Network profile properties.
NetworkProfilePropertiesFormat
tags
Resource tags
Dictionary of tag names and values.
type
The resource type
"Microsoft.Network/networkProfiles@2023-05-01"
NetworkProfilePropertiesFormat
Expand table
Expand table
NetworkSecurityGroupPropertiesFormat
Expand table
Name
Description
Value
flushConnection
When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation.
bool
securityRules
A collection of security rules of the network security group.
SecurityRule []
Expand table
Expand table
Expand table
Expand table
Expand table
Expand table
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 route.
RoutePropertiesFormat
type
The type of the resource.
string
Expand table
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' (required)
Expand table
RouteTablePropertiesFormat
Expand table
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 []
Expand table
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 security rule.
SecurityRulePropertiesFormat
type
The type of the resource.
string
SecurityRulePropertiesFormat
Expand table
Name
Description
Value
access
The network traffic is allowed or denied.
'Allow' 'Deny' (required)
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' (required)
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 (required)
protocol
Network protocol this rule applies to.
'*' 'Ah' 'Esp' 'Icmp' 'Tcp' 'Udp' (required)
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[]
ServiceDelegationPropertiesFormat
Expand table
Name
Description
Value
serviceName
The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).
string
Expand table
ServiceEndpointPolicyDefinition
Expand table
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 service endpoint policy definition.
ServiceEndpointPolicyDefinitionPropertiesFormat
type
The type of the resource.
string
ServiceEndpointPolicyDefinitionPropertiesFormat
Expand table
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[]
ServiceEndpointPolicyPropertiesFormat
Expand table
Name
Description
Value
contextualServiceEndpointPolicies
A collection of contextual service endpoint policy.
string[]
serviceAlias
The alias indicating if the policy belongs to a service
string
serviceEndpointPolicyDefinitions
A collection of service endpoint policy definitions of the service endpoint policy.
ServiceEndpointPolicyDefinition []
ServiceEndpointPropertiesFormat
Expand table
Name
Description
Value
locations
A list of locations.
string[]
service
The type of the endpoint service.
string
Expand table
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
type
Resource type.
string
Expand table
Name
Description
Value
addressPrefix
The address prefix for the subnet.
string
addressPrefixes
List of address prefixes for the subnet.
string[]
applicationGatewayIPConfigurations
Application gateway IP configurations of virtual network resource.
ApplicationGatewayIPConfiguration []
defaultOutboundAccess
Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet.
bool
delegations
An array of references to the delegations on the subnet.
Delegation []
ipAllocations
Array of IpAllocation which reference this subnet.
SubResource []
natGateway
Nat gateway associated with this subnet.
SubResource
networkSecurityGroup
The reference to the NetworkSecurityGroup resource.
NetworkSecurityGroup
privateEndpointNetworkPolicies
Enable or Disable apply network policies on private end point in the subnet.
'Disabled' 'Enabled'
privateLinkServiceNetworkPolicies
Enable or Disable apply network policies on private link service in the subnet.
'Disabled' 'Enabled'
routeTable
The reference to the RouteTable resource.
RouteTable
serviceEndpointPolicies
An array of service endpoint policies.
ServiceEndpointPolicy []
serviceEndpoints
An array of service endpoints.
ServiceEndpointPropertiesFormat []
Expand table
Name
Description
Value
id
Resource ID.
string