Microsoft.Network expressRouteCircuits 2024-10-01

Определение ресурсов Bicep

Тип ресурса expressRouteCircuits можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Network/expressRouteCircuits, добавьте в шаблон следующий бицепс.

resource symbolicname 'Microsoft.Network/expressRouteCircuits@2024-10-01' = {
  location: 'string'
  name: 'string'
  properties: {
    allowClassicOperations: bool
    authorizationKey: 'string'
    authorizations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          authorizationKey: 'string'
          authorizationUseStatus: 'string'
        }
      }
    ]
    bandwidthInGbps: int
    circuitProvisioningState: 'string'
    enableDirectPortRateLimit: bool
    expressRoutePort: {
      id: 'string'
    }
    gatewayManagerEtag: 'string'
    globalReachEnabled: bool
    peerings: [
      {
        id: 'string'
        name: 'string'
        properties: {
          azureASN: int
          connections: [
            {
              id: 'string'
              name: 'string'
              properties: {
                addressPrefix: 'string'
                authorizationKey: 'string'
                expressRouteCircuitPeering: {
                  id: 'string'
                }
                ipv6CircuitConnectionConfig: {
                  addressPrefix: 'string'
                }
                peerExpressRouteCircuitPeering: {
                  id: 'string'
                }
              }
            }
          ]
          expressRouteConnection: {}
          gatewayManagerEtag: 'string'
          ipv6PeeringConfig: {
            microsoftPeeringConfig: {
              advertisedCommunities: [
                'string'
              ]
              advertisedPublicPrefixes: [
                'string'
              ]
              advertisedPublicPrefixInfo: [
                {
                  prefix: 'string'
                  signature: 'string'
                  validationId: 'string'
                }
              ]
              customerASN: int
              legacyMode: int
              routingRegistryName: 'string'
            }
            primaryPeerAddressPrefix: 'string'
            routeFilter: {
              id: 'string'
            }
            secondaryPeerAddressPrefix: 'string'
            state: 'string'
          }
          microsoftPeeringConfig: {
            advertisedCommunities: [
              'string'
            ]
            advertisedPublicPrefixes: [
              'string'
            ]
            advertisedPublicPrefixInfo: [
              {
                prefix: 'string'
                signature: 'string'
                validationId: 'string'
              }
            ]
            customerASN: int
            legacyMode: int
            routingRegistryName: 'string'
          }
          peerASN: int
          peeringType: 'string'
          primaryAzurePort: 'string'
          primaryPeerAddressPrefix: 'string'
          routeFilter: {
            id: 'string'
          }
          secondaryAzurePort: 'string'
          secondaryPeerAddressPrefix: 'string'
          sharedKey: 'string'
          state: 'string'
          stats: {
            primarybytesIn: int
            primarybytesOut: int
            secondarybytesIn: int
            secondarybytesOut: int
          }
          vlanId: int
        }
      }
    ]
    serviceKey: 'string'
    serviceProviderNotes: 'string'
    serviceProviderProperties: {
      bandwidthInMbps: int
      peeringLocation: 'string'
      serviceProviderName: 'string'
    }
    serviceProviderProvisioningState: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

Microsoft.Network/expressRouteCircuits

Имя Description Ценность
location Расположение ресурса. струна
имя имя ресурса. строка (обязательно)
properties Свойства схемы экспресс-маршрута. ExpressRouteCircuitPropertiesFormat
sku Номер SKU. ExpressRouteCircuitSku
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

AdvertisedPublicPrefixProperties

Имя Description Ценность
prefix Рекламируемый публичный префикс. струна
подпись Подписанная строка, сгенерированная путем шифрования validationId с помощью закрытого ключа. струна
validationId Строка проверки, содержащая сведения о пиринге каналов. струна

AuthorizationPropertiesFormat (Формат AuthorizationProperties)

Имя Description Ценность
авторизацияКлюч Ключ авторизации. струна
authorizationUseStatus Статус использования авторизации. «Доступно»
«Используется»

ExpressRouteCircuitAuthorization (Авторизация ExpressRouteCircuit)

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства авторизации по цепи экспресс-маршрута. AuthorizationPropertiesFormat (Формат AuthorizationProperties)

ExpressRouteCircuitConnection (Подключение ExpressRouteCircuit)

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства подключения к цепи экспресс-маршрута. ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Имя Description Ценность
addressПрефикс /29 пространство IP-адресов для выделения адресов клиентов для туннелей. струна
авторизацияКлюч Ключ авторизации. струна
expressRouteCircuitПиринг Ссылка на ресурс частного пиринга канала Express Route Circuit канала, инициирующего подключение. SubResource
ipv6CircuitConnectionConfig IPv6 Address PrefixProperties подключения к цепи экспресс-маршрута. Конфигурация ipv6CircuitConnectionConfig
peerExpressRouteCircuitПиринг Ссылка на ресурс частного пиринга канала Express Route однорангового канала. SubResource

ExpressRouteCircuitПиринг

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства пиринга по цепи экспресс-маршрута. ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)

Имя Description Ценность
advertisCommunities Сообщества пиринга bgp. Указано для пиринга Майкрософт. строка[]
advertisedPublicPrefixes Ссылка на AdvertisedPublicPrefixes. строка[]
advertisedPublicPrefixInfo Список сведений о префиксах, необходимых для выполнения проверки. AdvertisedPublicPrefixProperties[]
клиентASN CustomerASN пиринга. инт
legacyMode Устаревший режим пиринга. инт
routingRegistryName RoutingRegistryName конфигурации. струна

ExpressRouteCircuitPeeringPropertiesFormat

Имя Description Ценность
azureASN The Azure ASN. инт
connections Список подключений к каналам, связанных с частным пирингом Azure для этого канала. ExpressRouteCircuitConnection[]
expressRouteConnection Подключение ExpressRoute. ExpressRouteConnectionId (Идентификатор соединения)
gatewayManagerEtag Тег GatewayManager. струна
ipv6PeeringConfig Конфигурация пиринга IPv6. Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig Конфигурация пиринга Майкрософт. ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)
peerASN Одноранговый ASN. int

Constraints:
Минимальное значение = 1
Максимальное значение = 4294967295
peeringType Тип пиринга. 'AzurePrivatePeering'
'AzurePublicPeering'
«MicrosoftPeering»
первичныйAzurePort Основной порт. струна
первичныйPeerAddressПрефикс Префикс основного адреса. струна
маршрутФильтр Ссылка на ресурс RouteFilter. SubResource
вторичныйAzurePort Второстепенный порт. струна
secondaryPeerAddressПрефикс Префикс вторичного адреса. струна
sharedKey Общий ключ. струна
государство Состояние пиринга. "Отключено"
"Включено"
статистика Статистика пиринга по цепочке экспресс-маршрута. ExpressRouteCircuitStats (ЭкспрессМаршрутКонтурСтатистика)
vlanId Идентификатор VLAN. инт

ExpressRouteCircuitPropertiesFormat

Имя Description Ценность
allowClassicOperations Разрешите классические операции. bool
авторизацияКлюч Ключ авторизации. струна
authorizations Список разрешений. ExpressRouteCircuitAuthorization[]
пропускная способностьInGbps Пропускная способность канала при подготовке канала к ресурсу ExpressRoutePort. инт
circuitProvisioningState Состояние ресурса CircuitProvisioningState. струна
enableDirectPortRateLimit Флаг, обозначающий состояние ограничения скорости канала прямого порта ExpressRoute. bool
expressRoutePort Ссылка на ресурс ExpressRoutePort при подготовке канала в ресурсе ExpressRoutePort. SubResource
gatewayManagerEtag Тег GatewayManager. струна
globalReachEnabled Флаг, обозначающий статус глобального охвата. bool
peerings Список пирингов. Пиринг ExpressRouteCircuit[]
serviceKey The ServiceKey. струна
serviceProviderПримечания Заметки поставщика услуг. струна
serviceProviderProperties Свойства ServiceProviderProperties. Свойства поставщика услуг ExpressRouteCircuit
serviceProviderProvisioningState Состояние ресурса ServiceProviderProvisioningState. "Отмена подготовки"
«НеProvisioned»
"Подготовлено"
'Provisioning'

Свойства поставщика услуг ExpressRouteCircuit

Имя Description Ценность
пропускная способностьInMbps Пропускная способностьInMbps. инт
peeringLocation Расположение пиринга. струна
serviceProviderName Имя serviceProviderName. струна

ExpressRouteCircuitSku

Имя Description Ценность
family Семейство SKU. «Измеренные данные»
«Неограниченные данные»
имя Имя номера SKU. струна
tier Уровень артикула. 'Basic'
'Local'
'Premium'
'Standard'

ExpressRouteCircuitStats (ЭкспрессМаршрутКонтурСтатистика)

Имя Description Ценность
первичных байтовВ Первичные байтыВ пиринге. инт
первичные байтыВыход Основной BytesOut пиринга. инт
вторичных байтВ Вторичный BytesIn пиринга. инт
вторичныебайтыOut Вторичный BytesOut пиринга. инт

ExpressRouteConnectionId

Имя Description Ценность

Конфигурация ipv6CircuitConnectionConfig

Имя Description Ценность
addressПрефикс /125 пространство IP-адресов, чтобы выделить адреса клиентов для глобального охвата. струна

Ipv6ExpressRouteCircuitPeeringConfig

Имя Description Ценность
microsoftPeeringConfig Конфигурация пиринга Майкрософт. ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)
первичныйPeerAddressПрефикс Префикс основного адреса. струна
маршрутФильтр Ссылка на ресурс RouteFilter. SubResource
secondaryPeerAddressПрефикс Префикс вторичного адреса. струна
государство Состояние пиринга. "Отключено"
"Включено"

ResourceTags

Имя Description Ценность

Подресурс

Имя Description Ценность
id Идентификатор ресурса. струна

Примеры использования

Примеры Bicep

Простой пример развертывания канала ExpressRoute.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource expressrouteport 'Microsoft.Network/ExpressRoutePorts@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    bandwidthInGbps: 10
    encapsulation: 'Dot1Q'
    peeringLocation: 'CDC-Canberra'
  }
}

resource expressRouteCircuit 'Microsoft.Network/expressRouteCircuits@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    authorizationKey: ''
    bandwidthInGbps: 5
    expressRoutePort: {
      id: expressrouteport.id
    }
  }
  sku: {
    family: 'MeteredData'
    name: 'Premium_MeteredData'
    tier: 'Premium'
  }
}

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Description
Контур ExpressRoute Ресурсный модуль AVM для ExpressRoute Circuit

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Description
Создание цепи ExpressRoute Этот шаблон создает цепь ExpressRoute для указанного поставщика услуг и номера SKU
канал ExpressRoute с частным пирингом и виртуальной сетью Azure Этот шаблон настраивает пиринг Microsoft ExpressRoute, развертывает виртуальную сеть Azure с помощью шлюза Expressroute и связывает виртуальную сеть с каналом ExpressRoute.

Определение ресурса шаблона ARM

Тип ресурса expressRouteCircuits можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Network/expressRouteCircuits, добавьте в шаблон следующий код JSON.

{
  "type": "Microsoft.Network/expressRouteCircuits",
  "apiVersion": "2024-10-01",
  "name": "string",
  "location": "string",
  "properties": {
    "allowClassicOperations": "bool",
    "authorizationKey": "string",
    "authorizations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "authorizationKey": "string",
          "authorizationUseStatus": "string"
        }
      }
    ],
    "bandwidthInGbps": "int",
    "circuitProvisioningState": "string",
    "enableDirectPortRateLimit": "bool",
    "expressRoutePort": {
      "id": "string"
    },
    "gatewayManagerEtag": "string",
    "globalReachEnabled": "bool",
    "peerings": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "azureASN": "int",
          "connections": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "addressPrefix": "string",
                "authorizationKey": "string",
                "expressRouteCircuitPeering": {
                  "id": "string"
                },
                "ipv6CircuitConnectionConfig": {
                  "addressPrefix": "string"
                },
                "peerExpressRouteCircuitPeering": {
                  "id": "string"
                }
              }
            }
          ],
          "expressRouteConnection": {
          },
          "gatewayManagerEtag": "string",
          "ipv6PeeringConfig": {
            "microsoftPeeringConfig": {
              "advertisedCommunities": [ "string" ],
              "advertisedPublicPrefixes": [ "string" ],
              "advertisedPublicPrefixInfo": [
                {
                  "prefix": "string",
                  "signature": "string",
                  "validationId": "string"
                }
              ],
              "customerASN": "int",
              "legacyMode": "int",
              "routingRegistryName": "string"
            },
            "primaryPeerAddressPrefix": "string",
            "routeFilter": {
              "id": "string"
            },
            "secondaryPeerAddressPrefix": "string",
            "state": "string"
          },
          "microsoftPeeringConfig": {
            "advertisedCommunities": [ "string" ],
            "advertisedPublicPrefixes": [ "string" ],
            "advertisedPublicPrefixInfo": [
              {
                "prefix": "string",
                "signature": "string",
                "validationId": "string"
              }
            ],
            "customerASN": "int",
            "legacyMode": "int",
            "routingRegistryName": "string"
          },
          "peerASN": "int",
          "peeringType": "string",
          "primaryAzurePort": "string",
          "primaryPeerAddressPrefix": "string",
          "routeFilter": {
            "id": "string"
          },
          "secondaryAzurePort": "string",
          "secondaryPeerAddressPrefix": "string",
          "sharedKey": "string",
          "state": "string",
          "stats": {
            "primarybytesIn": "int",
            "primarybytesOut": "int",
            "secondarybytesIn": "int",
            "secondarybytesOut": "int"
          },
          "vlanId": "int"
        }
      }
    ],
    "serviceKey": "string",
    "serviceProviderNotes": "string",
    "serviceProviderProperties": {
      "bandwidthInMbps": "int",
      "peeringLocation": "string",
      "serviceProviderName": "string"
    },
    "serviceProviderProvisioningState": "string"
  },
  "sku": {
    "family": "string",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

Microsoft.Network/expressRouteCircuits

Имя Description Ценность
apiVersion Версия API '2024-10-01'
location Расположение ресурса. струна
имя имя ресурса. строка (обязательно)
properties Свойства схемы экспресс-маршрута. ExpressRouteCircuitPropertiesFormat
sku Номер SKU. ExpressRouteCircuitSku
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
type Тип ресурса «Microsoft.Network/expressRouteCircuits»

AdvertisedPublicPrefixProperties

Имя Description Ценность
prefix Рекламируемый публичный префикс. струна
подпись Подписанная строка, сгенерированная путем шифрования validationId с помощью закрытого ключа. струна
validationId Строка проверки, содержащая сведения о пиринге каналов. струна

AuthorizationPropertiesFormat (Формат AuthorizationProperties)

Имя Description Ценность
авторизацияКлюч Ключ авторизации. струна
authorizationUseStatus Статус использования авторизации. «Доступно»
«Используется»

ExpressRouteCircuitAuthorization (Авторизация ExpressRouteCircuit)

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства авторизации по цепи экспресс-маршрута. AuthorizationPropertiesFormat (Формат AuthorizationProperties)

ExpressRouteCircuitConnection (Подключение ExpressRouteCircuit)

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства подключения к цепи экспресс-маршрута. ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Имя Description Ценность
addressПрефикс /29 пространство IP-адресов для выделения адресов клиентов для туннелей. струна
авторизацияКлюч Ключ авторизации. струна
expressRouteCircuitПиринг Ссылка на ресурс частного пиринга канала Express Route Circuit канала, инициирующего подключение. SubResource
ipv6CircuitConnectionConfig IPv6 Address PrefixProperties подключения к цепи экспресс-маршрута. Конфигурация ipv6CircuitConnectionConfig
peerExpressRouteCircuitПиринг Ссылка на ресурс частного пиринга канала Express Route однорангового канала. SubResource

ExpressRouteCircuitПиринг

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства пиринга по цепи экспресс-маршрута. ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)

Имя Description Ценность
advertisCommunities Сообщества пиринга bgp. Указано для пиринга Майкрософт. строка[]
advertisedPublicPrefixes Ссылка на AdvertisedPublicPrefixes. строка[]
advertisedPublicPrefixInfo Список сведений о префиксах, необходимых для выполнения проверки. AdvertisedPublicPrefixProperties[]
клиентASN CustomerASN пиринга. инт
legacyMode Устаревший режим пиринга. инт
routingRegistryName RoutingRegistryName конфигурации. струна

ExpressRouteCircuitPeeringPropertiesFormat

Имя Description Ценность
azureASN The Azure ASN. инт
connections Список подключений к каналам, связанных с частным пирингом Azure для этого канала. ExpressRouteCircuitConnection[]
expressRouteConnection Подключение ExpressRoute. ExpressRouteConnectionId (Идентификатор соединения)
gatewayManagerEtag Тег GatewayManager. струна
ipv6PeeringConfig Конфигурация пиринга IPv6. Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig Конфигурация пиринга Майкрософт. ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)
peerASN Одноранговый ASN. int

Constraints:
Минимальное значение = 1
Максимальное значение = 4294967295
peeringType Тип пиринга. 'AzurePrivatePeering'
'AzurePublicPeering'
«MicrosoftPeering»
первичныйAzurePort Основной порт. струна
первичныйPeerAddressПрефикс Префикс основного адреса. струна
маршрутФильтр Ссылка на ресурс RouteFilter. SubResource
вторичныйAzurePort Второстепенный порт. струна
secondaryPeerAddressПрефикс Префикс вторичного адреса. струна
sharedKey Общий ключ. струна
государство Состояние пиринга. "Отключено"
"Включено"
статистика Статистика пиринга по цепочке экспресс-маршрута. ExpressRouteCircuitStats (ЭкспрессМаршрутКонтурСтатистика)
vlanId Идентификатор VLAN. инт

ExpressRouteCircuitPropertiesFormat

Имя Description Ценность
allowClassicOperations Разрешите классические операции. bool
авторизацияКлюч Ключ авторизации. струна
authorizations Список разрешений. ExpressRouteCircuitAuthorization[]
пропускная способностьInGbps Пропускная способность канала при подготовке канала к ресурсу ExpressRoutePort. инт
circuitProvisioningState Состояние ресурса CircuitProvisioningState. струна
enableDirectPortRateLimit Флаг, обозначающий состояние ограничения скорости канала прямого порта ExpressRoute. bool
expressRoutePort Ссылка на ресурс ExpressRoutePort при подготовке канала в ресурсе ExpressRoutePort. SubResource
gatewayManagerEtag Тег GatewayManager. струна
globalReachEnabled Флаг, обозначающий статус глобального охвата. bool
peerings Список пирингов. Пиринг ExpressRouteCircuit[]
serviceKey The ServiceKey. струна
serviceProviderПримечания Заметки поставщика услуг. струна
serviceProviderProperties Свойства ServiceProviderProperties. Свойства поставщика услуг ExpressRouteCircuit
serviceProviderProvisioningState Состояние ресурса ServiceProviderProvisioningState. "Отмена подготовки"
«НеProvisioned»
"Подготовлено"
'Provisioning'

Свойства поставщика услуг ExpressRouteCircuit

Имя Description Ценность
пропускная способностьInMbps Пропускная способностьInMbps. инт
peeringLocation Расположение пиринга. струна
serviceProviderName Имя serviceProviderName. струна

ExpressRouteCircuitSku

Имя Description Ценность
family Семейство SKU. «Измеренные данные»
«Неограниченные данные»
имя Имя номера SKU. струна
tier Уровень артикула. 'Basic'
'Local'
'Premium'
'Standard'

ExpressRouteCircuitStats (ЭкспрессМаршрутКонтурСтатистика)

Имя Description Ценность
первичных байтовВ Первичные байтыВ пиринге. инт
первичные байтыВыход Основной BytesOut пиринга. инт
вторичных байтВ Вторичный BytesIn пиринга. инт
вторичныебайтыOut Вторичный BytesOut пиринга. инт

ExpressRouteConnectionId

Имя Description Ценность

Конфигурация ipv6CircuitConnectionConfig

Имя Description Ценность
addressПрефикс /125 пространство IP-адресов, чтобы выделить адреса клиентов для глобального охвата. струна

Ipv6ExpressRouteCircuitPeeringConfig

Имя Description Ценность
microsoftPeeringConfig Конфигурация пиринга Майкрософт. ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)
первичныйPeerAddressПрефикс Префикс основного адреса. струна
маршрутФильтр Ссылка на ресурс RouteFilter. SubResource
secondaryPeerAddressПрефикс Префикс вторичного адреса. струна
государство Состояние пиринга. "Отключено"
"Включено"

ResourceTags

Имя Description Ценность

Подресурс

Имя Description Ценность
id Идентификатор ресурса. струна

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Template Description
Создание цепи ExpressRoute

Развертывание в Azure
Этот шаблон создает цепь ExpressRoute для указанного поставщика услуг и номера SKU
создание канала ExpressRoute с помощью пиринга BGP

Развертывание в Azure
Этот шаблон создает канал ExpressRoute и пиринг BGP AzurePrublicPeering для указанного поставщика услуг и номера SKU
канал ExpressRoute с частным пирингом и виртуальной сетью Azure

Развертывание в Azure
Этот шаблон настраивает пиринг Microsoft ExpressRoute, развертывает виртуальную сеть Azure с помощью шлюза Expressroute и связывает виртуальную сеть с каналом ExpressRoute.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса expressRouteCircuits можно развернуть с помощью операций, предназначенных для следующих целей:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Network/expressRouteCircuits, добавьте в шаблон следующий Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCircuits@2024-10-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      allowClassicOperations = bool
      authorizationKey = "string"
      authorizations = [
        {
          id = "string"
          name = "string"
          properties = {
            authorizationKey = "string"
            authorizationUseStatus = "string"
          }
        }
      ]
      bandwidthInGbps = int
      circuitProvisioningState = "string"
      enableDirectPortRateLimit = bool
      expressRoutePort = {
        id = "string"
      }
      gatewayManagerEtag = "string"
      globalReachEnabled = bool
      peerings = [
        {
          id = "string"
          name = "string"
          properties = {
            azureASN = int
            connections = [
              {
                id = "string"
                name = "string"
                properties = {
                  addressPrefix = "string"
                  authorizationKey = "string"
                  expressRouteCircuitPeering = {
                    id = "string"
                  }
                  ipv6CircuitConnectionConfig = {
                    addressPrefix = "string"
                  }
                  peerExpressRouteCircuitPeering = {
                    id = "string"
                  }
                }
              }
            ]
            expressRouteConnection = {
            }
            gatewayManagerEtag = "string"
            ipv6PeeringConfig = {
              microsoftPeeringConfig = {
                advertisedCommunities = [
                  "string"
                ]
                advertisedPublicPrefixes = [
                  "string"
                ]
                advertisedPublicPrefixInfo = [
                  {
                    prefix = "string"
                    signature = "string"
                    validationId = "string"
                  }
                ]
                customerASN = int
                legacyMode = int
                routingRegistryName = "string"
              }
              primaryPeerAddressPrefix = "string"
              routeFilter = {
                id = "string"
              }
              secondaryPeerAddressPrefix = "string"
              state = "string"
            }
            microsoftPeeringConfig = {
              advertisedCommunities = [
                "string"
              ]
              advertisedPublicPrefixes = [
                "string"
              ]
              advertisedPublicPrefixInfo = [
                {
                  prefix = "string"
                  signature = "string"
                  validationId = "string"
                }
              ]
              customerASN = int
              legacyMode = int
              routingRegistryName = "string"
            }
            peerASN = int
            peeringType = "string"
            primaryAzurePort = "string"
            primaryPeerAddressPrefix = "string"
            routeFilter = {
              id = "string"
            }
            secondaryAzurePort = "string"
            secondaryPeerAddressPrefix = "string"
            sharedKey = "string"
            state = "string"
            stats = {
              primarybytesIn = int
              primarybytesOut = int
              secondarybytesIn = int
              secondarybytesOut = int
            }
            vlanId = int
          }
        }
      ]
      serviceKey = "string"
      serviceProviderNotes = "string"
      serviceProviderProperties = {
        bandwidthInMbps = int
        peeringLocation = "string"
        serviceProviderName = "string"
      }
      serviceProviderProvisioningState = "string"
    }
    sku = {
      family = "string"
      name = "string"
      tier = "string"
    }
  }
}

Значения свойств

Microsoft.Network/expressRouteCircuits

Имя Description Ценность
location Расположение ресурса. струна
имя имя ресурса. строка (обязательно)
properties Свойства схемы экспресс-маршрута. ExpressRouteCircuitPropertiesFormat
sku Номер SKU. ExpressRouteCircuitSku
tags Теги ресурсов Словарь имен и значений тегов.
type Тип ресурса "Microsoft.Network/expressRouteCircuits@2024-10-01"

AdvertisedPublicPrefixProperties

Имя Description Ценность
prefix Рекламируемый публичный префикс. струна
подпись Подписанная строка, сгенерированная путем шифрования validationId с помощью закрытого ключа. струна
validationId Строка проверки, содержащая сведения о пиринге каналов. струна

AuthorizationPropertiesFormat (Формат AuthorizationProperties)

Имя Description Ценность
авторизацияКлюч Ключ авторизации. струна
authorizationUseStatus Статус использования авторизации. «Доступно»
«Используется»

ExpressRouteCircuitAuthorization (Авторизация ExpressRouteCircuit)

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства авторизации по цепи экспресс-маршрута. AuthorizationPropertiesFormat (Формат AuthorizationProperties)

ExpressRouteCircuitConnection (Подключение ExpressRouteCircuit)

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства подключения к цепи экспресс-маршрута. ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Имя Description Ценность
addressПрефикс /29 пространство IP-адресов для выделения адресов клиентов для туннелей. струна
авторизацияКлюч Ключ авторизации. струна
expressRouteCircuitПиринг Ссылка на ресурс частного пиринга канала Express Route Circuit канала, инициирующего подключение. SubResource
ipv6CircuitConnectionConfig IPv6 Address PrefixProperties подключения к цепи экспресс-маршрута. Конфигурация ipv6CircuitConnectionConfig
peerExpressRouteCircuitПиринг Ссылка на ресурс частного пиринга канала Express Route однорангового канала. SubResource

ExpressRouteCircuitПиринг

Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства пиринга по цепи экспресс-маршрута. ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)

Имя Description Ценность
advertisCommunities Сообщества пиринга bgp. Указано для пиринга Майкрософт. строка[]
advertisedPublicPrefixes Ссылка на AdvertisedPublicPrefixes. строка[]
advertisedPublicPrefixInfo Список сведений о префиксах, необходимых для выполнения проверки. AdvertisedPublicPrefixProperties[]
клиентASN CustomerASN пиринга. инт
legacyMode Устаревший режим пиринга. инт
routingRegistryName RoutingRegistryName конфигурации. струна

ExpressRouteCircuitPeeringPropertiesFormat

Имя Description Ценность
azureASN The Azure ASN. инт
connections Список подключений к каналам, связанных с частным пирингом Azure для этого канала. ExpressRouteCircuitConnection[]
expressRouteConnection Подключение ExpressRoute. ExpressRouteConnectionId (Идентификатор соединения)
gatewayManagerEtag Тег GatewayManager. струна
ipv6PeeringConfig Конфигурация пиринга IPv6. Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig Конфигурация пиринга Майкрософт. ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)
peerASN Одноранговый ASN. int

Constraints:
Минимальное значение = 1
Максимальное значение = 4294967295
peeringType Тип пиринга. 'AzurePrivatePeering'
'AzurePublicPeering'
«MicrosoftPeering»
первичныйAzurePort Основной порт. струна
первичныйPeerAddressПрефикс Префикс основного адреса. струна
маршрутФильтр Ссылка на ресурс RouteFilter. SubResource
вторичныйAzurePort Второстепенный порт. струна
secondaryPeerAddressПрефикс Префикс вторичного адреса. струна
sharedKey Общий ключ. струна
государство Состояние пиринга. "Отключено"
"Включено"
статистика Статистика пиринга по цепочке экспресс-маршрута. ExpressRouteCircuitStats (ЭкспрессМаршрутКонтурСтатистика)
vlanId Идентификатор VLAN. инт

ExpressRouteCircuitPropertiesFormat

Имя Description Ценность
allowClassicOperations Разрешите классические операции. bool
авторизацияКлюч Ключ авторизации. струна
authorizations Список разрешений. ExpressRouteCircuitAuthorization[]
пропускная способностьInGbps Пропускная способность канала при подготовке канала к ресурсу ExpressRoutePort. инт
circuitProvisioningState Состояние ресурса CircuitProvisioningState. струна
enableDirectPortRateLimit Флаг, обозначающий состояние ограничения скорости канала прямого порта ExpressRoute. bool
expressRoutePort Ссылка на ресурс ExpressRoutePort при подготовке канала в ресурсе ExpressRoutePort. SubResource
gatewayManagerEtag Тег GatewayManager. струна
globalReachEnabled Флаг, обозначающий статус глобального охвата. bool
peerings Список пирингов. Пиринг ExpressRouteCircuit[]
serviceKey The ServiceKey. струна
serviceProviderПримечания Заметки поставщика услуг. струна
serviceProviderProperties Свойства ServiceProviderProperties. Свойства поставщика услуг ExpressRouteCircuit
serviceProviderProvisioningState Состояние ресурса ServiceProviderProvisioningState. "Отмена подготовки"
«НеProvisioned»
"Подготовлено"
'Provisioning'

Свойства поставщика услуг ExpressRouteCircuit

Имя Description Ценность
пропускная способностьInMbps Пропускная способностьInMbps. инт
peeringLocation Расположение пиринга. струна
serviceProviderName Имя serviceProviderName. струна

ExpressRouteCircuitSku

Имя Description Ценность
family Семейство SKU. «Измеренные данные»
«Неограниченные данные»
имя Имя номера SKU. струна
tier Уровень артикула. 'Basic'
'Local'
'Premium'
'Standard'

ExpressRouteCircuitStats (ЭкспрессМаршрутКонтурСтатистика)

Имя Description Ценность
первичных байтовВ Первичные байтыВ пиринге. инт
первичные байтыВыход Основной BytesOut пиринга. инт
вторичных байтВ Вторичный BytesIn пиринга. инт
вторичныебайтыOut Вторичный BytesOut пиринга. инт

ExpressRouteConnectionId

Имя Description Ценность

Конфигурация ipv6CircuitConnectionConfig

Имя Description Ценность
addressПрефикс /125 пространство IP-адресов, чтобы выделить адреса клиентов для глобального охвата. струна

Ipv6ExpressRouteCircuitPeeringConfig

Имя Description Ценность
microsoftPeeringConfig Конфигурация пиринга Майкрософт. ExpressRouteCircuitPeeringConfig (ExpressRouteCircuitPeeringConfig)
первичныйPeerAddressПрефикс Префикс основного адреса. струна
маршрутФильтр Ссылка на ресурс RouteFilter. SubResource
secondaryPeerAddressПрефикс Префикс вторичного адреса. струна
государство Состояние пиринга. "Отключено"
"Включено"

ResourceTags

Имя Description Ценность

Подресурс

Имя Description Ценность
id Идентификатор ресурса. струна

Примеры использования

Примеры Terraform

Простой пример развертывания канала ExpressRoute.

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" "ExpressRoutePort" {
  type      = "Microsoft.Network/ExpressRoutePorts@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      bandwidthInGbps = 10
      encapsulation   = "Dot1Q"
      peeringLocation = "CDC-Canberra"
    }
  }
  schema_validation_enabled = false
  ignore_casing             = true
  response_export_values    = ["*"]
}

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 = ""
      bandwidthInGbps  = 5
      expressRoutePort = {
        id = azapi_resource.ExpressRoutePort.id
      }
    }
    sku = {
      family = "MeteredData"
      name   = "Premium_MeteredData"
      tier   = "Premium"
    }
  }
  schema_validation_enabled = false
  ignore_casing             = true
  response_export_values    = ["*"]
}

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Description
Контур ExpressRoute Ресурсный модуль AVM для ExpressRoute Circuit