@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.34 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Peering is a logical representation of a set of connections to the Microsoft Cloud Edge at a location.
*
* Uses Azure REST API version 2022-10-01. In version 2.x of the Azure Native provider, it used 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 class Peering extends pulumi.CustomResource {
/**
* Get an existing Peering resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Peering;
/**
* Returns true if the given object is an instance of Peering. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Peering;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The properties that define a direct peering.
*/
readonly direct: pulumi.Output<outputs.peering.PeeringPropertiesDirectResponse | undefined>;
/**
* The properties that define an exchange peering.
*/
readonly exchange: pulumi.Output<outputs.peering.PeeringPropertiesExchangeResponse | undefined>;
/**
* The kind of the peering.
*/
readonly kind: pulumi.Output<string>;
/**
* The location of the resource.
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* The location of the peering.
*/
readonly peeringLocation: pulumi.Output<string | undefined>;
/**
* The provisioning state of the resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The SKU that defines the tier and kind of the peering.
*/
readonly sku: pulumi.Output<outputs.peering.PeeringSkuResponse>;
/**
* The resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Peering resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: PeeringArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Peering resource.
*/
export interface PeeringArgs {
/**
* The properties that define a direct peering.
*/
direct?: pulumi.Input<inputs.peering.PeeringPropertiesDirectArgs>;
/**
* The properties that define an exchange peering.
*/
exchange?: pulumi.Input<inputs.peering.PeeringPropertiesExchangeArgs>;
/**
* The kind of the peering.
*/
kind: pulumi.Input<string | enums.peering.Kind>;
/**
* The location of the resource.
*/
location?: pulumi.Input<string>;
/**
* The location of the peering.
*/
peeringLocation?: pulumi.Input<string>;
/**
* The name of the peering.
*/
peeringName?: pulumi.Input<string>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The SKU that defines the tier and kind of the peering.
*/
sku: pulumi.Input<inputs.peering.PeeringSkuArgs>;
/**
* The resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}