Share via

Microsoft.Network customIpPrefixes

  • Article

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@2024-05-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    asn: 'string'
    authorizationMessage: 'string'
    cidr: 'string'
    commissionedState: 'string'
    customIpPrefixParent: {
      id: 'string'
    }
    expressRouteAdvertise: bool
    geo: 'string'
    noInternetAdvertise: bool
    prefixType: 'string'
    signedMessage: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property Values

CustomIpPrefixPropertiesFormat

Name Description Value
asn The ASN for CIDR advertising. Should be an integer as string. string
authorizationMessage Authorization message for WAN validation. string
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'
'CommissionedNoInternetAdvertise'
'Commissioning'
'Decommissioning'
'Deprovisioned'
'Deprovisioning'
'Provisioned'
'Provisioning'
customIpPrefixParent The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix. SubResource
expressRouteAdvertise Whether to do express route advertise. bool
geo The Geo for CIDR advertising. Should be an Geo code. 'AFRI'
'APAC'
'AQ'
'EURO'
'GLOBAL'
'LATAM'
'ME'
'NAM'
'OCEANIA'
noInternetAdvertise Whether to Advertise the range to Internet. bool
prefixType Type of custom IP prefix. Should be Singular, Parent, or Child. 'Child'
'Parent'
'Singular'
signedMessage Signed message for WAN validation. string

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'EdgeZone'

Microsoft.Network/customIpPrefixes

Name Description Value
extendedLocation The extended location of the custom IP prefix. ExtendedLocation
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
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

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": "2024-05-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "asn": "string",
    "authorizationMessage": "string",
    "cidr": "string",
    "commissionedState": "string",
    "customIpPrefixParent": {
      "id": "string"
    },
    "expressRouteAdvertise": "bool",
    "geo": "string",
    "noInternetAdvertise": "bool",
    "prefixType": "string",
    "signedMessage": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

CustomIpPrefixPropertiesFormat

Name Description Value
asn The ASN for CIDR advertising. Should be an integer as string. string
authorizationMessage Authorization message for WAN validation. string
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'
'CommissionedNoInternetAdvertise'
'Commissioning'
'Decommissioning'
'Deprovisioned'
'Deprovisioning'
'Provisioned'
'Provisioning'
customIpPrefixParent The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix. SubResource
expressRouteAdvertise Whether to do express route advertise. bool
geo The Geo for CIDR advertising. Should be an Geo code. 'AFRI'
'APAC'
'AQ'
'EURO'
'GLOBAL'
'LATAM'
'ME'
'NAM'
'OCEANIA'
noInternetAdvertise Whether to Advertise the range to Internet. bool
prefixType Type of custom IP prefix. Should be Singular, Parent, or Child. 'Child'
'Parent'
'Singular'
signedMessage Signed message for WAN validation. string

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'EdgeZone'

Microsoft.Network/customIpPrefixes

Name Description Value
apiVersion The api version '2024-05-01'
extendedLocation The extended location of the custom IP prefix. ExtendedLocation
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[]

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/customIpPrefixes@2024-05-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      asn = "string"
      authorizationMessage = "string"
      cidr = "string"
      commissionedState = "string"
      customIpPrefixParent = {
        id = "string"
      }
      expressRouteAdvertise = bool
      geo = "string"
      noInternetAdvertise = bool
      prefixType = "string"
      signedMessage = "string"
    }
    zones = [
      "string"
    ]
  }
}

Property Values

CustomIpPrefixPropertiesFormat

Name Description Value
asn The ASN for CIDR advertising. Should be an integer as string. string
authorizationMessage Authorization message for WAN validation. string
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'
'CommissionedNoInternetAdvertise'
'Commissioning'
'Decommissioning'
'Deprovisioned'
'Deprovisioning'
'Provisioned'
'Provisioning'
customIpPrefixParent The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix. SubResource
expressRouteAdvertise Whether to do express route advertise. bool
geo The Geo for CIDR advertising. Should be an Geo code. 'AFRI'
'APAC'
'AQ'
'EURO'
'GLOBAL'
'LATAM'
'ME'
'NAM'
'OCEANIA'
noInternetAdvertise Whether to Advertise the range to Internet. bool
prefixType Type of custom IP prefix. Should be Singular, Parent, or Child. 'Child'
'Parent'
'Singular'
signedMessage Signed message for WAN validation. string

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'EdgeZone'

Microsoft.Network/customIpPrefixes

Name Description Value
extendedLocation The extended location of the custom IP prefix. ExtendedLocation
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.
type The resource type "Microsoft.Network/customIpPrefixes@2024-05-01"
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string