Microsoft.Network IpAllocations 2023-04-01
Bicep resource definition
The IpAllocations 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/IpAllocations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/IpAllocations@2023-04-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
allocationTags: {}
ipamAllocationId: 'string'
prefix: 'string'
prefixLength: int
prefixType: 'string'
type: 'string'
}
}
Property values
IpAllocations
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
location | Resource location. | string |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
properties | Properties of the IpAllocation. | IpAllocationPropertiesFormat |
IpAllocationPropertiesFormat
Name | Description | Value |
---|---|---|
allocationTags | IpAllocation tags. | object |
ipamAllocationId | The IPAM allocation ID. | string |
prefix | The address prefix for the IpAllocation. | string |
prefixLength | The address prefix length for the IpAllocation. | int |
prefixType | The address prefix Type for the IpAllocation. | 'IPv4' 'IPv6' |
type | The type for the IpAllocation. | 'Hypernet' 'Undefined' |
ARM template resource definition
The IpAllocations 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/IpAllocations resource, add the following JSON to your template.
{
"type": "Microsoft.Network/IpAllocations",
"apiVersion": "2023-04-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"allocationTags": {},
"ipamAllocationId": "string",
"prefix": "string",
"prefixLength": "int",
"prefixType": "string",
"type": "string"
}
}
Property values
IpAllocations
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Network/IpAllocations' |
apiVersion | The resource api version | '2023-04-01' |
name | The resource name | string (required) |
location | Resource location. | string |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
properties | Properties of the IpAllocation. | IpAllocationPropertiesFormat |
IpAllocationPropertiesFormat
Name | Description | Value |
---|---|---|
allocationTags | IpAllocation tags. | object |
ipamAllocationId | The IPAM allocation ID. | string |
prefix | The address prefix for the IpAllocation. | string |
prefixLength | The address prefix length for the IpAllocation. | int |
prefixType | The address prefix Type for the IpAllocation. | 'IPv4' 'IPv6' |
type | The type for the IpAllocation. | 'Hypernet' 'Undefined' |
Terraform (AzAPI provider) resource definition
The IpAllocations 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/IpAllocations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/IpAllocations@2023-04-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
allocationTags = {}
ipamAllocationId = "string"
prefix = "string"
prefixLength = int
prefixType = "string"
type = "string"
}
})
}
Property values
IpAllocations
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.Network/IpAllocations@2023-04-01" |
name | The resource name | string (required) |
location | Resource location. | string |
parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
tags | Resource tags. | Dictionary of tag names and values. |
properties | Properties of the IpAllocation. | IpAllocationPropertiesFormat |
IpAllocationPropertiesFormat
Name | Description | Value |
---|---|---|
allocationTags | IpAllocation tags. | object |
ipamAllocationId | The IPAM allocation ID. | string |
prefix | The address prefix for the IpAllocation. | string |
prefixLength | The address prefix length for the IpAllocation. | int |
prefixType | The address prefix Type for the IpAllocation. | "IPv4" "IPv6" |
type | The type for the IpAllocation. | "Hypernet" "Undefined" |