Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getVirtualRouterPeering
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getVirtualRouterPeering

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified Virtual Router Peering. Azure REST API version: 2023-02-01.

Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Using getVirtualRouterPeering

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVirtualRouterPeering(args: GetVirtualRouterPeeringArgs, opts?: InvokeOptions): Promise<GetVirtualRouterPeeringResult>
function getVirtualRouterPeeringOutput(args: GetVirtualRouterPeeringOutputArgs, opts?: InvokeOptions): Output<GetVirtualRouterPeeringResult>
Copy
def get_virtual_router_peering(peering_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               virtual_router_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetVirtualRouterPeeringResult
def get_virtual_router_peering_output(peering_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               virtual_router_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetVirtualRouterPeeringResult]
Copy
func LookupVirtualRouterPeering(ctx *Context, args *LookupVirtualRouterPeeringArgs, opts ...InvokeOption) (*LookupVirtualRouterPeeringResult, error)
func LookupVirtualRouterPeeringOutput(ctx *Context, args *LookupVirtualRouterPeeringOutputArgs, opts ...InvokeOption) LookupVirtualRouterPeeringResultOutput
Copy

> Note: This function is named LookupVirtualRouterPeering in the Go SDK.

public static class GetVirtualRouterPeering 
{
    public static Task<GetVirtualRouterPeeringResult> InvokeAsync(GetVirtualRouterPeeringArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualRouterPeeringResult> Invoke(GetVirtualRouterPeeringInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualRouterPeeringResult> getVirtualRouterPeering(GetVirtualRouterPeeringArgs args, InvokeOptions options)
public static Output<GetVirtualRouterPeeringResult> getVirtualRouterPeering(GetVirtualRouterPeeringArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVirtualRouterPeering
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PeeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Router Peering.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualRouterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Router.
PeeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Router Peering.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualRouterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Router.
peeringName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Virtual Router Peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualRouterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Virtual Router.
peeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Router Peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
virtualRouterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Router.
peering_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Virtual Router Peering.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
virtual_router_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Virtual Router.
peeringName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Virtual Router Peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualRouterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Virtual Router.

getVirtualRouterPeering Result

The following output properties are available:

Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the resource.
Type string
Peering type.
Id string
Resource ID.
Name string
Name of the virtual router peering that is unique within a virtual router.
PeerAsn double
Peer ASN.
PeerIp string
Peer IP.
Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the resource.
Type string
Peering type.
Id string
Resource ID.
Name string
Name of the virtual router peering that is unique within a virtual router.
PeerAsn float64
Peer ASN.
PeerIp string
Peer IP.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the resource.
type String
Peering type.
id String
Resource ID.
name String
Name of the virtual router peering that is unique within a virtual router.
peerAsn Double
Peer ASN.
peerIp String
Peer IP.
etag string
A unique read-only string that changes whenever the resource is updated.
provisioningState string
The provisioning state of the resource.
type string
Peering type.
id string
Resource ID.
name string
Name of the virtual router peering that is unique within a virtual router.
peerAsn number
Peer ASN.
peerIp string
Peer IP.
etag str
A unique read-only string that changes whenever the resource is updated.
provisioning_state str
The provisioning state of the resource.
type str
Peering type.
id str
Resource ID.
name str
Name of the virtual router peering that is unique within a virtual router.
peer_asn float
Peer ASN.
peer_ip str
Peer IP.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the resource.
type String
Peering type.
id String
Resource ID.
name String
Name of the virtual router peering that is unique within a virtual router.
peerAsn Number
Peer ASN.
peerIp String
Peer IP.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native