@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets an existing peering with the specified name under the given subscription and resource group.
*
* 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 getPeering(args: GetPeeringArgs, opts?: pulumi.InvokeOptions): Promise<GetPeeringResult>;
export interface GetPeeringArgs {
/**
* The name of the peering.
*/
peeringName: string;
/**
* The name of the resource group.
*/
resourceGroupName: string;
}
/**
* Peering is a logical representation of a set of connections to the Microsoft Cloud Edge at a location.
*/
export interface GetPeeringResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The properties that define a direct peering.
*/
readonly direct?: outputs.peering.PeeringPropertiesDirectResponse;
/**
* The properties that define an exchange peering.
*/
readonly exchange?: outputs.peering.PeeringPropertiesExchangeResponse;
/**
* The ID of the resource.
*/
readonly id: string;
/**
* The kind of the peering.
*/
readonly kind: string;
/**
* The location of the resource.
*/
readonly location: string;
/**
* The name of the resource.
*/
readonly name: string;
/**
* The location of the peering.
*/
readonly peeringLocation?: string;
/**
* The provisioning state of the resource.
*/
readonly provisioningState: string;
/**
* The SKU that defines the tier and kind of the peering.
*/
readonly sku: outputs.peering.PeeringSkuResponse;
/**
* The resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource.
*/
readonly type: string;
}
/**
* Gets an existing peering with the specified name under the given subscription and resource group.
*
* 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 getPeeringOutput(args: GetPeeringOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPeeringResult>;
export interface GetPeeringOutputArgs {
/**
* The name of the peering.
*/
peeringName: pulumi.Input<string>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
}