CustomIpPrefixInner Class

public final class CustomIpPrefixInner
extends Resource

Custom IP prefix resource.

Constructor Summary

Constructor Description
CustomIpPrefixInner()

Creates an instance of CustomIpPrefixInner class.

Method Summary

Modifier and Type Method and Description
String asn()

Get the asn property: The ASN for CIDR advertising.

String authorizationMessage()

Get the authorizationMessage property: Authorization message for WAN validation.

List<SubResource> childCustomIpPrefixes()

Get the childCustomIpPrefixes property: The list of all Children for IPv6 /48 CustomIpPrefix.

String cidr()

Get the cidr property: The prefix range in CIDR notation.

CommissionedState commissionedState()

Get the commissionedState property: The commissioned state of the Custom IP Prefix.

SubResource customIpPrefixParent()

Get the customIpPrefixParent property: The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.

String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Boolean expressRouteAdvertise()

Get the expressRouteAdvertise property: Whether to do express route advertise.

ExtendedLocation extendedLocation()

Get the extendedLocation property: The extended location of the custom IP prefix.

String failedReason()

Get the failedReason property: The reason why resource is in failed state.

static CustomIpPrefixInner fromJson(JsonReader jsonReader)

Reads an instance of CustomIpPrefixInner from the JsonReader.

Geo geo()

Get the geo property: The Geo for CIDR advertising.

String id()

Get the id property: Resource ID.

String name()

Get the name property: The name of the resource.

Boolean noInternetAdvertise()

Get the noInternetAdvertise property: Whether to Advertise the range to Internet.

CustomIpPrefixType prefixType()

Get the prefixType property: Type of custom IP prefix.

ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the custom IP prefix resource.

List<SubResource> publicIpPrefixes()

Get the publicIpPrefixes property: The list of all referenced PublicIpPrefixes.

String resourceGuid()

Get the resourceGuid property: The resource GUID property of the custom IP prefix resource.

String signedMessage()

Get the signedMessage property: Signed message for WAN validation.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

CustomIpPrefixInner withAsn(String asn)

Set the asn property: The ASN for CIDR advertising.

CustomIpPrefixInner withAuthorizationMessage(String authorizationMessage)

Set the authorizationMessage property: Authorization message for WAN validation.

CustomIpPrefixInner withCidr(String cidr)

Set the cidr property: The prefix range in CIDR notation.

CustomIpPrefixInner withCommissionedState(CommissionedState commissionedState)

Set the commissionedState property: The commissioned state of the Custom IP Prefix.

CustomIpPrefixInner withCustomIpPrefixParent(SubResource customIpPrefixParent)

Set the customIpPrefixParent property: The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.

CustomIpPrefixInner withExpressRouteAdvertise(Boolean expressRouteAdvertise)

Set the expressRouteAdvertise property: Whether to do express route advertise.

CustomIpPrefixInner withExtendedLocation(ExtendedLocation extendedLocation)

Set the extendedLocation property: The extended location of the custom IP prefix.

CustomIpPrefixInner withGeo(Geo geo)

Set the geo property: The Geo for CIDR advertising.

CustomIpPrefixInner withId(String id)

Set the id property: Resource ID.

CustomIpPrefixInner withLocation(String location)
CustomIpPrefixInner withNoInternetAdvertise(Boolean noInternetAdvertise)

Set the noInternetAdvertise property: Whether to Advertise the range to Internet.

CustomIpPrefixInner withPrefixType(CustomIpPrefixType prefixType)

Set the prefixType property: Type of custom IP prefix.

CustomIpPrefixInner withSignedMessage(String signedMessage)

Set the signedMessage property: Signed message for WAN validation.

CustomIpPrefixInner withTags(Map<String,String> tags)
CustomIpPrefixInner withZones(List<String> zones)

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

List<String> zones()

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

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

CustomIpPrefixInner

public CustomIpPrefixInner()

Creates an instance of CustomIpPrefixInner class.

Method Details

asn

public String asn()

Get the asn property: The ASN for CIDR advertising. Should be an integer as string.

Returns:

the asn value.

authorizationMessage

public String authorizationMessage()

Get the authorizationMessage property: Authorization message for WAN validation.

Returns:

the authorizationMessage value.

childCustomIpPrefixes

public List childCustomIpPrefixes()

Get the childCustomIpPrefixes property: The list of all Children for IPv6 /48 CustomIpPrefix.

Returns:

the childCustomIpPrefixes value.

cidr

public String cidr()

Get the cidr property: The prefix range in CIDR notation. Should include the start address and the prefix length.

Returns:

the cidr value.

commissionedState

public CommissionedState commissionedState()

Get the commissionedState property: The commissioned state of the Custom IP Prefix.

Returns:

the commissionedState value.

customIpPrefixParent

public SubResource customIpPrefixParent()

Get the customIpPrefixParent property: The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.

Returns:

the customIpPrefixParent value.

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag value.

expressRouteAdvertise

public Boolean expressRouteAdvertise()

Get the expressRouteAdvertise property: Whether to do express route advertise.

Returns:

the expressRouteAdvertise value.

extendedLocation

public ExtendedLocation extendedLocation()

Get the extendedLocation property: The extended location of the custom IP prefix.

Returns:

the extendedLocation value.

failedReason

public String failedReason()

Get the failedReason property: The reason why resource is in failed state.

Returns:

the failedReason value.

fromJson

public static CustomIpPrefixInner fromJson(JsonReader jsonReader)

Reads an instance of CustomIpPrefixInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CustomIpPrefixInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

geo

public Geo geo()

Get the geo property: The Geo for CIDR advertising. Should be an Geo code.

Returns:

the geo value.

id

public String id()

Get the id property: Resource ID.

Overrides:

CustomIpPrefixInner.id()

Returns:

the id value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

CustomIpPrefixInner.name()

Returns:

the name value.

noInternetAdvertise

public Boolean noInternetAdvertise()

Get the noInternetAdvertise property: Whether to Advertise the range to Internet.

Returns:

the noInternetAdvertise value.

prefixType

public CustomIpPrefixType prefixType()

Get the prefixType property: Type of custom IP prefix. Should be Singular, Parent, or Child.

Returns:

the prefixType value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the custom IP prefix resource.

Returns:

the provisioningState value.

publicIpPrefixes

public List publicIpPrefixes()

Get the publicIpPrefixes property: The list of all referenced PublicIpPrefixes.

Returns:

the publicIpPrefixes value.

resourceGuid

public String resourceGuid()

Get the resourceGuid property: The resource GUID property of the custom IP prefix resource.

Returns:

the resourceGuid value.

signedMessage

public String signedMessage()

Get the signedMessage property: Signed message for WAN validation.

Returns:

the signedMessage value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

CustomIpPrefixInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

CustomIpPrefixInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAsn

public CustomIpPrefixInner withAsn(String asn)

Set the asn property: The ASN for CIDR advertising. Should be an integer as string.

Parameters:

asn - the asn value to set.

Returns:

the CustomIpPrefixInner object itself.

withAuthorizationMessage

public CustomIpPrefixInner withAuthorizationMessage(String authorizationMessage)

Set the authorizationMessage property: Authorization message for WAN validation.

Parameters:

authorizationMessage - the authorizationMessage value to set.

Returns:

the CustomIpPrefixInner object itself.

withCidr

public CustomIpPrefixInner withCidr(String cidr)

Set the cidr property: The prefix range in CIDR notation. Should include the start address and the prefix length.

Parameters:

cidr - the cidr value to set.

Returns:

the CustomIpPrefixInner object itself.

withCommissionedState

public CustomIpPrefixInner withCommissionedState(CommissionedState commissionedState)

Set the commissionedState property: The commissioned state of the Custom IP Prefix.

Parameters:

commissionedState - the commissionedState value to set.

Returns:

the CustomIpPrefixInner object itself.

withCustomIpPrefixParent

public CustomIpPrefixInner withCustomIpPrefixParent(SubResource customIpPrefixParent)

Set the customIpPrefixParent property: The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.

Parameters:

customIpPrefixParent - the customIpPrefixParent value to set.

Returns:

the CustomIpPrefixInner object itself.

withExpressRouteAdvertise

public CustomIpPrefixInner withExpressRouteAdvertise(Boolean expressRouteAdvertise)

Set the expressRouteAdvertise property: Whether to do express route advertise.

Parameters:

expressRouteAdvertise - the expressRouteAdvertise value to set.

Returns:

the CustomIpPrefixInner object itself.

withExtendedLocation

public CustomIpPrefixInner withExtendedLocation(ExtendedLocation extendedLocation)

Set the extendedLocation property: The extended location of the custom IP prefix.

Parameters:

extendedLocation - the extendedLocation value to set.

Returns:

the CustomIpPrefixInner object itself.

withGeo

public CustomIpPrefixInner withGeo(Geo geo)

Set the geo property: The Geo for CIDR advertising. Should be an Geo code.

Parameters:

geo - the geo value to set.

Returns:

the CustomIpPrefixInner object itself.

withId

public CustomIpPrefixInner withId(String id)

Set the id property: Resource ID.

Parameters:

id - the id value to set.

Returns:

the CustomIpPrefixInner object itself.

withLocation

public CustomIpPrefixInner withLocation(String location)

Overrides:

CustomIpPrefixInner.withLocation(String location)

Parameters:

location

withNoInternetAdvertise

public CustomIpPrefixInner withNoInternetAdvertise(Boolean noInternetAdvertise)

Set the noInternetAdvertise property: Whether to Advertise the range to Internet.

Parameters:

noInternetAdvertise - the noInternetAdvertise value to set.

Returns:

the CustomIpPrefixInner object itself.

withPrefixType

public CustomIpPrefixInner withPrefixType(CustomIpPrefixType prefixType)

Set the prefixType property: Type of custom IP prefix. Should be Singular, Parent, or Child.

Parameters:

prefixType - the prefixType value to set.

Returns:

the CustomIpPrefixInner object itself.

withSignedMessage

public CustomIpPrefixInner withSignedMessage(String signedMessage)

Set the signedMessage property: Signed message for WAN validation.

Parameters:

signedMessage - the signedMessage value to set.

Returns:

the CustomIpPrefixInner object itself.

withTags

public CustomIpPrefixInner withTags(Map tags)

Overrides:

CustomIpPrefixInner.withTags(Map<String,String> tags)

Parameters:

tags

withZones

public CustomIpPrefixInner withZones(List zones)

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

Parameters:

zones - the zones value to set.

Returns:

the CustomIpPrefixInner object itself.

zones

public List zones()

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

Returns:

the zones value.

Applies to