Share via

CustomIpPrefix interface

Package:
@azure/arm-network

Custom IP prefix resource.

Extends
Resource

Properties

asn

The ASN for CIDR advertising. Should be an integer as string.
authorizationMessage

Authorization message for WAN validation.
childCustomIpPrefixes

The list of all Children for IPv6 /48 CustomIpPrefix. NOTE: This property will not be serialized. It can only be populated by the server.
cidr

The prefix range in CIDR notation. Should include the start address and the prefix length.
commissionedState

The commissioned state of the Custom IP Prefix.
customIpPrefixParent

The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
expressRouteAdvertise

Whether to do express route advertise.
extendedLocation

The extended location of the custom IP prefix.
failedReason

The reason why resource is in failed state. NOTE: This property will not be serialized. It can only be populated by the server.
geo

The Geo for CIDR advertising. Should be an Geo code.
noInternetAdvertise

Whether to Advertise the range to Internet.
prefixType

Type of custom IP prefix. Should be Singular, Parent, or Child.
provisioningState

The provisioning state of the custom IP prefix resource. NOTE: This property will not be serialized. It can only be populated by the server.
publicIpPrefixes

The list of all referenced PublicIpPrefixes. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGuid

The resource GUID property of the custom IP prefix resource. NOTE: This property will not be serialized. It can only be populated by the server.
signedMessage

Signed message for WAN validation.
zones

A list of availability zones denoting the IP allocated for the resource needs to come from.

Inherited Properties

id

Resource ID.
location

Resource location.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

asn

The ASN for CIDR advertising. Should be an integer as string.

asn?: string

Property Value

string

authorizationMessage

Authorization message for WAN validation.

authorizationMessage?: string

Property Value

string

childCustomIpPrefixes

The list of all Children for IPv6 /48 CustomIpPrefix. NOTE: This property will not be serialized. It can only be populated by the server.

childCustomIpPrefixes?: SubResource[]

Property Value

SubResource[]

cidr

The prefix range in CIDR notation. Should include the start address and the prefix length.

cidr?: string

Property Value

string

commissionedState

The commissioned state of the Custom IP Prefix.

commissionedState?: string

Property Value

string

customIpPrefixParent

The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.

customIpPrefixParent?: SubResource

Property Value

SubResource

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

expressRouteAdvertise

Whether to do express route advertise.

expressRouteAdvertise?: boolean

Property Value

boolean

extendedLocation

The extended location of the custom IP prefix.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

failedReason

The reason why resource is in failed state. NOTE: This property will not be serialized. It can only be populated by the server.

failedReason?: string

Property Value

string

geo

The Geo for CIDR advertising. Should be an Geo code.

geo?: string

Property Value

string

noInternetAdvertise

Whether to Advertise the range to Internet.

noInternetAdvertise?: boolean

Property Value

boolean

prefixType

Type of custom IP prefix. Should be Singular, Parent, or Child.

prefixType?: string

Property Value

string

provisioningState

The provisioning state of the custom IP prefix resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicIpPrefixes

The list of all referenced PublicIpPrefixes. NOTE: This property will not be serialized. It can only be populated by the server.

publicIpPrefixes?: SubResource[]

Property Value

SubResource[]

resourceGuid

The resource GUID property of the custom IP prefix resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGuid?: string

Property Value

string

signedMessage

Signed message for WAN validation.

signedMessage?: string

Property Value

string

zones

A list of availability zones denoting the IP allocated for the resource needs to come from.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type