Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. ExpressRouteCircuitAuthorization

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.network.ExpressRouteCircuitAuthorization

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an ExpressRoute Circuit Authorization.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "exprtTest",
    location: "West Europe",
});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("example", {
    name: "expressRoute1",
    resourceGroupName: example.name,
    location: example.location,
    serviceProviderName: "Equinix",
    peeringLocation: "Silicon Valley",
    bandwidthInMbps: 50,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
    allowClassicOperations: false,
    tags: {
        environment: "Production",
    },
});
const exampleExpressRouteCircuitAuthorization = new azure.network.ExpressRouteCircuitAuthorization("example", {
    name: "exampleERCAuth",
    expressRouteCircuitName: exampleExpressRouteCircuit.name,
    resourceGroupName: example.name,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="exprtTest",
    location="West Europe")
example_express_route_circuit = azure.network.ExpressRouteCircuit("example",
    name="expressRoute1",
    resource_group_name=example.name,
    location=example.location,
    service_provider_name="Equinix",
    peering_location="Silicon Valley",
    bandwidth_in_mbps=50,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    },
    allow_classic_operations=False,
    tags={
        "environment": "Production",
    })
example_express_route_circuit_authorization = azure.network.ExpressRouteCircuitAuthorization("example",
    name="exampleERCAuth",
    express_route_circuit_name=example_express_route_circuit.name,
    resource_group_name=example.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/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("exprtTest"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleExpressRouteCircuit, err := network.NewExpressRouteCircuit(ctx, "example", &network.ExpressRouteCircuitArgs{
			Name:                pulumi.String("expressRoute1"),
			ResourceGroupName:   example.Name,
			Location:            example.Location,
			ServiceProviderName: pulumi.String("Equinix"),
			PeeringLocation:     pulumi.String("Silicon Valley"),
			BandwidthInMbps:     pulumi.Int(50),
			Sku: &network.ExpressRouteCircuitSkuArgs{
				Tier:   pulumi.String("Standard"),
				Family: pulumi.String("MeteredData"),
			},
			AllowClassicOperations: pulumi.Bool(false),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		_, err = network.NewExpressRouteCircuitAuthorization(ctx, "example", &network.ExpressRouteCircuitAuthorizationArgs{
			Name:                    pulumi.String("exampleERCAuth"),
			ExpressRouteCircuitName: exampleExpressRouteCircuit.Name,
			ResourceGroupName:       example.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = "exprtTest",
        Location = "West Europe",
    });

    var exampleExpressRouteCircuit = new Azure.Network.ExpressRouteCircuit("example", new()
    {
        Name = "expressRoute1",
        ResourceGroupName = example.Name,
        Location = example.Location,
        ServiceProviderName = "Equinix",
        PeeringLocation = "Silicon Valley",
        BandwidthInMbps = 50,
        Sku = new Azure.Network.Inputs.ExpressRouteCircuitSkuArgs
        {
            Tier = "Standard",
            Family = "MeteredData",
        },
        AllowClassicOperations = false,
        Tags = 
        {
            { "environment", "Production" },
        },
    });

    var exampleExpressRouteCircuitAuthorization = new Azure.Network.ExpressRouteCircuitAuthorization("example", new()
    {
        Name = "exampleERCAuth",
        ExpressRouteCircuitName = exampleExpressRouteCircuit.Name,
        ResourceGroupName = example.Name,
    });

});
Copy
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.ExpressRouteCircuit;
import com.pulumi.azure.network.ExpressRouteCircuitArgs;
import com.pulumi.azure.network.inputs.ExpressRouteCircuitSkuArgs;
import com.pulumi.azure.network.ExpressRouteCircuitAuthorization;
import com.pulumi.azure.network.ExpressRouteCircuitAuthorizationArgs;
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("exprtTest")
            .location("West Europe")
            .build());

        var exampleExpressRouteCircuit = new ExpressRouteCircuit("exampleExpressRouteCircuit", ExpressRouteCircuitArgs.builder()
            .name("expressRoute1")
            .resourceGroupName(example.name())
            .location(example.location())
            .serviceProviderName("Equinix")
            .peeringLocation("Silicon Valley")
            .bandwidthInMbps(50)
            .sku(ExpressRouteCircuitSkuArgs.builder()
                .tier("Standard")
                .family("MeteredData")
                .build())
            .allowClassicOperations(false)
            .tags(Map.of("environment", "Production"))
            .build());

        var exampleExpressRouteCircuitAuthorization = new ExpressRouteCircuitAuthorization("exampleExpressRouteCircuitAuthorization", ExpressRouteCircuitAuthorizationArgs.builder()
            .name("exampleERCAuth")
            .expressRouteCircuitName(exampleExpressRouteCircuit.name())
            .resourceGroupName(example.name())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: exprtTest
      location: West Europe
  exampleExpressRouteCircuit:
    type: azure:network:ExpressRouteCircuit
    name: example
    properties:
      name: expressRoute1
      resourceGroupName: ${example.name}
      location: ${example.location}
      serviceProviderName: Equinix
      peeringLocation: Silicon Valley
      bandwidthInMbps: 50
      sku:
        tier: Standard
        family: MeteredData
      allowClassicOperations: false
      tags:
        environment: Production
  exampleExpressRouteCircuitAuthorization:
    type: azure:network:ExpressRouteCircuitAuthorization
    name: example
    properties:
      name: exampleERCAuth
      expressRouteCircuitName: ${exampleExpressRouteCircuit.name}
      resourceGroupName: ${example.name}
Copy

Create ExpressRouteCircuitAuthorization Resource

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

Constructor syntax

new ExpressRouteCircuitAuthorization(name: string, args: ExpressRouteCircuitAuthorizationArgs, opts?: CustomResourceOptions);
@overload
def ExpressRouteCircuitAuthorization(resource_name: str,
                                     args: ExpressRouteCircuitAuthorizationArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def ExpressRouteCircuitAuthorization(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     express_route_circuit_name: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     name: Optional[str] = None)
func NewExpressRouteCircuitAuthorization(ctx *Context, name string, args ExpressRouteCircuitAuthorizationArgs, opts ...ResourceOption) (*ExpressRouteCircuitAuthorization, error)
public ExpressRouteCircuitAuthorization(string name, ExpressRouteCircuitAuthorizationArgs args, CustomResourceOptions? opts = null)
public ExpressRouteCircuitAuthorization(String name, ExpressRouteCircuitAuthorizationArgs args)
public ExpressRouteCircuitAuthorization(String name, ExpressRouteCircuitAuthorizationArgs args, CustomResourceOptions options)

type: azure:network:ExpressRouteCircuitAuthorization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteCircuitAuthorizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ExpressRouteCircuitAuthorizationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteCircuitAuthorizationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteCircuitAuthorizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ExpressRouteCircuitAuthorizationArgs
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 expressRouteCircuitAuthorizationResource = new Azure.Network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorizationResource", new()
{
    ExpressRouteCircuitName = "string",
    ResourceGroupName = "string",
    Name = "string",
});
Copy
example, err := network.NewExpressRouteCircuitAuthorization(ctx, "expressRouteCircuitAuthorizationResource", &network.ExpressRouteCircuitAuthorizationArgs{
	ExpressRouteCircuitName: pulumi.String("string"),
	ResourceGroupName:       pulumi.String("string"),
	Name:                    pulumi.String("string"),
})
Copy
var expressRouteCircuitAuthorizationResource = new ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorizationResource", ExpressRouteCircuitAuthorizationArgs.builder()
    .expressRouteCircuitName("string")
    .resourceGroupName("string")
    .name("string")
    .build());
Copy
express_route_circuit_authorization_resource = azure.network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorizationResource",
    express_route_circuit_name="string",
    resource_group_name="string",
    name="string")
Copy
const expressRouteCircuitAuthorizationResource = new azure.network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorizationResource", {
    expressRouteCircuitName: "string",
    resourceGroupName: "string",
    name: "string",
});
Copy
type: azure:network:ExpressRouteCircuitAuthorization
properties:
    expressRouteCircuitName: string
    name: string
    resourceGroupName: string
Copy

ExpressRouteCircuitAuthorization Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ExpressRouteCircuitAuthorization resource accepts the following input properties:

ExpressRouteCircuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
ExpressRouteCircuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
expressRouteCircuitName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
expressRouteCircuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
express_route_circuit_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
expressRouteCircuitName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.

Outputs

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

AuthorizationKey string
The Authorization Key.
AuthorizationUseStatus string
The authorization use status.
Id string
The provider-assigned unique ID for this managed resource.
AuthorizationKey string
The Authorization Key.
AuthorizationUseStatus string
The authorization use status.
Id string
The provider-assigned unique ID for this managed resource.
authorizationKey String
The Authorization Key.
authorizationUseStatus String
The authorization use status.
id String
The provider-assigned unique ID for this managed resource.
authorizationKey string
The Authorization Key.
authorizationUseStatus string
The authorization use status.
id string
The provider-assigned unique ID for this managed resource.
authorization_key str
The Authorization Key.
authorization_use_status str
The authorization use status.
id str
The provider-assigned unique ID for this managed resource.
authorizationKey String
The Authorization Key.
authorizationUseStatus String
The authorization use status.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ExpressRouteCircuitAuthorization Resource

Get an existing ExpressRouteCircuitAuthorization 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?: ExpressRouteCircuitAuthorizationState, opts?: CustomResourceOptions): ExpressRouteCircuitAuthorization
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization_key: Optional[str] = None,
        authorization_use_status: Optional[str] = None,
        express_route_circuit_name: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> ExpressRouteCircuitAuthorization
func GetExpressRouteCircuitAuthorization(ctx *Context, name string, id IDInput, state *ExpressRouteCircuitAuthorizationState, opts ...ResourceOption) (*ExpressRouteCircuitAuthorization, error)
public static ExpressRouteCircuitAuthorization Get(string name, Input<string> id, ExpressRouteCircuitAuthorizationState? state, CustomResourceOptions? opts = null)
public static ExpressRouteCircuitAuthorization get(String name, Output<String> id, ExpressRouteCircuitAuthorizationState state, CustomResourceOptions options)
resources:  _:    type: azure:network:ExpressRouteCircuitAuthorization    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AuthorizationKey string
The Authorization Key.
AuthorizationUseStatus string
The authorization use status.
ExpressRouteCircuitName Changes to this property will trigger replacement. string
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
AuthorizationKey string
The Authorization Key.
AuthorizationUseStatus string
The authorization use status.
ExpressRouteCircuitName Changes to this property will trigger replacement. string
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
authorizationKey String
The Authorization Key.
authorizationUseStatus String
The authorization use status.
expressRouteCircuitName Changes to this property will trigger replacement. String
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
authorizationKey string
The Authorization Key.
authorizationUseStatus string
The authorization use status.
expressRouteCircuitName Changes to this property will trigger replacement. string
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
authorization_key str
The Authorization Key.
authorization_use_status str
The authorization use status.
express_route_circuit_name Changes to this property will trigger replacement. str
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
authorizationKey String
The Authorization Key.
authorizationUseStatus String
The authorization use status.
expressRouteCircuitName Changes to this property will trigger replacement. String
The name of the Express Route Circuit in which to create the Authorization. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.

Import

ExpressRoute Circuit Authorizations can be imported using the resource id, e.g.

$ pulumi import azure:network/expressRouteCircuitAuthorization:ExpressRouteCircuitAuthorization auth1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/expressRouteCircuits/myExpressRoute/authorizations/auth1
Copy

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure