getVirtualNetworkPeering

Use this data source to access information about an existing virtual network peering.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.network.getVirtualNetwork({
name: "vnet01",
resourceGroupName: "networking",
});
const exampleGetVirtualNetworkPeering = example.then(example => azure.network.getVirtualNetworkPeering({
name: "peer-vnet01-to-vnet02",
virtualNetworkId: example.id,
}));
export const id = exampleGetVirtualNetworkPeering.then(exampleGetVirtualNetworkPeering => exampleGetVirtualNetworkPeering.id);
import pulumi
import pulumi_azure as azure
example = azure.network.get_virtual_network(name="vnet01",
resource_group_name="networking")
example_get_virtual_network_peering = azure.network.get_virtual_network_peering(name="peer-vnet01-to-vnet02",
virtual_network_id=example.id)
pulumi.export("id", example_get_virtual_network_peering.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.Network.GetVirtualNetwork.Invoke(new()
{
Name = "vnet01",
ResourceGroupName = "networking",
});
var exampleGetVirtualNetworkPeering = Azure.Network.GetVirtualNetworkPeering.Invoke(new()
{
Name = "peer-vnet01-to-vnet02",
VirtualNetworkId = example.Apply(getVirtualNetworkResult => getVirtualNetworkResult.Id),
});
return new Dictionary<string, object?>
{
["id"] = exampleGetVirtualNetworkPeering.Apply(getVirtualNetworkPeeringResult => getVirtualNetworkPeeringResult.Id),
};
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := network.LookupVirtualNetwork(ctx, &network.LookupVirtualNetworkArgs{
Name: "vnet01",
ResourceGroupName: "networking",
}, nil)
if err != nil {
return err
}
exampleGetVirtualNetworkPeering, err := network.LookupVirtualNetworkPeering(ctx, &network.LookupVirtualNetworkPeeringArgs{
Name: "peer-vnet01-to-vnet02",
VirtualNetworkId: example.Id,
}, nil)
if err != nil {
return err
}
ctx.Export("id", exampleGetVirtualNetworkPeering.Id)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.network.NetworkFunctions;
import com.pulumi.azure.network.inputs.GetVirtualNetworkArgs;
import com.pulumi.azure.network.inputs.GetVirtualNetworkPeeringArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = NetworkFunctions.getVirtualNetwork(GetVirtualNetworkArgs.builder()
.name("vnet01")
.resourceGroupName("networking")
.build());
final var exampleGetVirtualNetworkPeering = NetworkFunctions.getVirtualNetworkPeering(GetVirtualNetworkPeeringArgs.builder()
.name("peer-vnet01-to-vnet02")
.virtualNetworkId(example.id())
.build());
ctx.export("id", exampleGetVirtualNetworkPeering.id());
}
}
variables:
example:
fn::invoke:
function: azure:network:getVirtualNetwork
arguments:
name: vnet01
resourceGroupName: networking
exampleGetVirtualNetworkPeering:
fn::invoke:
function: azure:network:getVirtualNetworkPeering
arguments:
name: peer-vnet01-to-vnet02
virtualNetworkId: ${example.id}
outputs:
id: ${exampleGetVirtualNetworkPeering.id}

API Providers

This data source uses the following Azure API Providers:

  • Microsoft.Network: 2024-05-01

Return

A collection of values returned by getVirtualNetworkPeering.

Parameters

argument

A collection of arguments for invoking getVirtualNetworkPeering.


Return

A collection of values returned by getVirtualNetworkPeering.

Parameters

name

The name of this virtual network peering.

virtualNetworkId

The resource ID of the virtual network.

See also


Return

A collection of values returned by getVirtualNetworkPeering.

Parameters

argument

Builder for com.pulumi.azure.network.kotlin.inputs.GetVirtualNetworkPeeringPlainArgs.

See also