1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. VirtualHubBgpConnection
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.47.1 published on Monday, Jun 24, 2024 by Pulumi

azure-native.network.VirtualHubBgpConnection

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.47.1 published on Monday, Jun 24, 2024 by Pulumi

    Virtual Appliance Site resource. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.

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

    Example Usage

    VirtualHubRouteTableV2Put

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var virtualHubBgpConnection = new AzureNative.Network.VirtualHubBgpConnection("virtualHubBgpConnection", new()
        {
            ConnectionName = "conn1",
            HubVirtualNetworkConnection = new AzureNative.Network.Inputs.SubResourceArgs
            {
                Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1",
            },
            PeerAsn = 20000,
            PeerIp = "192.168.1.5",
            ResourceGroupName = "rg1",
            VirtualHubName = "hub1",
        });
    
    });
    
    package main
    
    import (
    	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.NewVirtualHubBgpConnection(ctx, "virtualHubBgpConnection", &network.VirtualHubBgpConnectionArgs{
    			ConnectionName: pulumi.String("conn1"),
    			HubVirtualNetworkConnection: &network.SubResourceArgs{
    				Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1"),
    			},
    			PeerAsn:           pulumi.Float64(20000),
    			PeerIp:            pulumi.String("192.168.1.5"),
    			ResourceGroupName: pulumi.String("rg1"),
    			VirtualHubName:    pulumi.String("hub1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.network.VirtualHubBgpConnection;
    import com.pulumi.azurenative.network.VirtualHubBgpConnectionArgs;
    import com.pulumi.azurenative.network.inputs.SubResourceArgs;
    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) {
            var virtualHubBgpConnection = new VirtualHubBgpConnection("virtualHubBgpConnection", VirtualHubBgpConnectionArgs.builder()
                .connectionName("conn1")
                .hubVirtualNetworkConnection(SubResourceArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1")
                    .build())
                .peerAsn(20000)
                .peerIp("192.168.1.5")
                .resourceGroupName("rg1")
                .virtualHubName("hub1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    virtual_hub_bgp_connection = azure_native.network.VirtualHubBgpConnection("virtualHubBgpConnection",
        connection_name="conn1",
        hub_virtual_network_connection=azure_native.network.SubResourceArgs(
            id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1",
        ),
        peer_asn=20000,
        peer_ip="192.168.1.5",
        resource_group_name="rg1",
        virtual_hub_name="hub1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const virtualHubBgpConnection = new azure_native.network.VirtualHubBgpConnection("virtualHubBgpConnection", {
        connectionName: "conn1",
        hubVirtualNetworkConnection: {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1",
        },
        peerAsn: 20000,
        peerIp: "192.168.1.5",
        resourceGroupName: "rg1",
        virtualHubName: "hub1",
    });
    
    resources:
      virtualHubBgpConnection:
        type: azure-native:network:VirtualHubBgpConnection
        properties:
          connectionName: conn1
          hubVirtualNetworkConnection:
            id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1
          peerAsn: 20000
          peerIp: 192.168.1.5
          resourceGroupName: rg1
          virtualHubName: hub1
    

    Create VirtualHubBgpConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualHubBgpConnection(name: string, args: VirtualHubBgpConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def VirtualHubBgpConnection(resource_name: str,
                                args: VirtualHubBgpConnectionArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def VirtualHubBgpConnection(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                resource_group_name: Optional[str] = None,
                                virtual_hub_name: Optional[str] = None,
                                connection_name: Optional[str] = None,
                                hub_virtual_network_connection: Optional[SubResourceArgs] = None,
                                id: Optional[str] = None,
                                name: Optional[str] = None,
                                peer_asn: Optional[float] = None,
                                peer_ip: Optional[str] = None)
    func NewVirtualHubBgpConnection(ctx *Context, name string, args VirtualHubBgpConnectionArgs, opts ...ResourceOption) (*VirtualHubBgpConnection, error)
    public VirtualHubBgpConnection(string name, VirtualHubBgpConnectionArgs args, CustomResourceOptions? opts = null)
    public VirtualHubBgpConnection(String name, VirtualHubBgpConnectionArgs args)
    public VirtualHubBgpConnection(String name, VirtualHubBgpConnectionArgs args, CustomResourceOptions options)
    
    type: azure-native:network:VirtualHubBgpConnection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VirtualHubBgpConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualHubBgpConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualHubBgpConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualHubBgpConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualHubBgpConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualHubBgpConnectionResource = new AzureNative.Network.VirtualHubBgpConnection("virtualHubBgpConnectionResource", new()
    {
        ResourceGroupName = "string",
        VirtualHubName = "string",
        ConnectionName = "string",
        HubVirtualNetworkConnection = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
        Id = "string",
        Name = "string",
        PeerAsn = 0,
        PeerIp = "string",
    });
    
    example, err := network.NewVirtualHubBgpConnection(ctx, "virtualHubBgpConnectionResource", &network.VirtualHubBgpConnectionArgs{
    ResourceGroupName: pulumi.String("string"),
    VirtualHubName: pulumi.String("string"),
    ConnectionName: pulumi.String("string"),
    HubVirtualNetworkConnection: &network.SubResourceArgs{
    Id: pulumi.String("string"),
    },
    Id: pulumi.String("string"),
    Name: pulumi.String("string"),
    PeerAsn: pulumi.Float64(0),
    PeerIp: pulumi.String("string"),
    })
    
    var virtualHubBgpConnectionResource = new VirtualHubBgpConnection("virtualHubBgpConnectionResource", VirtualHubBgpConnectionArgs.builder()
        .resourceGroupName("string")
        .virtualHubName("string")
        .connectionName("string")
        .hubVirtualNetworkConnection(SubResourceArgs.builder()
            .id("string")
            .build())
        .id("string")
        .name("string")
        .peerAsn(0)
        .peerIp("string")
        .build());
    
    virtual_hub_bgp_connection_resource = azure_native.network.VirtualHubBgpConnection("virtualHubBgpConnectionResource",
        resource_group_name="string",
        virtual_hub_name="string",
        connection_name="string",
        hub_virtual_network_connection=azure_native.network.SubResourceArgs(
            id="string",
        ),
        id="string",
        name="string",
        peer_asn=0,
        peer_ip="string")
    
    const virtualHubBgpConnectionResource = new azure_native.network.VirtualHubBgpConnection("virtualHubBgpConnectionResource", {
        resourceGroupName: "string",
        virtualHubName: "string",
        connectionName: "string",
        hubVirtualNetworkConnection: {
            id: "string",
        },
        id: "string",
        name: "string",
        peerAsn: 0,
        peerIp: "string",
    });
    
    type: azure-native:network:VirtualHubBgpConnection
    properties:
        connectionName: string
        hubVirtualNetworkConnection:
            id: string
        id: string
        name: string
        peerAsn: 0
        peerIp: string
        resourceGroupName: string
        virtualHubName: string
    

    VirtualHubBgpConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VirtualHubBgpConnection resource accepts the following input properties:

    ResourceGroupName string
    The resource group name of the VirtualHub.
    VirtualHubName string
    The name of the VirtualHub.
    ConnectionName string
    The name of the connection.
    HubVirtualNetworkConnection Pulumi.AzureNative.Network.Inputs.SubResource
    The reference to the HubVirtualNetworkConnection resource.
    Id string
    Resource ID.
    Name string
    Name of the connection.
    PeerAsn double
    Peer ASN.
    PeerIp string
    Peer IP.
    ResourceGroupName string
    The resource group name of the VirtualHub.
    VirtualHubName string
    The name of the VirtualHub.
    ConnectionName string
    The name of the connection.
    HubVirtualNetworkConnection SubResourceArgs
    The reference to the HubVirtualNetworkConnection resource.
    Id string
    Resource ID.
    Name string
    Name of the connection.
    PeerAsn float64
    Peer ASN.
    PeerIp string
    Peer IP.
    resourceGroupName String
    The resource group name of the VirtualHub.
    virtualHubName String
    The name of the VirtualHub.
    connectionName String
    The name of the connection.
    hubVirtualNetworkConnection SubResource
    The reference to the HubVirtualNetworkConnection resource.
    id String
    Resource ID.
    name String
    Name of the connection.
    peerAsn Double
    Peer ASN.
    peerIp String
    Peer IP.
    resourceGroupName string
    The resource group name of the VirtualHub.
    virtualHubName string
    The name of the VirtualHub.
    connectionName string
    The name of the connection.
    hubVirtualNetworkConnection SubResource
    The reference to the HubVirtualNetworkConnection resource.
    id string
    Resource ID.
    name string
    Name of the connection.
    peerAsn number
    Peer ASN.
    peerIp string
    Peer IP.
    resource_group_name str
    The resource group name of the VirtualHub.
    virtual_hub_name str
    The name of the VirtualHub.
    connection_name str
    The name of the connection.
    hub_virtual_network_connection SubResourceArgs
    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.
    resourceGroupName String
    The resource group name of the VirtualHub.
    virtualHubName String
    The name of the VirtualHub.
    connectionName String
    The name of the connection.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualHubBgpConnection resource produces the following output properties:

    ConnectionState string
    The current state of the VirtualHub to Peer.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    Connection type.
    ConnectionState string
    The current state of the VirtualHub to Peer.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    Connection type.
    connectionState String
    The current state of the VirtualHub to Peer.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    The provisioning state of the resource.
    type String
    Connection type.
    connectionState string
    The current state of the VirtualHub to Peer.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    provisioningState string
    The provisioning state of the resource.
    type string
    Connection type.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    provisioning_state str
    The provisioning state of the resource.
    type str
    Connection type.
    connectionState String
    The current state of the VirtualHub to Peer.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    The provisioning state of the resource.
    type String
    Connection type.

    Supporting Types

    SubResource, SubResourceArgs

    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id str
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.

    SubResourceResponse, SubResourceResponseArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:VirtualHubBgpConnection conn1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.47.1 published on Monday, Jun 24, 2024 by Pulumi