Microsoft.Network IpAllocations

• Latest
• 2024-07-01
• 2024-05-01
• 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

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@2024-07-01' = {
  location: 'string'
  name: 'string'
  properties: {
    allocationTags: {
      {customized property}: 'string'
    }
    ipamAllocationId: 'string'
    prefix: 'string'
    prefixLength: int
    prefixType: 'string'
    type: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/IpAllocations

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the IpAllocation.	IpAllocationPropertiesFormat
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

IpAllocationPropertiesFormat

Name	Description	Value
allocationTags	IpAllocation tags.	IpAllocationPropertiesFormatAllocationTags
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'

IpAllocationPropertiesFormatAllocationTags

Name	Description	Value

ResourceTags

Name	Description	Value

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": "2024-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "allocationTags": {
      "{customized property}": "string"
    },
    "ipamAllocationId": "string",
    "prefix": "string",
    "prefixLength": "int",
    "prefixType": "string",
    "type": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/IpAllocations

Name	Description	Value
apiVersion	The api version	'2024-07-01'
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the IpAllocation.	IpAllocationPropertiesFormat
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Network/IpAllocations'

IpAllocationPropertiesFormat

Name	Description	Value
allocationTags	IpAllocation tags.	IpAllocationPropertiesFormatAllocationTags
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'

IpAllocationPropertiesFormatAllocationTags

Name	Description	Value

ResourceTags

Name	Description	Value

Usage Examples

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@2024-07-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      allocationTags = {
        {customized property} = "string"
      }
      ipamAllocationId = "string"
      prefix = "string"
      prefixLength = int
      prefixType = "string"
      type = "string"
    }
  }
}

Property Values

Microsoft.Network/IpAllocations

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the IpAllocation.	IpAllocationPropertiesFormat
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/IpAllocations@2024-07-01"

IpAllocationPropertiesFormat

Name	Description	Value
allocationTags	IpAllocation tags.	IpAllocationPropertiesFormatAllocationTags
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'

IpAllocationPropertiesFormatAllocationTags

Name	Description	Value

ResourceTags

Name	Description	Value