Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. peering
  5. getRegisteredPrefix
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.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.peering.getRegisteredPrefix

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.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.

    Uses Azure REST API version 2022-10-01.

    Other available API versions: 2025-05-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native peering [ApiVersion]. See the version guide for details.

    Using getRegisteredPrefix

    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 getRegisteredPrefix(args: GetRegisteredPrefixArgs, opts?: InvokeOptions): Promise<GetRegisteredPrefixResult>
function getRegisteredPrefixOutput(args: GetRegisteredPrefixOutputArgs, opts?: InvokeOptions): Output<GetRegisteredPrefixResult>
    def get_registered_prefix(peering_name: Optional[str] = None,
                          registered_prefix_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRegisteredPrefixResult
def get_registered_prefix_output(peering_name: Optional[pulumi.Input[str]] = None,
                          registered_prefix_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRegisteredPrefixResult]
    func LookupRegisteredPrefix(ctx *Context, args *LookupRegisteredPrefixArgs, opts ...InvokeOption) (*LookupRegisteredPrefixResult, error)
func LookupRegisteredPrefixOutput(ctx *Context, args *LookupRegisteredPrefixOutputArgs, opts ...InvokeOption) LookupRegisteredPrefixResultOutput

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

    public static class GetRegisteredPrefix 
{
    public static Task<GetRegisteredPrefixResult> InvokeAsync(GetRegisteredPrefixArgs args, InvokeOptions? opts = null)
    public static Output<GetRegisteredPrefixResult> Invoke(GetRegisteredPrefixInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRegisteredPrefixResult> getRegisteredPrefix(GetRegisteredPrefixArgs args, InvokeOptions options)
public static Output<GetRegisteredPrefixResult> getRegisteredPrefix(GetRegisteredPrefixArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:peering:getRegisteredPrefix
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PeeringName string
    The name of the peering.
    RegisteredPrefixName string
    The name of the registered prefix.
    ResourceGroupName string
    The name of the resource group.
    PeeringName string
    The name of the peering.
    RegisteredPrefixName string
    The name of the registered prefix.
    ResourceGroupName string
    The name of the resource group.
    peeringName String
    The name of the peering.
    registeredPrefixName String
    The name of the registered prefix.
    resourceGroupName String
    The name of the resource group.
    peeringName string
    The name of the peering.
    registeredPrefixName string
    The name of the registered prefix.
    resourceGroupName string
    The name of the resource group.
    peering_name str
    The name of the peering.
    registered_prefix_name str
    The name of the registered prefix.
    resource_group_name str
    The name of the resource group.
    peeringName String
    The name of the peering.
    registeredPrefixName String
    The name of the registered prefix.
    resourceGroupName String
    The name of the resource group.

    getRegisteredPrefix Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ErrorMessage string
    The error message associated with the validation state, if any.
    Id string
    The ID of the resource.
    Name string
    The name of the resource.
    PeeringServicePrefixKey string
    The peering service prefix key that is to be shared with the customer.
    PrefixValidationState string
    The prefix validation state.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    The type of the resource.
    Prefix string
    The customer's prefix from which traffic originates.
    AzureApiVersion string
    The Azure API version of the resource.
    ErrorMessage string
    The error message associated with the validation state, if any.
    Id string
    The ID of the resource.
    Name string
    The name of the resource.
    PeeringServicePrefixKey string
    The peering service prefix key that is to be shared with the customer.
    PrefixValidationState string
    The prefix validation state.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    The type of the resource.
    Prefix string
    The customer's prefix from which traffic originates.
    azureApiVersion String
    The Azure API version of the resource.
    errorMessage String
    The error message associated with the validation state, if any.
    id String
    The ID of the resource.
    name String
    The name of the resource.
    peeringServicePrefixKey String
    The peering service prefix key that is to be shared with the customer.
    prefixValidationState String
    The prefix validation state.
    provisioningState String
    The provisioning state of the resource.
    type String
    The type of the resource.
    prefix String
    The customer's prefix from which traffic originates.
    azureApiVersion string
    The Azure API version of the resource.
    errorMessage string
    The error message associated with the validation state, if any.
    id string
    The ID of the resource.
    name string
    The name of the resource.
    peeringServicePrefixKey string
    The peering service prefix key that is to be shared with the customer.
    prefixValidationState string
    The prefix validation state.
    provisioningState string
    The provisioning state of the resource.
    type string
    The type of the resource.
    prefix string
    The customer's prefix from which traffic originates.
    azure_api_version str
    The Azure API version of the resource.
    error_message str
    The error message associated with the validation state, if any.
    id str
    The ID of the resource.
    name str
    The name of the resource.
    peering_service_prefix_key str
    The peering service prefix key that is to be shared with the customer.
    prefix_validation_state str
    The prefix validation state.
    provisioning_state str
    The provisioning state of the resource.
    type str
    The type of the resource.
    prefix str
    The customer's prefix from which traffic originates.
    azureApiVersion String
    The Azure API version of the resource.
    errorMessage String
    The error message associated with the validation state, if any.
    id String
    The ID of the resource.
    name String
    The name of the resource.
    peeringServicePrefixKey String
    The peering service prefix key that is to be shared with the customer.
    prefixValidationState String
    The prefix validation state.
    provisioningState String
    The provisioning state of the resource.
    type String
    The type of the resource.
    prefix String
    The customer's prefix from which traffic originates.

    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.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
    pulumi/pulumi-azure-native