The customIpPrefixes resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/customIpPrefixes resource, add the following JSON to your template.
{
"type": "Microsoft.Network/customIpPrefixes",
"apiVersion": "2023-04-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"extendedLocation": {
"name": "string",
"type": "EdgeZone"
},
"properties": {
"asn": "string",
"authorizationMessage": "string",
"cidr": "string",
"commissionedState": "string",
"customIpPrefixParent": {
"id": "string"
},
"expressRouteAdvertise": "bool",
"geo": "string",
"noInternetAdvertise": "bool",
"prefixType": "string",
"signedMessage": "string"
},
"zones": [ "string" ]
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Network/customIpPrefixes' |
apiVersion | The resource api version | '2023-04-01' |
name | The resource name | string (required) |
location | Resource location. | string |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
extendedLocation | The extended location of the custom IP prefix. | ExtendedLocation |
properties | Custom IP prefix properties. | CustomIpPrefixPropertiesFormat |
zones | A list of availability zones denoting the IP allocated for the resource needs to come from. | string[] |
Name | Description | Value |
---|---|---|
name | The name of the extended location. | string |
type | The type of the extended location. | 'EdgeZone' |
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 |
Name | Description | Value |
---|---|---|
id | Resource ID. | string |