Docs Packages
  1. Pulumi Registry
  2. Azure Native
  3. API Docs
  4. network
  5. VirtualRouter
azure-native logo
Azure Native v1.102.0, May 2 23

azure-native.network.VirtualRouter

Explore with Pulumi AI

VirtualRouter Resource. API Version: 2022-01-01.

Example Usage

Create VirtualRouter

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var virtualRouter = new AzureNative.Network.VirtualRouter("virtualRouter", new()
    {
        HostedGateway = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway",
        },
        Location = "West US",
        ResourceGroupName = "rg1",
        Tags = 
        {
            { "key1", "value1" },
        },
        VirtualRouterName = "virtualRouter",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewVirtualRouter(ctx, "virtualRouter", &network.VirtualRouterArgs{
			HostedGateway: &network.SubResourceArgs{
				Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway"),
			},
			Location:          pulumi.String("West US"),
			ResourceGroupName: pulumi.String("rg1"),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
			},
			VirtualRouterName: pulumi.String("virtualRouter"),
		})
		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.VirtualRouter;
import com.pulumi.azurenative.network.VirtualRouterArgs;
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 virtualRouter = new VirtualRouter("virtualRouter", VirtualRouterArgs.builder()        
            .hostedGateway(Map.of("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway"))
            .location("West US")
            .resourceGroupName("rg1")
            .tags(Map.of("key1", "value1"))
            .virtualRouterName("virtualRouter")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

virtual_router = azure_native.network.VirtualRouter("virtualRouter",
    hosted_gateway=azure_native.network.SubResourceArgs(
        id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway",
    ),
    location="West US",
    resource_group_name="rg1",
    tags={
        "key1": "value1",
    },
    virtual_router_name="virtualRouter")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const virtualRouter = new azure_native.network.VirtualRouter("virtualRouter", {
    hostedGateway: {
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway",
    },
    location: "West US",
    resourceGroupName: "rg1",
    tags: {
        key1: "value1",
    },
    virtualRouterName: "virtualRouter",
});

resources:
  virtualRouter:
    type: azure-native:network:VirtualRouter
    properties:
      hostedGateway:
        id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway
      location: West US
      resourceGroupName: rg1
      tags:
        key1: value1
      virtualRouterName: virtualRouter

Create VirtualRouter Resource

new VirtualRouter(name: string, args: VirtualRouterArgs, opts?: CustomResourceOptions);
@overload
def VirtualRouter(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  hosted_gateway: Optional[SubResourceArgs] = None,
                  hosted_subnet: Optional[SubResourceArgs] = None,
                  id: Optional[str] = None,
                  location: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  virtual_router_asn: Optional[float] = None,
                  virtual_router_ips: Optional[Sequence[str]] = None,
                  virtual_router_name: Optional[str] = None)
@overload
def VirtualRouter(resource_name: str,
                  args: VirtualRouterArgs,
                  opts: Optional[ResourceOptions] = None)
func NewVirtualRouter(ctx *Context, name string, args VirtualRouterArgs, opts ...ResourceOption) (*VirtualRouter, error)
public VirtualRouter(string name, VirtualRouterArgs args, CustomResourceOptions? opts = null)
public VirtualRouter(String name, VirtualRouterArgs args)
public VirtualRouter(String name, VirtualRouterArgs args, CustomResourceOptions options)

type: azure-native:network:VirtualRouter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VirtualRouterArgs
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 VirtualRouterArgs
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 VirtualRouterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VirtualRouterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args VirtualRouterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

VirtualRouter 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 VirtualRouter resource accepts the following input properties:

ResourceGroupName string

The name of the resource group.

HostedGateway Pulumi.AzureNative.Network.Inputs.SubResourceArgs

The Gateway on which VirtualRouter is hosted.

HostedSubnet Pulumi.AzureNative.Network.Inputs.SubResourceArgs

The Subnet on which VirtualRouter is hosted.

Id string

Resource ID.

Location string

Resource location.

Tags Dictionary<string, string>

Resource tags.

VirtualRouterAsn double

VirtualRouter ASN.

VirtualRouterIps List<string>

VirtualRouter IPs.

VirtualRouterName string

The name of the Virtual Router.

ResourceGroupName string

The name of the resource group.

HostedGateway SubResourceArgs

The Gateway on which VirtualRouter is hosted.

HostedSubnet SubResourceArgs

The Subnet on which VirtualRouter is hosted.

Id string

Resource ID.

Location string

Resource location.

Tags map[string]string

Resource tags.

VirtualRouterAsn float64

VirtualRouter ASN.

VirtualRouterIps []string

VirtualRouter IPs.

VirtualRouterName string

The name of the Virtual Router.

resourceGroupName String

The name of the resource group.

hostedGateway SubResourceArgs

The Gateway on which VirtualRouter is hosted.

hostedSubnet SubResourceArgs

The Subnet on which VirtualRouter is hosted.

id String

Resource ID.

location String

Resource location.

tags Map<String,String>

Resource tags.

virtualRouterAsn Double

VirtualRouter ASN.

virtualRouterIps List<String>

VirtualRouter IPs.

virtualRouterName String

The name of the Virtual Router.

resourceGroupName string

The name of the resource group.

hostedGateway SubResourceArgs

The Gateway on which VirtualRouter is hosted.

hostedSubnet SubResourceArgs

The Subnet on which VirtualRouter is hosted.

id string

Resource ID.

location string

Resource location.

tags {[key: string]: string}

Resource tags.

virtualRouterAsn number

VirtualRouter ASN.

virtualRouterIps string[]

VirtualRouter IPs.

virtualRouterName string

The name of the Virtual Router.

resource_group_name str

The name of the resource group.

hosted_gateway SubResourceArgs

The Gateway on which VirtualRouter is hosted.

hosted_subnet SubResourceArgs

The Subnet on which VirtualRouter is hosted.

id str

Resource ID.

location str

Resource location.

tags Mapping[str, str]

Resource tags.

virtual_router_asn float

VirtualRouter ASN.

virtual_router_ips Sequence[str]

VirtualRouter IPs.

virtual_router_name str

The name of the Virtual Router.

resourceGroupName String

The name of the resource group.

hostedGateway Property Map

The Gateway on which VirtualRouter is hosted.

hostedSubnet Property Map

The Subnet on which VirtualRouter is hosted.

id String

Resource ID.

location String

Resource location.

tags Map<String>

Resource tags.

virtualRouterAsn Number

VirtualRouter ASN.

virtualRouterIps List<String>

VirtualRouter IPs.

virtualRouterName String

The name of the Virtual Router.

Outputs

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

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.

Name string

Resource name.

Peerings List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>

List of references to VirtualRouterPeerings.

ProvisioningState string

The provisioning state of the resource.

Type string

Resource type.

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.

Name string

Resource name.

Peerings []SubResourceResponse

List of references to VirtualRouterPeerings.

ProvisioningState string

The provisioning state of the resource.

Type string

Resource type.

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.

name String

Resource name.

peerings List<SubResourceResponse>

List of references to VirtualRouterPeerings.

provisioningState String

The provisioning state of the resource.

type String

Resource type.

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.

name string

Resource name.

peerings SubResourceResponse[]

List of references to VirtualRouterPeerings.

provisioningState string

The provisioning state of the resource.

type string

Resource type.

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.

name str

Resource name.

peerings Sequence[SubResourceResponse]

List of references to VirtualRouterPeerings.

provisioning_state str

The provisioning state of the resource.

type str

Resource type.

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.

name String

Resource name.

peerings List<Property Map>

List of references to VirtualRouterPeerings.

provisioningState String

The provisioning state of the resource.

type String

Resource type.

Supporting Types

SubResource

Id string

Resource Id.

Id string

Resource Id.

id String

Resource Id.

id string

Resource Id.

id str

Resource Id.

id String

Resource Id.

SubResourceResponse

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:VirtualRouter virtualRouter /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0