Share via

Microsoft.Network IpAllocations 2023-02-01

  • Article

Bicep resource definition

The IpAllocations resource type can be deployed with operations that target:

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-02-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

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

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

ResourceTags

Name Description Value

ARM template resource definition

The IpAllocations resource type can be deployed with operations that target:

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-02-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

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

Microsoft.Network/IpAllocations

Name Description Value
apiVersion The api version '2023-02-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'

ResourceTags

Name Description Value

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-02-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      allocationTags = {
        {customized property} = "string"
      }
      ipamAllocationId = "string"
      prefix = "string"
      prefixLength = int
      prefixType = "string"
      type = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

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

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@2023-02-01"

ResourceTags

Name Description Value