All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.network.kotlin.ExpressRouteGatewayArgs.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 6.15.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.network.kotlin

import com.pulumi.azure.network.ExpressRouteGatewayArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Int
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName

/**
 * Manages an ExpressRoute gateway.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleVirtualWan = new azure.network.VirtualWan("example", {
 *     name: "example-virtualwan",
 *     resourceGroupName: example.name,
 *     location: example.location,
 * });
 * const exampleVirtualHub = new azure.network.VirtualHub("example", {
 *     name: "example-virtualhub",
 *     resourceGroupName: example.name,
 *     location: example.location,
 *     virtualWanId: exampleVirtualWan.id,
 *     addressPrefix: "10.0.1.0/24",
 * });
 * const exampleExpressRouteGateway = new azure.network.ExpressRouteGateway("example", {
 *     name: "expressRoute1",
 *     resourceGroupName: example.name,
 *     location: example.location,
 *     virtualHubId: exampleVirtualHub.id,
 *     scaleUnits: 1,
 *     tags: {
 *         environment: "Production",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_virtual_wan = azure.network.VirtualWan("example",
 *     name="example-virtualwan",
 *     resource_group_name=example.name,
 *     location=example.location)
 * example_virtual_hub = azure.network.VirtualHub("example",
 *     name="example-virtualhub",
 *     resource_group_name=example.name,
 *     location=example.location,
 *     virtual_wan_id=example_virtual_wan.id,
 *     address_prefix="10.0.1.0/24")
 * example_express_route_gateway = azure.network.ExpressRouteGateway("example",
 *     name="expressRoute1",
 *     resource_group_name=example.name,
 *     location=example.location,
 *     virtual_hub_id=example_virtual_hub.id,
 *     scale_units=1,
 *     tags={
 *         "environment": "Production",
 *     })
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleVirtualWan = new Azure.Network.VirtualWan("example", new()
 *     {
 *         Name = "example-virtualwan",
 *         ResourceGroupName = example.Name,
 *         Location = example.Location,
 *     });
 *     var exampleVirtualHub = new Azure.Network.VirtualHub("example", new()
 *     {
 *         Name = "example-virtualhub",
 *         ResourceGroupName = example.Name,
 *         Location = example.Location,
 *         VirtualWanId = exampleVirtualWan.Id,
 *         AddressPrefix = "10.0.1.0/24",
 *     });
 *     var exampleExpressRouteGateway = new Azure.Network.ExpressRouteGateway("example", new()
 *     {
 *         Name = "expressRoute1",
 *         ResourceGroupName = example.Name,
 *         Location = example.Location,
 *         VirtualHubId = exampleVirtualHub.Id,
 *         ScaleUnits = 1,
 *         Tags =
 *         {
 *             { "environment", "Production" },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleVirtualWan, err := network.NewVirtualWan(ctx, "example", &network.VirtualWanArgs{
 * 			Name:              pulumi.String("example-virtualwan"),
 * 			ResourceGroupName: example.Name,
 * 			Location:          example.Location,
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleVirtualHub, err := network.NewVirtualHub(ctx, "example", &network.VirtualHubArgs{
 * 			Name:              pulumi.String("example-virtualhub"),
 * 			ResourceGroupName: example.Name,
 * 			Location:          example.Location,
 * 			VirtualWanId:      exampleVirtualWan.ID(),
 * 			AddressPrefix:     pulumi.String("10.0.1.0/24"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = network.NewExpressRouteGateway(ctx, "example", &network.ExpressRouteGatewayArgs{
 * 			Name:              pulumi.String("expressRoute1"),
 * 			ResourceGroupName: example.Name,
 * 			Location:          example.Location,
 * 			VirtualHubId:      exampleVirtualHub.ID(),
 * 			ScaleUnits:        pulumi.Int(1),
 * 			Tags: pulumi.StringMap{
 * 				"environment": pulumi.String("Production"),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azure.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.network.VirtualWan;
 * import com.pulumi.azure.network.VirtualWanArgs;
 * import com.pulumi.azure.network.VirtualHub;
 * import com.pulumi.azure.network.VirtualHubArgs;
 * import com.pulumi.azure.network.ExpressRouteGateway;
 * import com.pulumi.azure.network.ExpressRouteGatewayArgs;
 * 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleVirtualWan = new VirtualWan("exampleVirtualWan", VirtualWanArgs.builder()
 *             .name("example-virtualwan")
 *             .resourceGroupName(example.name())
 *             .location(example.location())
 *             .build());
 *         var exampleVirtualHub = new VirtualHub("exampleVirtualHub", VirtualHubArgs.builder()
 *             .name("example-virtualhub")
 *             .resourceGroupName(example.name())
 *             .location(example.location())
 *             .virtualWanId(exampleVirtualWan.id())
 *             .addressPrefix("10.0.1.0/24")
 *             .build());
 *         var exampleExpressRouteGateway = new ExpressRouteGateway("exampleExpressRouteGateway", ExpressRouteGatewayArgs.builder()
 *             .name("expressRoute1")
 *             .resourceGroupName(example.name())
 *             .location(example.location())
 *             .virtualHubId(exampleVirtualHub.id())
 *             .scaleUnits(1)
 *             .tags(Map.of("environment", "Production"))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleVirtualWan:
 *     type: azure:network:VirtualWan
 *     name: example
 *     properties:
 *       name: example-virtualwan
 *       resourceGroupName: ${example.name}
 *       location: ${example.location}
 *   exampleVirtualHub:
 *     type: azure:network:VirtualHub
 *     name: example
 *     properties:
 *       name: example-virtualhub
 *       resourceGroupName: ${example.name}
 *       location: ${example.location}
 *       virtualWanId: ${exampleVirtualWan.id}
 *       addressPrefix: 10.0.1.0/24
 *   exampleExpressRouteGateway:
 *     type: azure:network:ExpressRouteGateway
 *     name: example
 *     properties:
 *       name: expressRoute1
 *       resourceGroupName: ${example.name}
 *       location: ${example.location}
 *       virtualHubId: ${exampleVirtualHub.id}
 *       scaleUnits: 1
 *       tags:
 *         environment: Production
 * ```
 * 
 * ## Import
 * ExpressRoute Gateways can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:network/expressRouteGateway:ExpressRouteGateway example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/expressRouteGateways/myExpressRouteGateway
 * ```
 * @property allowNonVirtualWanTraffic Specified whether this gateway accept traffic from non-Virtual WAN networks. Defaults to `false`.
 * @property location Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
 * @property name The name of the ExpressRoute gateway. Changing this forces a new resource to be created.
 * @property resourceGroupName The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.
 * @property scaleUnits 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).
 * @property tags A mapping of tags to assign to the resource.
 * @property virtualHubId The ID of a Virtual HUB within which the ExpressRoute gateway should be created. Changing this forces a new resource to be created.
 */
public data class ExpressRouteGatewayArgs(
    public val allowNonVirtualWanTraffic: Output? = null,
    public val location: Output? = null,
    public val name: Output? = null,
    public val resourceGroupName: Output? = null,
    public val scaleUnits: Output? = null,
    public val tags: Output>? = null,
    public val virtualHubId: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.network.ExpressRouteGatewayArgs =
        com.pulumi.azure.network.ExpressRouteGatewayArgs.builder()
            .allowNonVirtualWanTraffic(allowNonVirtualWanTraffic?.applyValue({ args0 -> args0 }))
            .location(location?.applyValue({ args0 -> args0 }))
            .name(name?.applyValue({ args0 -> args0 }))
            .resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
            .scaleUnits(scaleUnits?.applyValue({ args0 -> args0 }))
            .tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
            .virtualHubId(virtualHubId?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ExpressRouteGatewayArgs].
 */
@PulumiTagMarker
public class ExpressRouteGatewayArgsBuilder internal constructor() {
    private var allowNonVirtualWanTraffic: Output? = null

    private var location: Output? = null

    private var name: Output? = null

    private var resourceGroupName: Output? = null

    private var scaleUnits: Output? = null

    private var tags: Output>? = null

    private var virtualHubId: Output? = null

    /**
     * @param value Specified whether this gateway accept traffic from non-Virtual WAN networks. Defaults to `false`.
     */
    @JvmName("doakvvqxhsaojtri")
    public suspend fun allowNonVirtualWanTraffic(`value`: Output) {
        this.allowNonVirtualWanTraffic = value
    }

    /**
     * @param value Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
     */
    @JvmName("btyrfwgcfigqdojb")
    public suspend fun location(`value`: Output) {
        this.location = value
    }

    /**
     * @param value The name of the ExpressRoute gateway. Changing this forces a new resource to be created.
     */
    @JvmName("xksbnendejryljoj")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.
     */
    @JvmName("wbnrehyrtlsfccqg")
    public suspend fun resourceGroupName(`value`: Output) {
        this.resourceGroupName = value
    }

    /**
     * @param value 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).
     */
    @JvmName("somhrhkdiqkkeegv")
    public suspend fun scaleUnits(`value`: Output) {
        this.scaleUnits = value
    }

    /**
     * @param value A mapping of tags to assign to the resource.
     */
    @JvmName("nloimtqctcaedvoe")
    public suspend fun tags(`value`: Output>) {
        this.tags = value
    }

    /**
     * @param value The ID of a Virtual HUB within which the ExpressRoute gateway should be created. Changing this forces a new resource to be created.
     */
    @JvmName("oekkjhbkrnanxter")
    public suspend fun virtualHubId(`value`: Output) {
        this.virtualHubId = value
    }

    /**
     * @param value Specified whether this gateway accept traffic from non-Virtual WAN networks. Defaults to `false`.
     */
    @JvmName("uetqfualukuqyhkt")
    public suspend fun allowNonVirtualWanTraffic(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.allowNonVirtualWanTraffic = mapped
    }

    /**
     * @param value Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
     */
    @JvmName("ypiywvrdbymlxdth")
    public suspend fun location(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.location = mapped
    }

    /**
     * @param value The name of the ExpressRoute gateway. Changing this forces a new resource to be created.
     */
    @JvmName("kajchgycylpbadgg")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.
     */
    @JvmName("eyjclvpgnemcftqv")
    public suspend fun resourceGroupName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.resourceGroupName = mapped
    }

    /**
     * @param value 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).
     */
    @JvmName("gvbxajqxxauhshhj")
    public suspend fun scaleUnits(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.scaleUnits = mapped
    }

    /**
     * @param value A mapping of tags to assign to the resource.
     */
    @JvmName("skbalumtfsmpslky")
    public suspend fun tags(`value`: Map?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param values A mapping of tags to assign to the resource.
     */
    @JvmName("bmpkvlejihyvbwui")
    public fun tags(vararg values: Pair) {
        val toBeMapped = values.toMap()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param value The ID of a Virtual HUB within which the ExpressRoute gateway should be created. Changing this forces a new resource to be created.
     */
    @JvmName("rjfukalmkqjwcisf")
    public suspend fun virtualHubId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.virtualHubId = mapped
    }

    internal fun build(): ExpressRouteGatewayArgs = ExpressRouteGatewayArgs(
        allowNonVirtualWanTraffic = allowNonVirtualWanTraffic,
        location = location,
        name = name,
        resourceGroupName = resourceGroupName,
        scaleUnits = scaleUnits,
        tags = tags,
        virtualHubId = virtualHubId,
    )
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy