@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 2.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getRegisteredPrefix(args: GetRegisteredPrefixArgs, opts?: pulumi.InvokeOptions): Promise<GetRegisteredPrefixResult>;
export interface GetRegisteredPrefixArgs {
/**
* The name of the peering.
*/
peeringName: string;
/**
* The name of the registered prefix.
*/
registeredPrefixName: string;
/**
* The name of the resource group.
*/
resourceGroupName: string;
}
/**
* The customer's prefix that is registered by the peering service provider.
*/
export interface GetRegisteredPrefixResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The error message associated with the validation state, if any.
*/
readonly errorMessage: string;
/**
* The ID of the resource.
*/
readonly id: string;
/**
* The name of the resource.
*/
readonly name: string;
/**
* The peering service prefix key that is to be shared with the customer.
*/
readonly peeringServicePrefixKey: string;
/**
* The customer's prefix from which traffic originates.
*/
readonly prefix?: string;
/**
* The prefix validation state.
*/
readonly prefixValidationState: string;
/**
* The provisioning state of the resource.
*/
readonly provisioningState: string;
/**
* The type of the resource.
*/
readonly type: string;
}
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getRegisteredPrefixOutput(args: GetRegisteredPrefixOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRegisteredPrefixResult>;
export interface GetRegisteredPrefixOutputArgs {
/**
* The name of the peering.
*/
peeringName: pulumi.Input<string>;
/**
* The name of the registered prefix.
*/
registeredPrefixName: pulumi.Input<string>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
}