Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-01-01
- 2024-10-01
- 2024-07-01
- 2024-05-01
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-08-01
- 2018-07-01
- 2018-06-01
- 2018-04-01
- 2018-02-01
- 2018-01-01
- 2017-11-01
- 2017-10-01
- 2017-09-01
- 2017-08-01
- 2017-06-01
- 2017-03-30
- 2017-03-01
- 2016-12-01
- 2016-09-01
- 2016-06-01
- 2016-03-30
- 2015-06-15
- 2015-05-01-preview
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@2018-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
authorizationKey: 'string'
authorizationUseStatus: 'string'
provisioningState: '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 | AuthorizationPropertiesFormat |
AuthorizationPropertiesFormat
Name | Description | Value |
---|---|---|
authorizationKey | The authorization key. | string |
authorizationUseStatus | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. | 'Available' 'InUse' |
provisioningState | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
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": "2018-01-01",
"name": "string",
"properties": {
"authorizationKey": "string",
"authorizationUseStatus": "string",
"provisioningState": "string"
}
}
Property Values
Microsoft.Network/expressRouteCircuits/authorizations
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2018-01-01' |
name | The resource name | string (required) |
properties | AuthorizationPropertiesFormat | |
type | The resource type | 'Microsoft.Network/expressRouteCircuits/authorizations' |
AuthorizationPropertiesFormat
Name | Description | Value |
---|---|---|
authorizationKey | The authorization key. | string |
authorizationUseStatus | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. | 'Available' 'InUse' |
provisioningState | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
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@2018-01-01"
name = "string"
parent_id = "string"
body = {
properties = {
authorizationKey = "string"
authorizationUseStatus = "string"
provisioningState = "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 | AuthorizationPropertiesFormat | |
type | The resource type | "Microsoft.Network/expressRouteCircuits/authorizations@2018-01-01" |
AuthorizationPropertiesFormat
Name | Description | Value |
---|---|---|
authorizationKey | The authorization key. | string |
authorizationUseStatus | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. | 'Available' 'InUse' |
provisioningState | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | string |
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 = ["*"]
}