Microsoft.Network networkProfiles 2018-12-01
- Latest
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-08-01
Bicep resource definition
The networkProfiles resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkProfiles resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkProfiles@2018-12-01' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
containerNetworkInterfaceConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
containerNetworkInterfaces: [
{
id: 'string'
}
]
ipConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
subnet: {
etag: 'string'
id: 'string'
name: 'string'
properties: {
addressPrefix: 'string'
addressPrefixes: [
'string'
]
delegations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
actions: [
'string'
]
serviceName: 'string'
}
}
]
networkSecurityGroup: {
etag: 'string'
id: 'string'
location: 'string'
properties: {
defaultSecurityRules: [
{
etag: 'string'
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'
provisioningState: 'string'
sourceAddressPrefix: 'string'
sourceAddressPrefixes: [
'string'
]
sourceApplicationSecurityGroups: [
{
id: 'string'
location: 'string'
properties: {}
tags: {
{customized property}: 'string'
}
}
]
sourcePortRange: 'string'
sourcePortRanges: [
'string'
]
}
}
]
provisioningState: 'string'
resourceGuid: 'string'
securityRules: [
{
etag: 'string'
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'
provisioningState: 'string'
sourceAddressPrefix: 'string'
sourceAddressPrefixes: [
'string'
]
sourceApplicationSecurityGroups: [
{
id: 'string'
location: 'string'
properties: {}
tags: {
{customized property}: 'string'
}
}
]
sourcePortRange: 'string'
sourcePortRanges: [
'string'
]
}
}
]
}
tags: {
{customized property}: 'string'
}
}
provisioningState: 'string'
resourceNavigationLinks: [
{
id: 'string'
name: 'string'
properties: {
link: 'string'
linkedResourceType: 'string'
}
}
]
routeTable: {
etag: 'string'
id: 'string'
location: 'string'
properties: {
disableBgpRoutePropagation: bool
provisioningState: 'string'
routes: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
addressPrefix: 'string'
nextHopIpAddress: 'string'
nextHopType: 'string'
provisioningState: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
serviceAssociationLinks: [
{
id: 'string'
name: 'string'
properties: {
link: 'string'
linkedResourceType: 'string'
}
}
]
serviceEndpointPolicies: [
{
etag: 'string'
id: 'string'
location: 'string'
properties: {
serviceEndpointPolicyDefinitions: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
description: 'string'
service: 'string'
serviceResources: [
'string'
]
}
}
]
}
tags: {
{customized property}: 'string'
}
}
]
serviceEndpoints: [
{
locations: [
'string'
]
provisioningState: 'string'
service: 'string'
}
]
}
}
}
}
]
}
}
]
containerNetworkInterfaces: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
container: {
id: 'string'
}
containerNetworkInterfaceConfiguration: {
etag: 'string'
id: 'string'
name: 'string'
properties: {
containerNetworkInterfaces: [
{
id: 'string'
}
]
ipConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
subnet: {
etag: 'string'
id: 'string'
name: 'string'
properties: {
addressPrefix: 'string'
addressPrefixes: [
'string'
]
delegations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
actions: [
'string'
]
serviceName: 'string'
}
}
]
networkSecurityGroup: {
etag: 'string'
id: 'string'
location: 'string'
properties: {
defaultSecurityRules: [
{
etag: 'string'
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'
provisioningState: 'string'
sourceAddressPrefix: 'string'
sourceAddressPrefixes: [
'string'
]
sourceApplicationSecurityGroups: [
{
id: 'string'
location: 'string'
properties: {}
tags: {
{customized property}: 'string'
}
}
]
sourcePortRange: 'string'
sourcePortRanges: [
'string'
]
}
}
]
provisioningState: 'string'
resourceGuid: 'string'
securityRules: [
{
etag: 'string'
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'
provisioningState: 'string'
sourceAddressPrefix: 'string'
sourceAddressPrefixes: [
'string'
]
sourceApplicationSecurityGroups: [
{
id: 'string'
location: 'string'
properties: {}
tags: {
{customized property}: 'string'
}
}
]
sourcePortRange: 'string'
sourcePortRanges: [
'string'
]
}
}
]
}
tags: {
{customized property}: 'string'
}
}
provisioningState: 'string'
resourceNavigationLinks: [
{
id: 'string'
name: 'string'
properties: {
link: 'string'
linkedResourceType: 'string'
}
}
]
routeTable: {
etag: 'string'
id: 'string'
location: 'string'
properties: {
disableBgpRoutePropagation: bool
provisioningState: 'string'
routes: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
addressPrefix: 'string'
nextHopIpAddress: 'string'
nextHopType: 'string'
provisioningState: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
serviceAssociationLinks: [
{
id: 'string'
name: 'string'
properties: {
link: 'string'
linkedResourceType: 'string'
}
}
]
serviceEndpointPolicies: [
{
etag: 'string'
id: 'string'
location: 'string'
properties: {
serviceEndpointPolicyDefinitions: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
description: 'string'
service: 'string'
serviceResources: [
'string'
]
}
}
]
}
tags: {
{customized property}: 'string'
}
}
]
serviceEndpoints: [
{
locations: [
'string'
]
provisioningState: 'string'
service: 'string'
}
]
}
}
}
}
]
}
}
ipConfigurations: [
{
etag: 'string'
name: 'string'
properties: {}
}
]
}
}
]
}
tags: {
{customized property}: 'string'
}
}
Property values
ApplicationSecurityGroup
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the application security group. | ApplicationSecurityGroupPropertiesFormat |
tags | Resource tags. | ResourceTags |
ApplicationSecurityGroupPropertiesFormat
Name | Description | Value |
---|
Container
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
ContainerNetworkInterface
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
name | The name of the resource. This name can be used to access the resource. | string |
properties | Container network interface properties. | ContainerNetworkInterfacePropertiesFormat |
ContainerNetworkInterfaceConfiguration
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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[] |
ContainerNetworkInterfaceIpConfiguration
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
name | The name of the resource. This name can be used to access the resource. | string |
properties | Properties of the container network interface IP configuration. | ContainerNetworkInterfaceIpConfigurationPropertiesFormat |
ContainerNetworkInterfaceIpConfigurationPropertiesFormat
Name | Description | Value |
---|
ContainerNetworkInterfacePropertiesFormat
Name | Description | Value |
---|---|---|
container | Reference to the container to which this container network interface is attached. | Container |
containerNetworkInterfaceConfiguration | Container network interface configuration from which this container network interface is created. | ContainerNetworkInterfaceConfiguration |
ipConfigurations | Reference to the ip configuration on this container nic. | ContainerNetworkInterfaceIpConfiguration[] |
Delegation
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
IPConfigurationProfile
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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
Name | Description | Value |
---|---|---|
subnet | The reference of the subnet resource to create a container network interface ip configuration. | Subnet |
Microsoft.Network/networkProfiles
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
NetworkProfilePropertiesFormat
Name | Description | Value |
---|---|---|
containerNetworkInterfaceConfigurations | List of chid container network interface configurations. | ContainerNetworkInterfaceConfiguration[] |
containerNetworkInterfaces | List of child container network interfaces. | ContainerNetworkInterface[] |
NetworkSecurityGroup
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the network security group | NetworkSecurityGroupPropertiesFormat |
tags | Resource tags. | ResourceTags |
NetworkSecurityGroupPropertiesFormat
Name | Description | Value |
---|---|---|
defaultSecurityRules | The default security rules of network security group. | SecurityRule[] |
provisioningState | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
resourceGuid | The resource GUID property of the network security group resource. | string |
securityRules | A collection of security rules of the network security group. | SecurityRule[] |
ResourceNavigationLink
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
name | Name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
properties | Resource navigation link properties format. | ResourceNavigationLinkFormat |
ResourceNavigationLinkFormat
Name | Description | Value |
---|---|---|
link | Link to the external resource | string |
linkedResourceType | Resource type of the linked resource. | string |
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
Route
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
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. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None' | 'Internet' 'None' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required) |
provisioningState | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
RouteTable
Name | Description | Value |
---|---|---|
etag | Gets a unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the route table. | RouteTablePropertiesFormat |
tags | Resource tags. | ResourceTags |
RouteTablePropertiesFormat
Name | Description | Value |
---|---|---|
disableBgpRoutePropagation | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | bool |
provisioningState | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
routes | Collection of routes contained within a route table. | Route[] |
SecurityRule
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
SecurityRulePropertiesFormat
Name | Description | Value |
---|---|---|
access | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. | '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. Possible values are: 'Inbound' and 'Outbound'. | '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 |
protocol | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. | '*' 'Tcp' 'Udp' (required) |
provisioningState | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
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[] |
ServiceAssociationLink
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
name | Name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
properties | Resource navigation link properties format. | ServiceAssociationLinkPropertiesFormat |
ServiceAssociationLinkPropertiesFormat
Name | Description | Value |
---|---|---|
link | Link to the external resource. | string |
linkedResourceType | Resource type of the linked resource. | string |
ServiceDelegationPropertiesFormat
Name | Description | Value |
---|---|---|
actions | Describes the actions permitted to the service upon delegation | string[] |
serviceName | The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) | string |
ServiceEndpointPolicy
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the service end point policy | ServiceEndpointPolicyPropertiesFormat |
tags | Resource tags. | ResourceTags |
ServiceEndpointPolicyDefinition
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
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[] |
ServiceEndpointPolicyPropertiesFormat
Name | Description | Value |
---|---|---|
serviceEndpointPolicyDefinitions | A collection of service endpoint policy definitions of the service endpoint policy. | ServiceEndpointPolicyDefinition[] |
ServiceEndpointPropertiesFormat
Name | Description | Value |
---|---|---|
locations | A list of locations. | string[] |
provisioningState | The provisioning state of the resource. | string |
service | The type of the endpoint service. | string |
Subnet
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 | Gets an array of references to the delegations on the subnet. | Delegation[] |
networkSecurityGroup | The reference of the NetworkSecurityGroup resource. | NetworkSecurityGroup |
provisioningState | The provisioning state of the resource. | string |
resourceNavigationLinks | Gets an array of references to the external resources using subnet. | ResourceNavigationLink[] |
routeTable | The reference of the RouteTable resource. | RouteTable |
serviceAssociationLinks | Gets an array of references to services injecting into this subnet. | ServiceAssociationLink[] |
serviceEndpointPolicies | An array of service endpoint policies. | ServiceEndpointPolicy[] |
serviceEndpoints | An array of service endpoints. | ServiceEndpointPropertiesFormat[] |
SubResource
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
Quickstart samples
The following quickstart samples deploy this resource type.
Bicep File | Description |
---|---|
Azure Cloud Shell - VNet | This template deploys Azure Cloud Shell resources into an Azure virtual network. |
Azure Container Instances - VNet | Deploy a container instance into an Azure virtual network. |
Front Door with Container Instances and Application Gateway | This template creates a Front Door Standard/Premium with a container group and Application Gateway. |
ARM template resource definition
The networkProfiles resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkProfiles resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkProfiles",
"apiVersion": "2018-12-01",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"containerNetworkInterfaceConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"containerNetworkInterfaces": [
{
"id": "string"
}
],
"ipConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"subnet": {
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"addressPrefix": "string",
"addressPrefixes": [ "string" ],
"delegations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"actions": [ "string" ],
"serviceName": "string"
}
}
],
"networkSecurityGroup": {
"etag": "string",
"id": "string",
"location": "string",
"properties": {
"defaultSecurityRules": [
{
"etag": "string",
"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",
"provisioningState": "string",
"sourceAddressPrefix": "string",
"sourceAddressPrefixes": [ "string" ],
"sourceApplicationSecurityGroups": [
{
"id": "string",
"location": "string",
"properties": {
},
"tags": {
"{customized property}": "string"
}
}
],
"sourcePortRange": "string",
"sourcePortRanges": [ "string" ]
}
}
],
"provisioningState": "string",
"resourceGuid": "string",
"securityRules": [
{
"etag": "string",
"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",
"provisioningState": "string",
"sourceAddressPrefix": "string",
"sourceAddressPrefixes": [ "string" ],
"sourceApplicationSecurityGroups": [
{
"id": "string",
"location": "string",
"properties": {
},
"tags": {
"{customized property}": "string"
}
}
],
"sourcePortRange": "string",
"sourcePortRanges": [ "string" ]
}
}
]
},
"tags": {
"{customized property}": "string"
}
},
"provisioningState": "string",
"resourceNavigationLinks": [
{
"id": "string",
"name": "string",
"properties": {
"link": "string",
"linkedResourceType": "string"
}
}
],
"routeTable": {
"etag": "string",
"id": "string",
"location": "string",
"properties": {
"disableBgpRoutePropagation": "bool",
"provisioningState": "string",
"routes": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"addressPrefix": "string",
"nextHopIpAddress": "string",
"nextHopType": "string",
"provisioningState": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
},
"serviceAssociationLinks": [
{
"id": "string",
"name": "string",
"properties": {
"link": "string",
"linkedResourceType": "string"
}
}
],
"serviceEndpointPolicies": [
{
"etag": "string",
"id": "string",
"location": "string",
"properties": {
"serviceEndpointPolicyDefinitions": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"description": "string",
"service": "string",
"serviceResources": [ "string" ]
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
],
"serviceEndpoints": [
{
"locations": [ "string" ],
"provisioningState": "string",
"service": "string"
}
]
}
}
}
}
]
}
}
],
"containerNetworkInterfaces": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"container": {
"id": "string"
},
"containerNetworkInterfaceConfiguration": {
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"containerNetworkInterfaces": [
{
"id": "string"
}
],
"ipConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"subnet": {
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"addressPrefix": "string",
"addressPrefixes": [ "string" ],
"delegations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"actions": [ "string" ],
"serviceName": "string"
}
}
],
"networkSecurityGroup": {
"etag": "string",
"id": "string",
"location": "string",
"properties": {
"defaultSecurityRules": [
{
"etag": "string",
"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",
"provisioningState": "string",
"sourceAddressPrefix": "string",
"sourceAddressPrefixes": [ "string" ],
"sourceApplicationSecurityGroups": [
{
"id": "string",
"location": "string",
"properties": {
},
"tags": {
"{customized property}": "string"
}
}
],
"sourcePortRange": "string",
"sourcePortRanges": [ "string" ]
}
}
],
"provisioningState": "string",
"resourceGuid": "string",
"securityRules": [
{
"etag": "string",
"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",
"provisioningState": "string",
"sourceAddressPrefix": "string",
"sourceAddressPrefixes": [ "string" ],
"sourceApplicationSecurityGroups": [
{
"id": "string",
"location": "string",
"properties": {
},
"tags": {
"{customized property}": "string"
}
}
],
"sourcePortRange": "string",
"sourcePortRanges": [ "string" ]
}
}
]
},
"tags": {
"{customized property}": "string"
}
},
"provisioningState": "string",
"resourceNavigationLinks": [
{
"id": "string",
"name": "string",
"properties": {
"link": "string",
"linkedResourceType": "string"
}
}
],
"routeTable": {
"etag": "string",
"id": "string",
"location": "string",
"properties": {
"disableBgpRoutePropagation": "bool",
"provisioningState": "string",
"routes": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"addressPrefix": "string",
"nextHopIpAddress": "string",
"nextHopType": "string",
"provisioningState": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
},
"serviceAssociationLinks": [
{
"id": "string",
"name": "string",
"properties": {
"link": "string",
"linkedResourceType": "string"
}
}
],
"serviceEndpointPolicies": [
{
"etag": "string",
"id": "string",
"location": "string",
"properties": {
"serviceEndpointPolicyDefinitions": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"description": "string",
"service": "string",
"serviceResources": [ "string" ]
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
],
"serviceEndpoints": [
{
"locations": [ "string" ],
"provisioningState": "string",
"service": "string"
}
]
}
}
}
}
]
}
},
"ipConfigurations": [
{
"etag": "string",
"name": "string",
"properties": {
}
}
]
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
Property values
ApplicationSecurityGroup
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the application security group. | ApplicationSecurityGroupPropertiesFormat |
tags | Resource tags. | ResourceTags |
ApplicationSecurityGroupPropertiesFormat
Name | Description | Value |
---|
Container
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
ContainerNetworkInterface
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
name | The name of the resource. This name can be used to access the resource. | string |
properties | Container network interface properties. | ContainerNetworkInterfacePropertiesFormat |
ContainerNetworkInterfaceConfiguration
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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[] |
ContainerNetworkInterfaceIpConfiguration
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
name | The name of the resource. This name can be used to access the resource. | string |
properties | Properties of the container network interface IP configuration. | ContainerNetworkInterfaceIpConfigurationPropertiesFormat |
ContainerNetworkInterfaceIpConfigurationPropertiesFormat
Name | Description | Value |
---|
ContainerNetworkInterfacePropertiesFormat
Name | Description | Value |
---|---|---|
container | Reference to the container to which this container network interface is attached. | Container |
containerNetworkInterfaceConfiguration | Container network interface configuration from which this container network interface is created. | ContainerNetworkInterfaceConfiguration |
ipConfigurations | Reference to the ip configuration on this container nic. | ContainerNetworkInterfaceIpConfiguration[] |
Delegation
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
IPConfigurationProfile
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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
Name | Description | Value |
---|---|---|
subnet | The reference of the subnet resource to create a container network interface ip configuration. | Subnet |
Microsoft.Network/networkProfiles
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2018-12-01' |
etag | A unique read-only string that changes whenever the resource is updated. | string |
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
Name | Description | Value |
---|---|---|
containerNetworkInterfaceConfigurations | List of chid container network interface configurations. | ContainerNetworkInterfaceConfiguration[] |
containerNetworkInterfaces | List of child container network interfaces. | ContainerNetworkInterface[] |
NetworkSecurityGroup
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the network security group | NetworkSecurityGroupPropertiesFormat |
tags | Resource tags. | ResourceTags |
NetworkSecurityGroupPropertiesFormat
Name | Description | Value |
---|---|---|
defaultSecurityRules | The default security rules of network security group. | SecurityRule[] |
provisioningState | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
resourceGuid | The resource GUID property of the network security group resource. | string |
securityRules | A collection of security rules of the network security group. | SecurityRule[] |
ResourceNavigationLink
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
name | Name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
properties | Resource navigation link properties format. | ResourceNavigationLinkFormat |
ResourceNavigationLinkFormat
Name | Description | Value |
---|---|---|
link | Link to the external resource | string |
linkedResourceType | Resource type of the linked resource. | string |
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
Route
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
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. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None' | 'Internet' 'None' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required) |
provisioningState | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
RouteTable
Name | Description | Value |
---|---|---|
etag | Gets a unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the route table. | RouteTablePropertiesFormat |
tags | Resource tags. | ResourceTags |
RouteTablePropertiesFormat
Name | Description | Value |
---|---|---|
disableBgpRoutePropagation | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | bool |
provisioningState | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
routes | Collection of routes contained within a route table. | Route[] |
SecurityRule
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
SecurityRulePropertiesFormat
Name | Description | Value |
---|---|---|
access | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. | '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. Possible values are: 'Inbound' and 'Outbound'. | '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 |
protocol | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. | '*' 'Tcp' 'Udp' (required) |
provisioningState | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
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[] |
ServiceAssociationLink
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
name | Name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
properties | Resource navigation link properties format. | ServiceAssociationLinkPropertiesFormat |
ServiceAssociationLinkPropertiesFormat
Name | Description | Value |
---|---|---|
link | Link to the external resource. | string |
linkedResourceType | Resource type of the linked resource. | string |
ServiceDelegationPropertiesFormat
Name | Description | Value |
---|---|---|
actions | Describes the actions permitted to the service upon delegation | string[] |
serviceName | The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) | string |
ServiceEndpointPolicy
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the service end point policy | ServiceEndpointPolicyPropertiesFormat |
tags | Resource tags. | ResourceTags |
ServiceEndpointPolicyDefinition
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
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[] |
ServiceEndpointPolicyPropertiesFormat
Name | Description | Value |
---|---|---|
serviceEndpointPolicyDefinitions | A collection of service endpoint policy definitions of the service endpoint policy. | ServiceEndpointPolicyDefinition[] |
ServiceEndpointPropertiesFormat
Name | Description | Value |
---|---|---|
locations | A list of locations. | string[] |
provisioningState | The provisioning state of the resource. | string |
service | The type of the endpoint service. | string |
Subnet
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 | Gets an array of references to the delegations on the subnet. | Delegation[] |
networkSecurityGroup | The reference of the NetworkSecurityGroup resource. | NetworkSecurityGroup |
provisioningState | The provisioning state of the resource. | string |
resourceNavigationLinks | Gets an array of references to the external resources using subnet. | ResourceNavigationLink[] |
routeTable | The reference of the RouteTable resource. | RouteTable |
serviceAssociationLinks | Gets an array of references to services injecting into this subnet. | ServiceAssociationLink[] |
serviceEndpointPolicies | An array of service endpoint policies. | ServiceEndpointPolicy[] |
serviceEndpoints | An array of service endpoints. | ServiceEndpointPropertiesFormat[] |
SubResource
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Azure Cloud Shell - VNet |
This template deploys Azure Cloud Shell resources into an Azure virtual network. |
Azure Container Instances - VNet |
Deploy a container instance into an Azure virtual network. |
Create a WordPress site in a virtual network |
This template creates a WordPress site on Container Instance in a virtual network. And output a public site FQDN which could access WordPress site. |
Front Door with Container Instances and Application Gateway |
This template creates a Front Door Standard/Premium with a container group and Application Gateway. |
Terraform (AzAPI provider) resource definition
The networkProfiles resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkProfiles resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkProfiles@2018-12-01"
name = "string"
etag = "string"
location = "string"
body = jsonencode({
properties = {
containerNetworkInterfaceConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
containerNetworkInterfaces = [
{
id = "string"
}
]
ipConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
subnet = {
etag = "string"
id = "string"
name = "string"
properties = {
addressPrefix = "string"
addressPrefixes = [
"string"
]
delegations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
actions = [
"string"
]
serviceName = "string"
}
}
]
networkSecurityGroup = {
etag = "string"
id = "string"
location = "string"
properties = {
defaultSecurityRules = [
{
etag = "string"
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"
provisioningState = "string"
sourceAddressPrefix = "string"
sourceAddressPrefixes = [
"string"
]
sourceApplicationSecurityGroups = [
{
id = "string"
location = "string"
properties = {
}
tags = {
{customized property} = "string"
}
}
]
sourcePortRange = "string"
sourcePortRanges = [
"string"
]
}
}
]
provisioningState = "string"
resourceGuid = "string"
securityRules = [
{
etag = "string"
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"
provisioningState = "string"
sourceAddressPrefix = "string"
sourceAddressPrefixes = [
"string"
]
sourceApplicationSecurityGroups = [
{
id = "string"
location = "string"
properties = {
}
tags = {
{customized property} = "string"
}
}
]
sourcePortRange = "string"
sourcePortRanges = [
"string"
]
}
}
]
}
tags = {
{customized property} = "string"
}
}
provisioningState = "string"
resourceNavigationLinks = [
{
id = "string"
name = "string"
properties = {
link = "string"
linkedResourceType = "string"
}
}
]
routeTable = {
etag = "string"
id = "string"
location = "string"
properties = {
disableBgpRoutePropagation = bool
provisioningState = "string"
routes = [
{
etag = "string"
id = "string"
name = "string"
properties = {
addressPrefix = "string"
nextHopIpAddress = "string"
nextHopType = "string"
provisioningState = "string"
}
}
]
}
tags = {
{customized property} = "string"
}
}
serviceAssociationLinks = [
{
id = "string"
name = "string"
properties = {
link = "string"
linkedResourceType = "string"
}
}
]
serviceEndpointPolicies = [
{
etag = "string"
id = "string"
location = "string"
properties = {
serviceEndpointPolicyDefinitions = [
{
etag = "string"
id = "string"
name = "string"
properties = {
description = "string"
service = "string"
serviceResources = [
"string"
]
}
}
]
}
tags = {
{customized property} = "string"
}
}
]
serviceEndpoints = [
{
locations = [
"string"
]
provisioningState = "string"
service = "string"
}
]
}
}
}
}
]
}
}
]
containerNetworkInterfaces = [
{
etag = "string"
id = "string"
name = "string"
properties = {
container = {
id = "string"
}
containerNetworkInterfaceConfiguration = {
etag = "string"
id = "string"
name = "string"
properties = {
containerNetworkInterfaces = [
{
id = "string"
}
]
ipConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
subnet = {
etag = "string"
id = "string"
name = "string"
properties = {
addressPrefix = "string"
addressPrefixes = [
"string"
]
delegations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
actions = [
"string"
]
serviceName = "string"
}
}
]
networkSecurityGroup = {
etag = "string"
id = "string"
location = "string"
properties = {
defaultSecurityRules = [
{
etag = "string"
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"
provisioningState = "string"
sourceAddressPrefix = "string"
sourceAddressPrefixes = [
"string"
]
sourceApplicationSecurityGroups = [
{
id = "string"
location = "string"
properties = {
}
tags = {
{customized property} = "string"
}
}
]
sourcePortRange = "string"
sourcePortRanges = [
"string"
]
}
}
]
provisioningState = "string"
resourceGuid = "string"
securityRules = [
{
etag = "string"
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"
provisioningState = "string"
sourceAddressPrefix = "string"
sourceAddressPrefixes = [
"string"
]
sourceApplicationSecurityGroups = [
{
id = "string"
location = "string"
properties = {
}
tags = {
{customized property} = "string"
}
}
]
sourcePortRange = "string"
sourcePortRanges = [
"string"
]
}
}
]
}
tags = {
{customized property} = "string"
}
}
provisioningState = "string"
resourceNavigationLinks = [
{
id = "string"
name = "string"
properties = {
link = "string"
linkedResourceType = "string"
}
}
]
routeTable = {
etag = "string"
id = "string"
location = "string"
properties = {
disableBgpRoutePropagation = bool
provisioningState = "string"
routes = [
{
etag = "string"
id = "string"
name = "string"
properties = {
addressPrefix = "string"
nextHopIpAddress = "string"
nextHopType = "string"
provisioningState = "string"
}
}
]
}
tags = {
{customized property} = "string"
}
}
serviceAssociationLinks = [
{
id = "string"
name = "string"
properties = {
link = "string"
linkedResourceType = "string"
}
}
]
serviceEndpointPolicies = [
{
etag = "string"
id = "string"
location = "string"
properties = {
serviceEndpointPolicyDefinitions = [
{
etag = "string"
id = "string"
name = "string"
properties = {
description = "string"
service = "string"
serviceResources = [
"string"
]
}
}
]
}
tags = {
{customized property} = "string"
}
}
]
serviceEndpoints = [
{
locations = [
"string"
]
provisioningState = "string"
service = "string"
}
]
}
}
}
}
]
}
}
ipConfigurations = [
{
etag = "string"
name = "string"
properties = {
}
}
]
}
}
]
}
})
tags = {
{customized property} = "string"
}
}
Property values
ApplicationSecurityGroup
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the application security group. | ApplicationSecurityGroupPropertiesFormat |
tags | Resource tags. | ResourceTags |
ApplicationSecurityGroupPropertiesFormat
Name | Description | Value |
---|
Container
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
ContainerNetworkInterface
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
name | The name of the resource. This name can be used to access the resource. | string |
properties | Container network interface properties. | ContainerNetworkInterfacePropertiesFormat |
ContainerNetworkInterfaceConfiguration
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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[] |
ContainerNetworkInterfaceIpConfiguration
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
name | The name of the resource. This name can be used to access the resource. | string |
properties | Properties of the container network interface IP configuration. | ContainerNetworkInterfaceIpConfigurationPropertiesFormat |
ContainerNetworkInterfaceIpConfigurationPropertiesFormat
Name | Description | Value |
---|
ContainerNetworkInterfacePropertiesFormat
Name | Description | Value |
---|---|---|
container | Reference to the container to which this container network interface is attached. | Container |
containerNetworkInterfaceConfiguration | Container network interface configuration from which this container network interface is created. | ContainerNetworkInterfaceConfiguration |
ipConfigurations | Reference to the ip configuration on this container nic. | ContainerNetworkInterfaceIpConfiguration[] |
Delegation
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
IPConfigurationProfile
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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
Name | Description | Value |
---|---|---|
subnet | The reference of the subnet resource to create a container network interface ip configuration. | Subnet |
Microsoft.Network/networkProfiles
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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@2018-12-01" |
NetworkProfilePropertiesFormat
Name | Description | Value |
---|---|---|
containerNetworkInterfaceConfigurations | List of chid container network interface configurations. | ContainerNetworkInterfaceConfiguration[] |
containerNetworkInterfaces | List of child container network interfaces. | ContainerNetworkInterface[] |
NetworkSecurityGroup
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the network security group | NetworkSecurityGroupPropertiesFormat |
tags | Resource tags. | ResourceTags |
NetworkSecurityGroupPropertiesFormat
Name | Description | Value |
---|---|---|
defaultSecurityRules | The default security rules of network security group. | SecurityRule[] |
provisioningState | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
resourceGuid | The resource GUID property of the network security group resource. | string |
securityRules | A collection of security rules of the network security group. | SecurityRule[] |
ResourceNavigationLink
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
name | Name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
properties | Resource navigation link properties format. | ResourceNavigationLinkFormat |
ResourceNavigationLinkFormat
Name | Description | Value |
---|---|---|
link | Link to the external resource | string |
linkedResourceType | Resource type of the linked resource. | string |
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
ResourceTags
Name | Description | Value |
---|
Route
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
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. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None' | 'Internet' 'None' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required) |
provisioningState | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
RouteTable
Name | Description | Value |
---|---|---|
etag | Gets a unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the route table. | RouteTablePropertiesFormat |
tags | Resource tags. | ResourceTags |
RouteTablePropertiesFormat
Name | Description | Value |
---|---|---|
disableBgpRoutePropagation | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | bool |
provisioningState | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
routes | Collection of routes contained within a route table. | Route[] |
SecurityRule
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
SecurityRulePropertiesFormat
Name | Description | Value |
---|---|---|
access | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. | '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. Possible values are: 'Inbound' and 'Outbound'. | '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 |
protocol | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. | '*' 'Tcp' 'Udp' (required) |
provisioningState | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
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[] |
ServiceAssociationLink
Name | Description | Value |
---|---|---|
id | Resource ID. | string |
name | Name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
properties | Resource navigation link properties format. | ServiceAssociationLinkPropertiesFormat |
ServiceAssociationLinkPropertiesFormat
Name | Description | Value |
---|---|---|
link | Link to the external resource. | string |
linkedResourceType | Resource type of the linked resource. | string |
ServiceDelegationPropertiesFormat
Name | Description | Value |
---|---|---|
actions | Describes the actions permitted to the service upon delegation | string[] |
serviceName | The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) | string |
ServiceEndpointPolicy
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
id | Resource ID. | string |
location | Resource location. | string |
properties | Properties of the service end point policy | ServiceEndpointPolicyPropertiesFormat |
tags | Resource tags. | ResourceTags |
ServiceEndpointPolicyDefinition
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 |
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[] |
ServiceEndpointPolicyPropertiesFormat
Name | Description | Value |
---|---|---|
serviceEndpointPolicyDefinitions | A collection of service endpoint policy definitions of the service endpoint policy. | ServiceEndpointPolicyDefinition[] |
ServiceEndpointPropertiesFormat
Name | Description | Value |
---|---|---|
locations | A list of locations. | string[] |
provisioningState | The provisioning state of the resource. | string |
service | The type of the endpoint service. | string |
Subnet
Name | Description | Value |
---|---|---|
etag | A unique read-only string that changes whenever the resource is updated. | string |
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 | Gets an array of references to the delegations on the subnet. | Delegation[] |
networkSecurityGroup | The reference of the NetworkSecurityGroup resource. | NetworkSecurityGroup |
provisioningState | The provisioning state of the resource. | string |
resourceNavigationLinks | Gets an array of references to the external resources using subnet. | ResourceNavigationLink[] |
routeTable | The reference of the RouteTable resource. | RouteTable |
serviceAssociationLinks | Gets an array of references to services injecting into this subnet. | ServiceAssociationLink[] |
serviceEndpointPolicies | An array of service endpoint policies. | ServiceEndpointPolicy[] |
serviceEndpoints | An array of service endpoints. | ServiceEndpointPropertiesFormat[] |
SubResource
Name | Description | Value |
---|---|---|
id | Resource ID. | string |