Share via

CustomIPPrefix Class

Definition

Namespace:
Azure.Provisioning.Network
Assembly:
Azure.Provisioning.Network.dll
Package:
Azure.Provisioning.Network v1.1.0-beta.2
Source:
CustomIPPrefix.cs

CustomIPPrefix.

public class CustomIPPrefix : Azure.Provisioning.Primitives.ProvisionableResource
type CustomIPPrefix = class
    inherit ProvisionableResource
Public Class CustomIPPrefix
Inherits ProvisionableResource
Inheritance
Object
Provisionable
ProvisionableConstruct
NamedProvisionableConstruct
ProvisionableResource
CustomIPPrefix

Constructors

Name Description
CustomIPPrefix(String, String)

Creates a new CustomIPPrefix.

Properties

Name Description
Asn

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

Authorization message for WAN validation.
BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
BicepMetadata

Gets the Bicep metadata for this resource, including decorators and conditions.

(Inherited from ProvisionableResource)
ChildCustomIPPrefixList

The list of all Children for IPv6 /48 CustomIpPrefix.
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.
DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
ETag

A unique read-only string that changes whenever the resource is updated.
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.
Geo

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

Resource ID.
IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
Location

Resource location.
Name

The name of the custom IP prefix.
NoInternetAdvertise

Whether to Advertise the range to Internet.
ParentCustomIPPrefixId

Gets or sets Id.
PrefixType

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

The provisioning state of the custom IP prefix resource.
PublicIPPrefixes

The list of all referenced PublicIpPrefixes.
ResourceGuid

The resource GUID property of the custom IP prefix resource.
ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
SignedMessage

Signed message for WAN validation.
Tags

Resource tags.
Zones

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

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of CustomIPPrefix.
DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing CustomIPPrefix.
GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to