1. Docs
  2. Reference
  3. API
  4. Azure
  5. network
  6. ExpressRouteGateway

ExpressRouteGateway

Manages an ExpressRoute gateway.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleVirtualWan = new Azure.Network.VirtualWan("exampleVirtualWan", new Azure.Network.VirtualWanArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
        });
        var exampleVirtualHub = new Azure.Network.VirtualHub("exampleVirtualHub", new Azure.Network.VirtualHubArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            VirtualWanId = exampleVirtualWan.Id,
            AddressPrefix = "10.0.1.0/24",
        });
        var exampleExpressRouteGateway = new Azure.Network.ExpressRouteGateway("exampleExpressRouteGateway", new Azure.Network.ExpressRouteGatewayArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            VirtualHubId = exampleVirtualHub.Id,
            ScaleUnits = 1,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/network"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West Europe"),
        })
        if err != nil {
            return err
        }
        exampleVirtualWan, err := network.NewVirtualWan(ctx, "exampleVirtualWan", &network.VirtualWanArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
        })
        if err != nil {
            return err
        }
        exampleVirtualHub, err := network.NewVirtualHub(ctx, "exampleVirtualHub", &network.VirtualHubArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
            VirtualWanId:      exampleVirtualWan.ID(),
            AddressPrefix:     pulumi.String("10.0.1.0/24"),
        })
        if err != nil {
            return err
        }
        _, err = network.NewExpressRouteGateway(ctx, "exampleExpressRouteGateway", &network.ExpressRouteGatewayArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
            VirtualHubId:      exampleVirtualHub.ID(),
            ScaleUnits:        pulumi.Int(1),
            Tags: pulumi.Map{
                "environment": pulumi.String("Production"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_wan = azure.network.VirtualWan("exampleVirtualWan",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_virtual_hub = azure.network.VirtualHub("exampleVirtualHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.1.0/24")
example_express_route_gateway = azure.network.ExpressRouteGateway("exampleExpressRouteGateway",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    virtual_hub_id=example_virtual_hub.id,
    scale_units=1,
    tags={
        "environment": "Production",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualWan = new azure.network.VirtualWan("exampleVirtualWan", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("exampleVirtualHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.1.0/24",
});
const exampleExpressRouteGateway = new azure.network.ExpressRouteGateway("exampleExpressRouteGateway", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    virtualHubId: exampleVirtualHub.id,
    scaleUnits: 1,
    tags: {
        environment: "Production",
    },
});

Create a ExpressRouteGateway Resource

new ExpressRouteGateway(name: string, args: ExpressRouteGatewayArgs, opts?: CustomResourceOptions);
def ExpressRouteGateway(resource_name, opts=None, location=None, name=None, resource_group_name=None, scale_units=None, tags=None, virtual_hub_id=None, __props__=None);
func NewExpressRouteGateway(ctx *Context, name string, args ExpressRouteGatewayArgs, opts ...ResourceOption) (*ExpressRouteGateway, error)
public ExpressRouteGateway(string name, ExpressRouteGatewayArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ExpressRouteGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ExpressRouteGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ExpressRouteGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ExpressRouteGateway Resource Properties

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

Inputs

The ExpressRouteGateway resource accepts the following input properties:

ResourceGroupName string

The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

ScaleUnits int

The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

VirtualHubId string

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

ResourceGroupName string

The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

ScaleUnits int

The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

VirtualHubId string

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

Tags map[string]string

A mapping of tags to assign to the resource.

resourceGroupName string

The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

scaleUnits number

The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

virtualHubId string

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name string

The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

resource_group_name str

The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

scale_units float

The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

virtual_hub_id str

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name str

The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

tags Dict[str, str]

A mapping of tags to assign to the resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing ExpressRouteGateway Resource

Get an existing ExpressRouteGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ExpressRouteGatewayState, opts?: CustomResourceOptions): ExpressRouteGateway
static get(resource_name, id, opts=None, location=None, name=None, resource_group_name=None, scale_units=None, tags=None, virtual_hub_id=None, __props__=None);
func GetExpressRouteGateway(ctx *Context, name string, id IDInput, state *ExpressRouteGatewayState, opts ...ResourceOption) (*ExpressRouteGateway, error)
public static ExpressRouteGateway Get(string name, Input<string> id, ExpressRouteGatewayState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

ScaleUnits int

The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

VirtualHubId string

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

ScaleUnits int

The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

Tags map[string]string

A mapping of tags to assign to the resource.

VirtualHubId string

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name string

The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

scaleUnits number

The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

tags {[key: string]: string}

A mapping of tags to assign to the resource.

virtualHubId string

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name str

The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

resource_group_name str

The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

scale_units float

The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

tags Dict[str, str]

A mapping of tags to assign to the resource.

virtual_hub_id str

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.