Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. ExpressRouteCircuitAuthorization
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.ExpressRouteCircuitAuthorization

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Authorization in an ExpressRouteCircuit resource.

Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.

Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Example Usage

Create ExpressRouteCircuit Authorization

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

return await Deployment.RunAsync(() => 
{
    var expressRouteCircuitAuthorization = new AzureNative.Network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorization", new()
    {
        AuthorizationName = "authorizatinName",
        CircuitName = "circuitName",
        ResourceGroupName = "rg1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewExpressRouteCircuitAuthorization(ctx, "expressRouteCircuitAuthorization", &network.ExpressRouteCircuitAuthorizationArgs{
			AuthorizationName: pulumi.String("authorizatinName"),
			CircuitName:       pulumi.String("circuitName"),
			ResourceGroupName: pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.ExpressRouteCircuitAuthorization;
import com.pulumi.azurenative.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 expressRouteCircuitAuthorization = new ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorization", ExpressRouteCircuitAuthorizationArgs.builder()
            .authorizationName("authorizatinName")
            .circuitName("circuitName")
            .resourceGroupName("rg1")
            .build());

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

const expressRouteCircuitAuthorization = new azure_native.network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorization", {
    authorizationName: "authorizatinName",
    circuitName: "circuitName",
    resourceGroupName: "rg1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

express_route_circuit_authorization = azure_native.network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorization",
    authorization_name="authorizatinName",
    circuit_name="circuitName",
    resource_group_name="rg1")
Copy
resources:
  expressRouteCircuitAuthorization:
    type: azure-native:network:ExpressRouteCircuitAuthorization
    properties:
      authorizationName: authorizatinName
      circuitName: circuitName
      resourceGroupName: rg1
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: ExpressRouteCircuitAuthorizationInitArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def ExpressRouteCircuitAuthorization(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     circuit_name: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     authorization_key: Optional[str] = None,
                                     authorization_name: Optional[str] = None,
                                     authorization_use_status: Optional[Union[str, AuthorizationUseStatus]] = None,
                                     id: 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-native: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. ExpressRouteCircuitAuthorizationInitArgs
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 AzureNative.Network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorizationResource", new()
{
    CircuitName = "string",
    ResourceGroupName = "string",
    AuthorizationKey = "string",
    AuthorizationName = "string",
    AuthorizationUseStatus = "string",
    Id = "string",
    Name = "string",
});
Copy
example, err := network.NewExpressRouteCircuitAuthorization(ctx, "expressRouteCircuitAuthorizationResource", &network.ExpressRouteCircuitAuthorizationArgs{
	CircuitName:            pulumi.String("string"),
	ResourceGroupName:      pulumi.String("string"),
	AuthorizationKey:       pulumi.String("string"),
	AuthorizationName:      pulumi.String("string"),
	AuthorizationUseStatus: pulumi.String("string"),
	Id:                     pulumi.String("string"),
	Name:                   pulumi.String("string"),
})
Copy
var expressRouteCircuitAuthorizationResource = new ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorizationResource", ExpressRouteCircuitAuthorizationArgs.builder()
    .circuitName("string")
    .resourceGroupName("string")
    .authorizationKey("string")
    .authorizationName("string")
    .authorizationUseStatus("string")
    .id("string")
    .name("string")
    .build());
Copy
express_route_circuit_authorization_resource = azure_native.network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorizationResource",
    circuit_name="string",
    resource_group_name="string",
    authorization_key="string",
    authorization_name="string",
    authorization_use_status="string",
    id="string",
    name="string")
Copy
const expressRouteCircuitAuthorizationResource = new azure_native.network.ExpressRouteCircuitAuthorization("expressRouteCircuitAuthorizationResource", {
    circuitName: "string",
    resourceGroupName: "string",
    authorizationKey: "string",
    authorizationName: "string",
    authorizationUseStatus: "string",
    id: "string",
    name: "string",
});
Copy
type: azure-native:network:ExpressRouteCircuitAuthorization
properties:
    authorizationKey: string
    authorizationName: string
    authorizationUseStatus: string
    circuitName: string
    id: 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:

CircuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
AuthorizationKey string
The authorization key.
AuthorizationName Changes to this property will trigger replacement. string
The name of the authorization.
AuthorizationUseStatus string | Pulumi.AzureNative.Network.AuthorizationUseStatus
The authorization use status.
Id string
Resource ID.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
CircuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
AuthorizationKey string
The authorization key.
AuthorizationName Changes to this property will trigger replacement. string
The name of the authorization.
AuthorizationUseStatus string | AuthorizationUseStatus
The authorization use status.
Id string
Resource ID.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
circuitName
This property is required.
Changes to this property will trigger replacement.
String
The name of the express route circuit.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
authorizationKey String
The authorization key.
authorizationName Changes to this property will trigger replacement. String
The name of the authorization.
authorizationUseStatus String | AuthorizationUseStatus
The authorization use status.
id String
Resource ID.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
circuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
authorizationKey string
The authorization key.
authorizationName Changes to this property will trigger replacement. string
The name of the authorization.
authorizationUseStatus string | AuthorizationUseStatus
The authorization use status.
id string
Resource ID.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
circuit_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the express route circuit.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
authorization_key str
The authorization key.
authorization_name Changes to this property will trigger replacement. str
The name of the authorization.
authorization_use_status str | AuthorizationUseStatus
The authorization use status.
id str
Resource ID.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
circuitName
This property is required.
Changes to this property will trigger replacement.
String
The name of the express route circuit.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
authorizationKey String
The authorization key.
authorizationName Changes to this property will trigger replacement. String
The name of the authorization.
authorizationUseStatus String | "Available" | "InUse"
The authorization use status.
id String
Resource ID.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
ConnectionResourceUri string
The reference to the ExpressRoute connection resource using the authorization.
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.
ProvisioningState string
The provisioning state of the authorization resource.
Type string
Type of the resource.
AzureApiVersion string
The Azure API version of the resource.
ConnectionResourceUri string
The reference to the ExpressRoute connection resource using the authorization.
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.
ProvisioningState string
The provisioning state of the authorization resource.
Type string
Type of the resource.
azureApiVersion String
The Azure API version of the resource.
connectionResourceUri String
The reference to the ExpressRoute connection resource using the authorization.
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.
provisioningState String
The provisioning state of the authorization resource.
type String
Type of the resource.
azureApiVersion string
The Azure API version of the resource.
connectionResourceUri string
The reference to the ExpressRoute connection resource using the authorization.
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.
provisioningState string
The provisioning state of the authorization resource.
type string
Type of the resource.
azure_api_version str
The Azure API version of the resource.
connection_resource_uri str
The reference to the ExpressRoute connection resource using the authorization.
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.
provisioning_state str
The provisioning state of the authorization resource.
type str
Type of the resource.
azureApiVersion String
The Azure API version of the resource.
connectionResourceUri String
The reference to the ExpressRoute connection resource using the authorization.
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.
provisioningState String
The provisioning state of the authorization resource.
type String
Type of the resource.

Supporting Types

AuthorizationUseStatus
, AuthorizationUseStatusArgs

Available
Available
InUse
InUse
AuthorizationUseStatusAvailable
Available
AuthorizationUseStatusInUse
InUse
Available
Available
InUse
InUse
Available
Available
InUse
InUse
AVAILABLE
Available
IN_USE
InUse
"Available"
Available
"InUse"
InUse

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:ExpressRouteCircuitAuthorization authorizationName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native