com.pulumi.azure.network.VirtualHub Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.network;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.network.VirtualHubArgs;
import com.pulumi.azure.network.inputs.VirtualHubState;
import com.pulumi.azure.network.outputs.VirtualHubRoute;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages a Virtual Hub within a Virtual WAN.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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 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.0.0/23")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Virtual Hub's can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:network/virtualHub:VirtualHub example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/virtualHubs/hub1
* ```
*
*/
@ResourceType(type="azure:network/virtualHub:VirtualHub")
public class VirtualHub extends com.pulumi.resources.CustomResource {
/**
* The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. [The address prefix subnet cannot be smaller than a `/24`. Azure recommends using a `/23`](https://docs.microsoft.com/azure/virtual-wan/virtual-wan-faq#what-is-the-recommended-hub-address-space-during-hub-creation).
*
*/
@Export(name="addressPrefix", refs={String.class}, tree="[0]")
private Output addressPrefix;
/**
* @return The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. [The address prefix subnet cannot be smaller than a `/24`. Azure recommends using a `/23`](https://docs.microsoft.com/azure/virtual-wan/virtual-wan-faq#what-is-the-recommended-hub-address-space-during-hub-creation).
*
*/
public Output> addressPrefix() {
return Codegen.optional(this.addressPrefix);
}
/**
* The ID of the default Route Table in the Virtual Hub.
*
*/
@Export(name="defaultRouteTableId", refs={String.class}, tree="[0]")
private Output defaultRouteTableId;
/**
* @return The ID of the default Route Table in the Virtual Hub.
*
*/
public Output defaultRouteTableId() {
return this.defaultRouteTableId;
}
/**
* The hub routing preference. Possible values are `ExpressRoute`, `ASPath` and `VpnGateway`. Defaults to `ExpressRoute`.
*
*/
@Export(name="hubRoutingPreference", refs={String.class}, tree="[0]")
private Output hubRoutingPreference;
/**
* @return The hub routing preference. Possible values are `ExpressRoute`, `ASPath` and `VpnGateway`. Defaults to `ExpressRoute`.
*
*/
public Output> hubRoutingPreference() {
return Codegen.optional(this.hubRoutingPreference);
}
/**
* Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
*
*/
public Output location() {
return this.location;
}
/**
* The name of the Virtual Hub. Changing this forces a new resource to be created.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the Virtual Hub. Changing this forces a new resource to be created.
*
*/
public Output name() {
return this.name;
}
/**
* Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
*
*/
@Export(name="resourceGroupName", refs={String.class}, tree="[0]")
private Output resourceGroupName;
/**
* @return Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* One or more `route` blocks as defined below.
*
*/
@Export(name="routes", refs={List.class,VirtualHubRoute.class}, tree="[0,1]")
private Output> routes;
/**
* @return One or more `route` blocks as defined below.
*
*/
public Output>> routes() {
return Codegen.optional(this.routes);
}
/**
* The SKU of the Virtual Hub. Possible values are `Basic` and `Standard`. Changing this forces a new resource to be created.
*
*/
@Export(name="sku", refs={String.class}, tree="[0]")
private Output sku;
/**
* @return The SKU of the Virtual Hub. Possible values are `Basic` and `Standard`. Changing this forces a new resource to be created.
*
*/
public Output> sku() {
return Codegen.optional(this.sku);
}
/**
* A mapping of tags to assign to the Virtual Hub.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return A mapping of tags to assign to the Virtual Hub.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* The Autonomous System Number of the Virtual Hub BGP router.
*
*/
@Export(name="virtualRouterAsn", refs={Integer.class}, tree="[0]")
private Output virtualRouterAsn;
/**
* @return The Autonomous System Number of the Virtual Hub BGP router.
*
*/
public Output virtualRouterAsn() {
return this.virtualRouterAsn;
}
/**
* Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
*
*/
@Export(name="virtualRouterAutoScaleMinCapacity", refs={Integer.class}, tree="[0]")
private Output virtualRouterAutoScaleMinCapacity;
/**
* @return Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
*
*/
public Output> virtualRouterAutoScaleMinCapacity() {
return Codegen.optional(this.virtualRouterAutoScaleMinCapacity);
}
/**
* The IP addresses of the Virtual Hub BGP router.
*
*/
@Export(name="virtualRouterIps", refs={List.class,String.class}, tree="[0,1]")
private Output> virtualRouterIps;
/**
* @return The IP addresses of the Virtual Hub BGP router.
*
*/
public Output> virtualRouterIps() {
return this.virtualRouterIps;
}
/**
* The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.
*
*/
@Export(name="virtualWanId", refs={String.class}, tree="[0]")
private Output virtualWanId;
/**
* @return The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.
*
*/
public Output> virtualWanId() {
return Codegen.optional(this.virtualWanId);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public VirtualHub(java.lang.String name) {
this(name, VirtualHubArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public VirtualHub(java.lang.String name, VirtualHubArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public VirtualHub(java.lang.String name, VirtualHubArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:network/virtualHub:VirtualHub", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private VirtualHub(java.lang.String name, Output id, @Nullable VirtualHubState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:network/virtualHub:VirtualHub", name, state, makeResourceOptions(options, id), false);
}
private static VirtualHubArgs makeArgs(VirtualHubArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? VirtualHubArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static VirtualHub get(java.lang.String name, Output id, @Nullable VirtualHubState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new VirtualHub(name, id, state, options);
}
}