Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVirtualHubBgpConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getVirtualHubBgpConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves the details of a Virtual Hub Bgp Connection.

Uses 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 getVirtualHubBgpConnection

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 getVirtualHubBgpConnection(args: GetVirtualHubBgpConnectionArgs, opts?: InvokeOptions): Promise<GetVirtualHubBgpConnectionResult>
function getVirtualHubBgpConnectionOutput(args: GetVirtualHubBgpConnectionOutputArgs, opts?: InvokeOptions): Output<GetVirtualHubBgpConnectionResult>
Copy
def get_virtual_hub_bgp_connection(connection_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   virtual_hub_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetVirtualHubBgpConnectionResult
def get_virtual_hub_bgp_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                   virtual_hub_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetVirtualHubBgpConnectionResult]
Copy
func LookupVirtualHubBgpConnection(ctx *Context, args *LookupVirtualHubBgpConnectionArgs, opts ...InvokeOption) (*LookupVirtualHubBgpConnectionResult, error)
func LookupVirtualHubBgpConnectionOutput(ctx *Context, args *LookupVirtualHubBgpConnectionOutputArgs, opts ...InvokeOption) LookupVirtualHubBgpConnectionResultOutput
Copy

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

public static class GetVirtualHubBgpConnection 
{
    public static Task<GetVirtualHubBgpConnectionResult> InvokeAsync(GetVirtualHubBgpConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualHubBgpConnectionResult> Invoke(GetVirtualHubBgpConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualHubBgpConnectionResult> getVirtualHubBgpConnection(GetVirtualHubBgpConnectionArgs args, InvokeOptions options)
public static Output<GetVirtualHubBgpConnectionResult> getVirtualHubBgpConnection(GetVirtualHubBgpConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVirtualHubBgpConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VirtualHub.
VirtualHubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VirtualHub.
ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VirtualHub.
VirtualHubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VirtualHub.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the VirtualHub.
virtualHubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the VirtualHub.
connectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VirtualHub.
virtualHubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VirtualHub.
connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the connection.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name of the VirtualHub.
virtual_hub_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the VirtualHub.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the VirtualHub.
virtualHubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the VirtualHub.

getVirtualHubBgpConnection Result

The following output properties are available:

ConnectionState string
The current state of the VirtualHub to Peer.
Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the resource.
Type string
Connection type.
HubVirtualNetworkConnection Pulumi.AzureNative.Network.Outputs.SubResourceResponse
The reference to the HubVirtualNetworkConnection resource.
Id string
Resource ID.
Name string
Name of the connection.
PeerAsn double
Peer ASN.
PeerIp string
Peer IP.
ConnectionState string
The current state of the VirtualHub to Peer.
Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the resource.
Type string
Connection type.
HubVirtualNetworkConnection SubResourceResponse
The reference to the HubVirtualNetworkConnection resource.
Id string
Resource ID.
Name string
Name of the connection.
PeerAsn float64
Peer ASN.
PeerIp string
Peer IP.
connectionState String
The current state of the VirtualHub to Peer.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the resource.
type String
Connection type.
hubVirtualNetworkConnection SubResourceResponse
The reference to the HubVirtualNetworkConnection resource.
id String
Resource ID.
name String
Name of the connection.
peerAsn Double
Peer ASN.
peerIp String
Peer IP.
connectionState string
The current state of the VirtualHub to Peer.
etag string
A unique read-only string that changes whenever the resource is updated.
provisioningState string
The provisioning state of the resource.
type string
Connection type.
hubVirtualNetworkConnection SubResourceResponse
The reference to the HubVirtualNetworkConnection resource.
id string
Resource ID.
name string
Name of the connection.
peerAsn number
Peer ASN.
peerIp string
Peer IP.
connection_state str
The current state of the VirtualHub to Peer.
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
Connection type.
hub_virtual_network_connection SubResourceResponse
The reference to the HubVirtualNetworkConnection resource.
id str
Resource ID.
name str
Name of the connection.
peer_asn float
Peer ASN.
peer_ip str
Peer IP.
connectionState String
The current state of the VirtualHub to Peer.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the resource.
type String
Connection type.
hubVirtualNetworkConnection Property Map
The reference to the HubVirtualNetworkConnection resource.
id String
Resource ID.
name String
Name of the connection.
peerAsn Number
Peer ASN.
peerIp String
Peer IP.

Supporting Types

SubResourceResponse

Id This property is required. string
Resource ID.
Id This property is required. string
Resource ID.
id This property is required. String
Resource ID.
id This property is required. string
Resource ID.
id This property is required. str
Resource ID.
id This property is required. String
Resource ID.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native