CustomIpPrefix Class

Custom IP prefix resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.network.models._models_py3.Resource

CustomIpPrefix

Constructor

CustomIpPrefix(*, id: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, zones: List[str] | None = None, asn: str | None = None, cidr: str | None = None, signed_message: str | None = None, authorization_message: str | None = None, custom_ip_prefix_parent: _models.SubResource | None = None, commissioned_state: str | _models.CommissionedState | None = None, express_route_advertise: bool | None = None, geo: str | _models.Geo | None = None, no_internet_advertise: bool | None = None, prefix_type: str | _models.CustomIpPrefixType | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Resource ID.
location	str Resource location.
tags	dict[str, str] Resource tags.
extended_location	ExtendedLocation The extended location of the custom IP prefix.
zones	list[str] A list of availability zones denoting the IP allocated for the resource needs to come from.
asn	str The ASN for CIDR advertising. Should be an integer as string.
cidr	str The prefix range in CIDR notation. Should include the start address and the prefix length.
signed_message	str Signed message for WAN validation.
authorization_message	str Authorization message for WAN validation.
custom_ip_prefix_parent	SubResource The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
commissioned_state	str or CommissionedState The commissioned state of the Custom IP Prefix. Known values are: "Provisioning", "Provisioned", "Commissioning", "CommissionedNoInternetAdvertise", "Commissioned", "Decommissioning", "Deprovisioning", and "Deprovisioned".
express_route_advertise	bool Whether to do express route advertise.
geo	str or Geo The Geo for CIDR advertising. Should be an Geo code. Known values are: "GLOBAL", "AFRI", "APAC", "EURO", "LATAM", "NAM", "ME", "OCEANIA", "AQ", and "GLOBAL".
no_internet_advertise	bool Whether to Advertise the range to Internet.
prefix_type	str or CustomIpPrefixType Type of custom IP prefix. Should be Singular, Parent, or Child. Known values are: "Singular", "Parent", and "Child".

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
location	str Resource location.
tags	dict[str, str] Resource tags.
extended_location	ExtendedLocation The extended location of the custom IP prefix.
etag	str A unique read-only string that changes whenever the resource is updated.
zones	list[str] A list of availability zones denoting the IP allocated for the resource needs to come from.
asn	str The ASN for CIDR advertising. Should be an integer as string.
cidr	str The prefix range in CIDR notation. Should include the start address and the prefix length.
signed_message	str Signed message for WAN validation.
authorization_message	str Authorization message for WAN validation.
custom_ip_prefix_parent	SubResource The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
child_custom_ip_prefixes	list[SubResource] The list of all Children for IPv6 /48 CustomIpPrefix.
commissioned_state	str or CommissionedState The commissioned state of the Custom IP Prefix. Known values are: "Provisioning", "Provisioned", "Commissioning", "CommissionedNoInternetAdvertise", "Commissioned", "Decommissioning", "Deprovisioning", and "Deprovisioned".
express_route_advertise	bool Whether to do express route advertise.
geo	str or Geo The Geo for CIDR advertising. Should be an Geo code. Known values are: "GLOBAL", "AFRI", "APAC", "EURO", "LATAM", "NAM", "ME", "OCEANIA", "AQ", and "GLOBAL".
no_internet_advertise	bool Whether to Advertise the range to Internet.
prefix_type	str or CustomIpPrefixType Type of custom IP prefix. Should be Singular, Parent, or Child. Known values are: "Singular", "Parent", and "Child".
public_ip_prefixes	list[SubResource] The list of all referenced PublicIpPrefixes.
resource_guid	str The resource GUID property of the custom IP prefix resource.
failed_reason	str The reason why resource is in failed state.
provisioning_state	str or ProvisioningState The provisioning state of the custom IP prefix resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".