1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVirtualNetworkPeering
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

azure-native.network.getVirtualNetworkPeering

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

    Gets the specified virtual network peering. Azure REST API version: 2023-02-01.

    Using getVirtualNetworkPeering

    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 getVirtualNetworkPeering(args: GetVirtualNetworkPeeringArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkPeeringResult>
    function getVirtualNetworkPeeringOutput(args: GetVirtualNetworkPeeringOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkPeeringResult>
    def get_virtual_network_peering(resource_group_name: Optional[str] = None,
                                    virtual_network_name: Optional[str] = None,
                                    virtual_network_peering_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkPeeringResult
    def get_virtual_network_peering_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                    virtual_network_name: Optional[pulumi.Input[str]] = None,
                                    virtual_network_peering_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkPeeringResult]
    func LookupVirtualNetworkPeering(ctx *Context, args *LookupVirtualNetworkPeeringArgs, opts ...InvokeOption) (*LookupVirtualNetworkPeeringResult, error)
    func LookupVirtualNetworkPeeringOutput(ctx *Context, args *LookupVirtualNetworkPeeringOutputArgs, opts ...InvokeOption) LookupVirtualNetworkPeeringResultOutput

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

    public static class GetVirtualNetworkPeering 
    {
        public static Task<GetVirtualNetworkPeeringResult> InvokeAsync(GetVirtualNetworkPeeringArgs args, InvokeOptions? opts = null)
        public static Output<GetVirtualNetworkPeeringResult> Invoke(GetVirtualNetworkPeeringInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVirtualNetworkPeeringResult> getVirtualNetworkPeering(GetVirtualNetworkPeeringArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:getVirtualNetworkPeering
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string

    The name of the resource group.

    VirtualNetworkName string

    The name of the virtual network.

    VirtualNetworkPeeringName string

    The name of the virtual network peering.

    ResourceGroupName string

    The name of the resource group.

    VirtualNetworkName string

    The name of the virtual network.

    VirtualNetworkPeeringName string

    The name of the virtual network peering.

    resourceGroupName String

    The name of the resource group.

    virtualNetworkName String

    The name of the virtual network.

    virtualNetworkPeeringName String

    The name of the virtual network peering.

    resourceGroupName string

    The name of the resource group.

    virtualNetworkName string

    The name of the virtual network.

    virtualNetworkPeeringName string

    The name of the virtual network peering.

    resource_group_name str

    The name of the resource group.

    virtual_network_name str

    The name of the virtual network.

    virtual_network_peering_name str

    The name of the virtual network peering.

    resourceGroupName String

    The name of the resource group.

    virtualNetworkName String

    The name of the virtual network.

    virtualNetworkPeeringName String

    The name of the virtual network peering.

    getVirtualNetworkPeering 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 virtual network peering resource.

    RemoteVirtualNetworkEncryption Pulumi.AzureNative.Network.Outputs.VirtualNetworkEncryptionResponse

    The reference to the remote virtual network's encryption

    ResourceGuid string

    The resourceGuid property of the Virtual Network peering resource.

    AllowForwardedTraffic bool

    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

    AllowGatewayTransit bool

    If gateway links can be used in remote virtual networking to link to this virtual network.

    AllowVirtualNetworkAccess bool

    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

    DoNotVerifyRemoteGateways bool

    If we need to verify the provisioning state of the remote gateway.

    Id string

    Resource ID.

    Name string

    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    PeeringState string

    The status of the virtual network peering.

    PeeringSyncLevel string

    The peering sync status of the virtual network peering.

    RemoteAddressSpace Pulumi.AzureNative.Network.Outputs.AddressSpaceResponse

    The reference to the address space peered with the remote virtual network.

    RemoteBgpCommunities Pulumi.AzureNative.Network.Outputs.VirtualNetworkBgpCommunitiesResponse

    The reference to the remote virtual network's Bgp Communities.

    RemoteVirtualNetwork Pulumi.AzureNative.Network.Outputs.SubResourceResponse

    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).

    RemoteVirtualNetworkAddressSpace Pulumi.AzureNative.Network.Outputs.AddressSpaceResponse

    The reference to the current address space of the remote virtual network.

    Type string

    Resource type.

    UseRemoteGateways bool

    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.

    Etag string

    A unique read-only string that changes whenever the resource is updated.

    ProvisioningState string

    The provisioning state of the virtual network peering resource.

    RemoteVirtualNetworkEncryption VirtualNetworkEncryptionResponse

    The reference to the remote virtual network's encryption

    ResourceGuid string

    The resourceGuid property of the Virtual Network peering resource.

    AllowForwardedTraffic bool

    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

    AllowGatewayTransit bool

    If gateway links can be used in remote virtual networking to link to this virtual network.

    AllowVirtualNetworkAccess bool

    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

    DoNotVerifyRemoteGateways bool

    If we need to verify the provisioning state of the remote gateway.

    Id string

    Resource ID.

    Name string

    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    PeeringState string

    The status of the virtual network peering.

    PeeringSyncLevel string

    The peering sync status of the virtual network peering.

    RemoteAddressSpace AddressSpaceResponse

    The reference to the address space peered with the remote virtual network.

    RemoteBgpCommunities VirtualNetworkBgpCommunitiesResponse

    The reference to the remote virtual network's Bgp Communities.

    RemoteVirtualNetwork SubResourceResponse

    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).

    RemoteVirtualNetworkAddressSpace AddressSpaceResponse

    The reference to the current address space of the remote virtual network.

    Type string

    Resource type.

    UseRemoteGateways bool

    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.

    etag String

    A unique read-only string that changes whenever the resource is updated.

    provisioningState String

    The provisioning state of the virtual network peering resource.

    remoteVirtualNetworkEncryption VirtualNetworkEncryptionResponse

    The reference to the remote virtual network's encryption

    resourceGuid String

    The resourceGuid property of the Virtual Network peering resource.

    allowForwardedTraffic Boolean

    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

    allowGatewayTransit Boolean

    If gateway links can be used in remote virtual networking to link to this virtual network.

    allowVirtualNetworkAccess Boolean

    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

    doNotVerifyRemoteGateways Boolean

    If we need to verify the provisioning state of the remote gateway.

    id String

    Resource ID.

    name String

    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    peeringState String

    The status of the virtual network peering.

    peeringSyncLevel String

    The peering sync status of the virtual network peering.

    remoteAddressSpace AddressSpaceResponse

    The reference to the address space peered with the remote virtual network.

    remoteBgpCommunities VirtualNetworkBgpCommunitiesResponse

    The reference to the remote virtual network's Bgp Communities.

    remoteVirtualNetwork SubResourceResponse

    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).

    remoteVirtualNetworkAddressSpace AddressSpaceResponse

    The reference to the current address space of the remote virtual network.

    type String

    Resource type.

    useRemoteGateways Boolean

    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.

    etag string

    A unique read-only string that changes whenever the resource is updated.

    provisioningState string

    The provisioning state of the virtual network peering resource.

    remoteVirtualNetworkEncryption VirtualNetworkEncryptionResponse

    The reference to the remote virtual network's encryption

    resourceGuid string

    The resourceGuid property of the Virtual Network peering resource.

    allowForwardedTraffic boolean

    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

    allowGatewayTransit boolean

    If gateway links can be used in remote virtual networking to link to this virtual network.

    allowVirtualNetworkAccess boolean

    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

    doNotVerifyRemoteGateways boolean

    If we need to verify the provisioning state of the remote gateway.

    id string

    Resource ID.

    name string

    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    peeringState string

    The status of the virtual network peering.

    peeringSyncLevel string

    The peering sync status of the virtual network peering.

    remoteAddressSpace AddressSpaceResponse

    The reference to the address space peered with the remote virtual network.

    remoteBgpCommunities VirtualNetworkBgpCommunitiesResponse

    The reference to the remote virtual network's Bgp Communities.

    remoteVirtualNetwork SubResourceResponse

    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).

    remoteVirtualNetworkAddressSpace AddressSpaceResponse

    The reference to the current address space of the remote virtual network.

    type string

    Resource type.

    useRemoteGateways boolean

    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.

    etag str

    A unique read-only string that changes whenever the resource is updated.

    provisioning_state str

    The provisioning state of the virtual network peering resource.

    remote_virtual_network_encryption VirtualNetworkEncryptionResponse

    The reference to the remote virtual network's encryption

    resource_guid str

    The resourceGuid property of the Virtual Network peering resource.

    allow_forwarded_traffic bool

    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

    allow_gateway_transit bool

    If gateway links can be used in remote virtual networking to link to this virtual network.

    allow_virtual_network_access bool

    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

    do_not_verify_remote_gateways bool

    If we need to verify the provisioning state of the remote gateway.

    id str

    Resource ID.

    name str

    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    peering_state str

    The status of the virtual network peering.

    peering_sync_level str

    The peering sync status of the virtual network peering.

    remote_address_space AddressSpaceResponse

    The reference to the address space peered with the remote virtual network.

    remote_bgp_communities VirtualNetworkBgpCommunitiesResponse

    The reference to the remote virtual network's Bgp Communities.

    remote_virtual_network SubResourceResponse

    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).

    remote_virtual_network_address_space AddressSpaceResponse

    The reference to the current address space of the remote virtual network.

    type str

    Resource type.

    use_remote_gateways bool

    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.

    etag String

    A unique read-only string that changes whenever the resource is updated.

    provisioningState String

    The provisioning state of the virtual network peering resource.

    remoteVirtualNetworkEncryption Property Map

    The reference to the remote virtual network's encryption

    resourceGuid String

    The resourceGuid property of the Virtual Network peering resource.

    allowForwardedTraffic Boolean

    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

    allowGatewayTransit Boolean

    If gateway links can be used in remote virtual networking to link to this virtual network.

    allowVirtualNetworkAccess Boolean

    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

    doNotVerifyRemoteGateways Boolean

    If we need to verify the provisioning state of the remote gateway.

    id String

    Resource ID.

    name String

    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    peeringState String

    The status of the virtual network peering.

    peeringSyncLevel String

    The peering sync status of the virtual network peering.

    remoteAddressSpace Property Map

    The reference to the address space peered with the remote virtual network.

    remoteBgpCommunities Property Map

    The reference to the remote virtual network's Bgp Communities.

    remoteVirtualNetwork Property Map

    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).

    remoteVirtualNetworkAddressSpace Property Map

    The reference to the current address space of the remote virtual network.

    type String

    Resource type.

    useRemoteGateways Boolean

    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.

    Supporting Types

    AddressSpaceResponse

    AddressPrefixes List<string>

    A list of address blocks reserved for this virtual network in CIDR notation.

    AddressPrefixes []string

    A list of address blocks reserved for this virtual network in CIDR notation.

    addressPrefixes List<String>

    A list of address blocks reserved for this virtual network in CIDR notation.

    addressPrefixes string[]

    A list of address blocks reserved for this virtual network in CIDR notation.

    address_prefixes Sequence[str]

    A list of address blocks reserved for this virtual network in CIDR notation.

    addressPrefixes List<String>

    A list of address blocks reserved for this virtual network in CIDR notation.

    SubResourceResponse

    Id string

    Resource ID.

    Id string

    Resource ID.

    id String

    Resource ID.

    id string

    Resource ID.

    id str

    Resource ID.

    id String

    Resource ID.

    VirtualNetworkBgpCommunitiesResponse

    RegionalCommunity string

    The BGP community associated with the region of the virtual network.

    VirtualNetworkCommunity string

    The BGP community associated with the virtual network.

    RegionalCommunity string

    The BGP community associated with the region of the virtual network.

    VirtualNetworkCommunity string

    The BGP community associated with the virtual network.

    regionalCommunity String

    The BGP community associated with the region of the virtual network.

    virtualNetworkCommunity String

    The BGP community associated with the virtual network.

    regionalCommunity string

    The BGP community associated with the region of the virtual network.

    virtualNetworkCommunity string

    The BGP community associated with the virtual network.

    regional_community str

    The BGP community associated with the region of the virtual network.

    virtual_network_community str

    The BGP community associated with the virtual network.

    regionalCommunity String

    The BGP community associated with the region of the virtual network.

    virtualNetworkCommunity String

    The BGP community associated with the virtual network.

    VirtualNetworkEncryptionResponse

    Enabled bool

    Indicates if encryption is enabled on the virtual network.

    Enforcement string

    If the encrypted VNet allows VM that does not support encryption

    Enabled bool

    Indicates if encryption is enabled on the virtual network.

    Enforcement string

    If the encrypted VNet allows VM that does not support encryption

    enabled Boolean

    Indicates if encryption is enabled on the virtual network.

    enforcement String

    If the encrypted VNet allows VM that does not support encryption

    enabled boolean

    Indicates if encryption is enabled on the virtual network.

    enforcement string

    If the encrypted VNet allows VM that does not support encryption

    enabled bool

    Indicates if encryption is enabled on the virtual network.

    enforcement str

    If the encrypted VNet allows VM that does not support encryption

    enabled Boolean

    Indicates if encryption is enabled on the virtual network.

    enforcement String

    If the encrypted VNet allows VM that does not support encryption

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi