@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 11.1 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";
/**
* Peerings in a virtual network resource.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 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, 2024-07-01, 2024-10-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class VirtualNetworkPeering extends pulumi.CustomResource {
/**
* Get an existing VirtualNetworkPeering 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): VirtualNetworkPeering;
/**
* Returns true if the given object is an instance of VirtualNetworkPeering. 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 VirtualNetworkPeering;
/**
* Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
*/
readonly allowForwardedTraffic: pulumi.Output<boolean | undefined>;
/**
* If gateway links can be used in remote virtual networking to link to this virtual network.
*/
readonly allowGatewayTransit: pulumi.Output<boolean | undefined>;
/**
* Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
*/
readonly allowVirtualNetworkAccess: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* If we need to verify the provisioning state of the remote gateway.
*/
readonly doNotVerifyRemoteGateways: pulumi.Output<boolean | undefined>;
/**
* Whether only Ipv6 address space is peered for subnet peering.
*/
readonly enableOnlyIPv6Peering: pulumi.Output<boolean | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* The local address space of the local virtual network that is peered.
*/
readonly localAddressSpace: pulumi.Output<outputs.network.AddressSpaceResponse | undefined>;
/**
* List of local subnet names that are subnet peered with remote virtual network.
*/
readonly localSubnetNames: pulumi.Output<string[] | undefined>;
/**
* The current local address space of the local virtual network that is peered.
*/
readonly localVirtualNetworkAddressSpace: pulumi.Output<outputs.network.AddressSpaceResponse | undefined>;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* Whether complete virtual network address space is peered.
*/
readonly peerCompleteVnets: pulumi.Output<boolean | undefined>;
/**
* The status of the virtual network peering.
*/
readonly peeringState: pulumi.Output<string | undefined>;
/**
* The peering sync status of the virtual network peering.
*/
readonly peeringSyncLevel: pulumi.Output<string | undefined>;
/**
* The provisioning state of the virtual network peering resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The reference to the address space peered with the remote virtual network.
*/
readonly remoteAddressSpace: pulumi.Output<outputs.network.AddressSpaceResponse | undefined>;
/**
* The reference to the remote virtual network's Bgp Communities.
*/
readonly remoteBgpCommunities: pulumi.Output<outputs.network.VirtualNetworkBgpCommunitiesResponse | undefined>;
/**
* List of remote subnet names from remote virtual network that are subnet peered.
*/
readonly remoteSubnetNames: pulumi.Output<string[] | undefined>;
/**
* The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).
*/
readonly remoteVirtualNetwork: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The reference to the current address space of the remote virtual network.
*/
readonly remoteVirtualNetworkAddressSpace: pulumi.Output<outputs.network.AddressSpaceResponse | undefined>;
/**
* The reference to the remote virtual network's encryption
*/
readonly remoteVirtualNetworkEncryption: pulumi.Output<outputs.network.VirtualNetworkEncryptionResponse>;
/**
* The resourceGuid property of the Virtual Network peering resource.
*/
readonly resourceGuid: pulumi.Output<string>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string | undefined>;
/**
* If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.
*/
readonly useRemoteGateways: pulumi.Output<boolean | undefined>;
/**
* Create a VirtualNetworkPeering 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: VirtualNetworkPeeringArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VirtualNetworkPeering resource.
*/
export interface VirtualNetworkPeeringArgs {
/**
* Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
*/
allowForwardedTraffic?: pulumi.Input<boolean>;
/**
* If gateway links can be used in remote virtual networking to link to this virtual network.
*/
allowGatewayTransit?: pulumi.Input<boolean>;
/**
* Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
*/
allowVirtualNetworkAccess?: pulumi.Input<boolean>;
/**
* If we need to verify the provisioning state of the remote gateway.
*/
doNotVerifyRemoteGateways?: pulumi.Input<boolean>;
/**
* Whether only Ipv6 address space is peered for subnet peering.
*/
enableOnlyIPv6Peering?: pulumi.Input<boolean>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* The local address space of the local virtual network that is peered.
*/
localAddressSpace?: pulumi.Input<inputs.network.AddressSpaceArgs>;
/**
* List of local subnet names that are subnet peered with remote virtual network.
*/
localSubnetNames?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The current local address space of the local virtual network that is peered.
*/
localVirtualNetworkAddressSpace?: pulumi.Input<inputs.network.AddressSpaceArgs>;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
name?: pulumi.Input<string>;
/**
* Whether complete virtual network address space is peered.
*/
peerCompleteVnets?: pulumi.Input<boolean>;
/**
* The status of the virtual network peering.
*/
peeringState?: pulumi.Input<string | enums.network.VirtualNetworkPeeringState>;
/**
* The peering sync status of the virtual network peering.
*/
peeringSyncLevel?: pulumi.Input<string | enums.network.VirtualNetworkPeeringLevel>;
/**
* The reference to the address space peered with the remote virtual network.
*/
remoteAddressSpace?: pulumi.Input<inputs.network.AddressSpaceArgs>;
/**
* The reference to the remote virtual network's Bgp Communities.
*/
remoteBgpCommunities?: pulumi.Input<inputs.network.VirtualNetworkBgpCommunitiesArgs>;
/**
* List of remote subnet names from remote virtual network that are subnet peered.
*/
remoteSubnetNames?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).
*/
remoteVirtualNetwork?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The reference to the current address space of the remote virtual network.
*/
remoteVirtualNetworkAddressSpace?: pulumi.Input<inputs.network.AddressSpaceArgs>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated.
*/
syncRemoteAddressSpace?: pulumi.Input<string>;
/**
* Resource type.
*/
type?: pulumi.Input<string>;
/**
* If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.
*/
useRemoteGateways?: pulumi.Input<boolean>;
/**
* The name of the virtual network.
*/
virtualNetworkName: pulumi.Input<string>;
/**
* The name of the peering.
*/
virtualNetworkPeeringName?: pulumi.Input<string>;
}