Share via

Microsoft.Network expressRouteCircuits/authorizations 2024-05-01

Bicep resource definition

The expressRouteCircuits/authorizations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/expressRouteCircuits/authorizations@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authorizationKey: 'string'
    authorizationUseStatus: 'string'
  }
}

Property Values

Microsoft.Network/expressRouteCircuits/authorizations

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: expressRouteCircuits
properties Properties of the express route circuit authorization. AuthorizationPropertiesFormat

AuthorizationPropertiesFormat

Name Description Value
authorizationKey The authorization key. string
authorizationUseStatus The authorization use status. 'Available'
'InUse'

ARM template resource definition

The expressRouteCircuits/authorizations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/expressRouteCircuits/authorizations",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "authorizationKey": "string",
    "authorizationUseStatus": "string"
  }
}

Property Values

Microsoft.Network/expressRouteCircuits/authorizations

Name Description Value
apiVersion The api version '2024-05-01'
name The resource name string (required)
properties Properties of the express route circuit authorization. AuthorizationPropertiesFormat
type The resource type 'Microsoft.Network/expressRouteCircuits/authorizations'

AuthorizationPropertiesFormat

Name Description Value
authorizationKey The authorization key. string
authorizationUseStatus The authorization use status. 'Available'
'InUse'

Usage Examples

Terraform (AzAPI provider) resource definition

The expressRouteCircuits/authorizations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCircuits/authorizations@2024-05-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      authorizationKey = "string"
      authorizationUseStatus = "string"
    }
  }
}

Property Values

Microsoft.Network/expressRouteCircuits/authorizations

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: expressRouteCircuits
properties Properties of the express route circuit authorization. AuthorizationPropertiesFormat
type The resource type "Microsoft.Network/expressRouteCircuits/authorizations@2024-05-01"

AuthorizationPropertiesFormat

Name Description Value
authorizationKey The authorization key. string
authorizationUseStatus The authorization use status. 'Available'
'InUse'

Usage Examples

Terraform Samples

A basic example of deploying ExpressRoute Circuit Authorization.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "expressRouteCircuit" {
  type      = "Microsoft.Network/expressRouteCircuits@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      authorizationKey = ""
      serviceProviderProperties = {
        bandwidthInMbps     = 50
        peeringLocation     = "Silicon Valley"
        serviceProviderName = "Equinix"
      }
    }
    sku = {
      family = "MeteredData"
      name   = "Standard_MeteredData"
      tier   = "Standard"
    }
    tags = {
      Environment = "production"
      Purpose     = "AcceptanceTests"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "authorization" {
  type      = "Microsoft.Network/expressRouteCircuits/authorizations@2022-07-01"
  parent_id = azapi_resource.expressRouteCircuit.id
  name      = var.resource_name
  body = {
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}