Share via

Microsoft.Network customIpPrefixes 2020-07-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/customIpPrefixes@2020-07-01' = {
  scope: resourceSymbolicName or scope
  ___location: 'string'
  name: 'string'
  properties: {
    cidr: 'string'
    commissionedState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property Values

Microsoft.Network/customIpPrefixes

Name Description Value
___location Resource ___location. string
name The resource name string (required)
properties Custom IP prefix properties. CustomIpPrefixPropertiesFormat
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.
tags Resource tags Dictionary of tag names and values. See Tags in templates
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

CustomIpPrefixPropertiesFormat

Name Description Value
cidr The prefix range in CIDR notation. Should include the start address and the prefix length. string
commissionedState The commissioned state of the Custom IP Prefix. 'Commissioned'
'Commissioning'
'Decommissioning'
'Deprovisioning'
'Provisioned'
'Provisioning'

ResourceTags

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.Network/customIpPrefixes",
  "apiVersion": "2020-07-01",
  "name": "string",
  "___location": "string",
  "properties": {
    "cidr": "string",
    "commissionedState": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

Microsoft.Network/customIpPrefixes

Name Description Value
apiVersion The api version '2020-07-01'
___location Resource ___location. string
name The resource name string (required)
properties Custom IP prefix properties. CustomIpPrefixPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/customIpPrefixes'
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

CustomIpPrefixPropertiesFormat

Name Description Value
cidr The prefix range in CIDR notation. Should include the start address and the prefix length. string
commissionedState The commissioned state of the Custom IP Prefix. 'Commissioned'
'Commissioning'
'Decommissioning'
'Deprovisioning'
'Provisioned'
'Provisioning'

ResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/customIpPrefixes@2020-07-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      cidr = "string"
      commissionedState = "string"
    }
    zones = [
      "string"
    ]
  }
}

Property Values

Microsoft.Network/customIpPrefixes

Name Description Value
___location Resource ___location. string
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties Custom IP prefix properties. CustomIpPrefixPropertiesFormat
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/customIpPrefixes@2020-07-01"
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

CustomIpPrefixPropertiesFormat

Name Description Value
cidr The prefix range in CIDR notation. Should include the start address and the prefix length. string
commissionedState The commissioned state of the Custom IP Prefix. 'Commissioned'
'Commissioning'
'Decommissioning'
'Deprovisioning'
'Provisioned'
'Provisioning'

ResourceTags

Name Description Value