Share via

Microsoft.Network networkManagers/ipamPools 2024-01-01-preview

Bicep resource definition

The networkManagers/ipamPools 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/networkManagers/ipamPools resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/networkManagers/ipamPools@2024-01-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    addressPrefixes: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    parentPoolName: 'string'
    provisioningState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/networkManagers/ipamPools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: networkManagers
properties Properties of IpamPool resource properties which are specific to the Pool resource. IpamPoolProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

CommonTrackedResourceTags

Name Description Value

IpamPoolProperties

Name Description Value
addressPrefixes List of IP address prefixes of the resource. string[] (required)
description string
displayName String representing a friendly name for the resource. string
parentPoolName String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. string
provisioningState Provisioning states of a resource. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

ARM template resource definition

The networkManagers/ipamPools 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/networkManagers/ipamPools resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/networkManagers/ipamPools",
  "apiVersion": "2024-01-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "addressPrefixes": [ "string" ],
    "description": "string",
    "displayName": "string",
    "parentPoolName": "string",
    "provisioningState": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/networkManagers/ipamPools

Name Description Value
apiVersion The api version '2024-01-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]*$ (required)
properties Properties of IpamPool resource properties which are specific to the Pool resource. IpamPoolProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/networkManagers/ipamPools'

CommonTrackedResourceTags

Name Description Value

IpamPoolProperties

Name Description Value
addressPrefixes List of IP address prefixes of the resource. string[] (required)
description string
displayName String representing a friendly name for the resource. string
parentPoolName String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. string
provisioningState Provisioning states of a resource. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

Usage Examples

Terraform (AzAPI provider) resource definition

The networkManagers/ipamPools 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/networkManagers/ipamPools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkManagers/ipamPools@2024-01-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      addressPrefixes = [
        "string"
      ]
      description = "string"
      displayName = "string"
      parentPoolName = "string"
      provisioningState = "string"
    }
  }
}

Property Values

Microsoft.Network/networkManagers/ipamPools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: networkManagers
properties Properties of IpamPool resource properties which are specific to the Pool resource. IpamPoolProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/networkManagers/ipamPools@2024-01-01-preview"

CommonTrackedResourceTags

Name Description Value

IpamPoolProperties

Name Description Value
addressPrefixes List of IP address prefixes of the resource. string[] (required)
description string
displayName String representing a friendly name for the resource. string
parentPoolName String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. string
provisioningState Provisioning states of a resource. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'