Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getCustomIPPrefix
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getCustomIPPrefix

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the specified custom IP prefix in a specified resource group.

    Uses Azure REST API version 2024-05-01.

    Other available API versions: 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

    Using getCustomIPPrefix

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCustomIPPrefix(args: GetCustomIPPrefixArgs, opts?: InvokeOptions): Promise<GetCustomIPPrefixResult>
function getCustomIPPrefixOutput(args: GetCustomIPPrefixOutputArgs, opts?: InvokeOptions): Output<GetCustomIPPrefixResult>
    def get_custom_ip_prefix(custom_ip_prefix_name: Optional[str] = None,
                         expand: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCustomIPPrefixResult
def get_custom_ip_prefix_output(custom_ip_prefix_name: Optional[pulumi.Input[str]] = None,
                         expand: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCustomIPPrefixResult]
    func LookupCustomIPPrefix(ctx *Context, args *LookupCustomIPPrefixArgs, opts ...InvokeOption) (*LookupCustomIPPrefixResult, error)
func LookupCustomIPPrefixOutput(ctx *Context, args *LookupCustomIPPrefixOutputArgs, opts ...InvokeOption) LookupCustomIPPrefixResultOutput

    > Note: This function is named LookupCustomIPPrefix in the Go SDK.

    public static class GetCustomIPPrefix 
{
    public static Task<GetCustomIPPrefixResult> InvokeAsync(GetCustomIPPrefixArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomIPPrefixResult> Invoke(GetCustomIPPrefixInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomIPPrefixResult> getCustomIPPrefix(GetCustomIPPrefixArgs args, InvokeOptions options)
public static Output<GetCustomIPPrefixResult> getCustomIPPrefix(GetCustomIPPrefixArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:network:getCustomIPPrefix
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CustomIpPrefixName string
    The name of the custom IP prefix.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Expands referenced resources.
    CustomIpPrefixName string
    The name of the custom IP prefix.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Expands referenced resources.
    customIpPrefixName String
    The name of the custom IP prefix.
    resourceGroupName String
    The name of the resource group.
    expand String
    Expands referenced resources.
    customIpPrefixName string
    The name of the custom IP prefix.
    resourceGroupName string
    The name of the resource group.
    expand string
    Expands referenced resources.
    custom_ip_prefix_name str
    The name of the custom IP prefix.
    resource_group_name str
    The name of the resource group.
    expand str
    Expands referenced resources.
    customIpPrefixName String
    The name of the custom IP prefix.
    resourceGroupName String
    The name of the resource group.
    expand String
    Expands referenced resources.

    getCustomIPPrefix Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ChildCustomIpPrefixes List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    The list of all Children for IPv6 /48 CustomIpPrefix.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    FailedReason string
    The reason why resource is in failed state.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the custom IP prefix resource.
    PublicIpPrefixes List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    The list of all referenced PublicIpPrefixes.
    ResourceGuid string
    The resource GUID property of the custom IP prefix resource.
    Type string
    Resource type.
    Asn string
    The ASN for CIDR advertising. Should be an integer as string.
    AuthorizationMessage string
    Authorization message for WAN validation.
    Cidr string
    The prefix range in CIDR notation. Should include the start address and the prefix length.
    CommissionedState string
    The commissioned state of the Custom IP Prefix.
    CustomIpPrefixParent Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
    ExpressRouteAdvertise bool
    Whether to do express route advertise.
    ExtendedLocation Pulumi.AzureNative.Network.Outputs.ExtendedLocationResponse
    The extended location of the custom IP prefix.
    Geo string
    The Geo for CIDR advertising. Should be an Geo code.
    Id string
    Resource ID.
    Location string
    Resource location.
    NoInternetAdvertise bool
    Whether to Advertise the range to Internet.
    PrefixType string
    Type of custom IP prefix. Should be Singular, Parent, or Child.
    SignedMessage string
    Signed message for WAN validation.
    Tags Dictionary<string, string>
    Resource tags.
    Zones List<string>
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    AzureApiVersion string
    The Azure API version of the resource.
    ChildCustomIpPrefixes []SubResourceResponse
    The list of all Children for IPv6 /48 CustomIpPrefix.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    FailedReason string
    The reason why resource is in failed state.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the custom IP prefix resource.
    PublicIpPrefixes []SubResourceResponse
    The list of all referenced PublicIpPrefixes.
    ResourceGuid string
    The resource GUID property of the custom IP prefix resource.
    Type string
    Resource type.
    Asn string
    The ASN for CIDR advertising. Should be an integer as string.
    AuthorizationMessage string
    Authorization message for WAN validation.
    Cidr string
    The prefix range in CIDR notation. Should include the start address and the prefix length.
    CommissionedState string
    The commissioned state of the Custom IP Prefix.
    CustomIpPrefixParent SubResourceResponse
    The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
    ExpressRouteAdvertise bool
    Whether to do express route advertise.
    ExtendedLocation ExtendedLocationResponse
    The extended location of the custom IP prefix.
    Geo string
    The Geo for CIDR advertising. Should be an Geo code.
    Id string
    Resource ID.
    Location string
    Resource location.
    NoInternetAdvertise bool
    Whether to Advertise the range to Internet.
    PrefixType string
    Type of custom IP prefix. Should be Singular, Parent, or Child.
    SignedMessage string
    Signed message for WAN validation.
    Tags map[string]string
    Resource tags.
    Zones []string
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    azureApiVersion String
    The Azure API version of the resource.
    childCustomIpPrefixes List<SubResourceResponse>
    The list of all Children for IPv6 /48 CustomIpPrefix.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    failedReason String
    The reason why resource is in failed state.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the custom IP prefix resource.
    publicIpPrefixes List<SubResourceResponse>
    The list of all referenced PublicIpPrefixes.
    resourceGuid String
    The resource GUID property of the custom IP prefix resource.
    type String
    Resource type.
    asn String
    The ASN for CIDR advertising. Should be an integer as string.
    authorizationMessage String
    Authorization message for WAN validation.
    cidr String
    The prefix range in CIDR notation. Should include the start address and the prefix length.
    commissionedState String
    The commissioned state of the Custom IP Prefix.
    customIpPrefixParent SubResourceResponse
    The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
    expressRouteAdvertise Boolean
    Whether to do express route advertise.
    extendedLocation ExtendedLocationResponse
    The extended location of the custom IP prefix.
    geo String
    The Geo for CIDR advertising. Should be an Geo code.
    id String
    Resource ID.
    location String
    Resource location.
    noInternetAdvertise Boolean
    Whether to Advertise the range to Internet.
    prefixType String
    Type of custom IP prefix. Should be Singular, Parent, or Child.
    signedMessage String
    Signed message for WAN validation.
    tags Map<String,String>
    Resource tags.
    zones List<String>
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    azureApiVersion string
    The Azure API version of the resource.
    childCustomIpPrefixes SubResourceResponse[]
    The list of all Children for IPv6 /48 CustomIpPrefix.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    failedReason string
    The reason why resource is in failed state.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the custom IP prefix resource.
    publicIpPrefixes SubResourceResponse[]
    The list of all referenced PublicIpPrefixes.
    resourceGuid string
    The resource GUID property of the custom IP prefix resource.
    type string
    Resource type.
    asn string
    The ASN for CIDR advertising. Should be an integer as string.
    authorizationMessage string
    Authorization message for WAN validation.
    cidr string
    The prefix range in CIDR notation. Should include the start address and the prefix length.
    commissionedState string
    The commissioned state of the Custom IP Prefix.
    customIpPrefixParent SubResourceResponse
    The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
    expressRouteAdvertise boolean
    Whether to do express route advertise.
    extendedLocation ExtendedLocationResponse
    The extended location of the custom IP prefix.
    geo string
    The Geo for CIDR advertising. Should be an Geo code.
    id string
    Resource ID.
    location string
    Resource location.
    noInternetAdvertise boolean
    Whether to Advertise the range to Internet.
    prefixType string
    Type of custom IP prefix. Should be Singular, Parent, or Child.
    signedMessage string
    Signed message for WAN validation.
    tags {[key: string]: string}
    Resource tags.
    zones string[]
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    azure_api_version str
    The Azure API version of the resource.
    child_custom_ip_prefixes Sequence[SubResourceResponse]
    The list of all Children for IPv6 /48 CustomIpPrefix.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    failed_reason str
    The reason why resource is in failed state.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the custom IP prefix resource.
    public_ip_prefixes Sequence[SubResourceResponse]
    The list of all referenced PublicIpPrefixes.
    resource_guid str
    The resource GUID property of the custom IP prefix resource.
    type str
    Resource type.
    asn str
    The ASN for CIDR advertising. Should be an integer as string.
    authorization_message str
    Authorization message for WAN validation.
    cidr str
    The prefix range in CIDR notation. Should include the start address and the prefix length.
    commissioned_state str
    The commissioned state of the Custom IP Prefix.
    custom_ip_prefix_parent SubResourceResponse
    The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
    express_route_advertise bool
    Whether to do express route advertise.
    extended_location ExtendedLocationResponse
    The extended location of the custom IP prefix.
    geo str
    The Geo for CIDR advertising. Should be an Geo code.
    id str
    Resource ID.
    location str
    Resource location.
    no_internet_advertise bool
    Whether to Advertise the range to Internet.
    prefix_type str
    Type of custom IP prefix. Should be Singular, Parent, or Child.
    signed_message str
    Signed message for WAN validation.
    tags Mapping[str, str]
    Resource tags.
    zones Sequence[str]
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    azureApiVersion String
    The Azure API version of the resource.
    childCustomIpPrefixes List<Property Map>
    The list of all Children for IPv6 /48 CustomIpPrefix.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    failedReason String
    The reason why resource is in failed state.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the custom IP prefix resource.
    publicIpPrefixes List<Property Map>
    The list of all referenced PublicIpPrefixes.
    resourceGuid String
    The resource GUID property of the custom IP prefix resource.
    type String
    Resource type.
    asn String
    The ASN for CIDR advertising. Should be an integer as string.
    authorizationMessage String
    Authorization message for WAN validation.
    cidr String
    The prefix range in CIDR notation. Should include the start address and the prefix length.
    commissionedState String
    The commissioned state of the Custom IP Prefix.
    customIpPrefixParent Property Map
    The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
    expressRouteAdvertise Boolean
    Whether to do express route advertise.
    extendedLocation Property Map
    The extended location of the custom IP prefix.
    geo String
    The Geo for CIDR advertising. Should be an Geo code.
    id String
    Resource ID.
    location String
    Resource location.
    noInternetAdvertise Boolean
    Whether to Advertise the range to Internet.
    prefixType String
    Type of custom IP prefix. Should be Singular, Parent, or Child.
    signedMessage String
    Signed message for WAN validation.
    tags Map<String>
    Resource tags.
    zones List<String>
    A list of availability zones denoting the IP allocated for the resource needs to come from.

    Supporting Types

    ExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    SubResourceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native