Microsoft.Network expressRouteCircuits/peerings 2022-11-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
• 01.11.2020

Определение ресурса Bicep

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

• Группы ресурсов — см. команды развертывания группы ресурсов.

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

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

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

resource symbolicname 'Microsoft.Network/expressRouteCircuits/peerings@2022-11-01' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
        ]
        customerASN: int
        legacyMode: int
        routingRegistryName: 'string'
      }
      primaryPeerAddressPrefix: 'string'
      routeFilter: {
        id: 'string'
      }
      secondaryPeerAddressPrefix: 'string'
      state: 'string'
    }
    microsoftPeeringConfig: {
      advertisedCommunities: [
        'string'
      ]
      advertisedPublicPrefixes: [
        '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
  }
}

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

expressRouteCircuits/peerings

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	строка (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: expressRouteCircuits
properties	Свойства пиринга канала Express Route.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringPropertiesFormat

Имя	Описание	Значение
azureASN	The Azure ASN.	INT
connections	Список подключений канала, связанных с частным пирингом Azure для этого канала.	ExpressRouteCircuitConnection[]
expressRouteConnection	Подключение ExpressRoute.	ExpressRouteConnectionId
gatewayManagerEtag	Etag GatewayManager.	строка
ipv6PeeringConfig	Конфигурация пиринга IPv6.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	Конфигурация пиринга Майкрософт.	ExpressRouteCircuitPeeringConfig
peerASN	AsN однорангового узла.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 4294967295
peeringType	Тип пиринга.	AzurePrivatePeering AzurePublicPeering MicrosoftPeering
primaryAzurePort	Основной порт.	строка
primaryPeerAddressPrefix	Префикс основного адреса.	строка
routeFilter	Ссылка на ресурс RouteFilter.	SubResource
secondaryAzurePort	Дополнительный порт.	строка
secondaryPeerAddressPrefix	Префикс вторичного адреса.	строка
sharedKey	Общий ключ.	строка
Состояние	Состояние пиринга.	"Отключено" "Включено"
stats	Статистика пиринга канала express route.	ExpressRouteCircuitStats
vlanId	Идентификатор виртуальной локальной сети.	INT

ExpressRouteCircuitConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства подключения канала express route.	ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Имя	Описание	Значение
addressPrefix	/29 пространство IP-адресов, чтобы вырезать адреса клиентов для туннелей.	строка
authorizationKey	Ключ авторизации.	строка
expressRouteCircuitPeering	Ссылка на ресурс частного пиринга канала Express Route для соединения, инициирующего канал.	SubResource
ipv6CircuitConnectionConfig	Префикс IPv6-адресаСвойства подключения к каналу express route.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Ссылка на ресурс частного пиринга канала Express Route для однорангового канала.	SubResource

SubResource

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка

Ipv6CircuitConnectionConfig

Имя	Описание	Значение
addressPrefix	/125 пространства IP-адресов, чтобы вырезать адреса клиентов для глобального охвата.	строка

ExpressRouteConnectionId

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

Ipv6ExpressRouteCircuitPeeringConfig

Имя	Описание	Значение
microsoftPeeringConfig	Конфигурация пиринга Майкрософт.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	Префикс основного адреса.	строка
routeFilter	Ссылка на ресурс RouteFilter.	SubResource
secondaryPeerAddressPrefix	Префикс вторичного адреса.	строка
Состояние	Состояние пиринга.	"Отключено" "Включено"

ExpressRouteCircuitPeeringConfig

Имя	Описание	Значение
объявленныекоммунитивности	Сообщества пиринга bgp. Указывается для пиринга Майкрософт.	string[]
advertisedPublicPrefixes	Ссылка на AdvertisedPublicPrefixes.	string[]
customerASN	CustomerASN пиринга.	INT
legacyMode	Устаревший режим пиринга.	INT
routingRegistryName	RoutingRegistryName конфигурации.	строка

ExpressRouteCircuitStats

Имя	Описание	Значение
primarybytesIn	Основное значение BytesIn пиринга.	INT
primarybytesOut	Основной элемент BytesOut пиринга.	INT
secondarybytesIn	Дополнительный BytesIn пиринга.	INT
secondarybytesOut	Дополнительный элемент BytesOut пиринга.	INT

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

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

Шаблон	Описание
Канал ExpressRoute с частным пирингом и виртуальной сетью Azure	Этот шаблон настраивает пиринг Майкрософт ExpressRoute, развертывает виртуальную сеть Azure со шлюзом ExpressRoute и связывает виртуальную сеть с каналом ExpressRoute.

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

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

• Группы ресурсов — см. команды развертывания групп ресурсов.

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

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

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

{
  "type": "Microsoft.Network/expressRouteCircuits/peerings",
  "apiVersion": "2022-11-01",
  "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" ],
        "customerASN": "int",
        "legacyMode": "int",
        "routingRegistryName": "string"
      },
      "primaryPeerAddressPrefix": "string",
      "routeFilter": {
        "id": "string"
      },
      "secondaryPeerAddressPrefix": "string",
      "state": "string"
    },
    "microsoftPeeringConfig": {
      "advertisedCommunities": [ "string" ],
      "advertisedPublicPrefixes": [ "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"
  }
}

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

expressRouteCircuits/peerings

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.Network/expressRouteCircuits/peerings
версия_API	Версия API ресурсов	'2022-11-01'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно)
properties	Свойства пиринга канала express route.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringPropertiesFormat

Имя	Описание	Значение
azureASN	The Azure ASN.	INT
connections	Список подключений к каналу, связанных с частным пирингом Azure для этого канала.	ExpressRouteCircuitConnection[]
expressRouteConnection	Подключение ExpressRoute.	ExpressRouteConnectionId
gatewayManagerEtag	Тег Etag GatewayManager.	строка
ipv6PeeringConfig	Конфигурация пиринга IPv6.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	Конфигурация пиринга Майкрософт.	ExpressRouteCircuitPeeringConfig
peerASN	Одноранговый ASN.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 4294967295
peeringType	Тип пиринга.	AzurePrivatePeering AzurePublicPeering MicrosoftPeering
primaryAzurePort	Основной порт.	строка
primaryPeerAddressPrefix	Префикс основного адреса.	строка
routeFilter	Ссылка на ресурс RouteFilter.	SubResource
secondaryAzurePort	Дополнительный порт.	строка
secondaryPeerAddressPrefix	Префикс вторичного адреса.	строка
sharedKey	Общий ключ.	строка
Состояние	Состояние пиринга.	"Отключено" "Включено"
stats	Статистика пиринга канала express route.	ExpressRouteCircuitStats
vlanId	Идентификатор виртуальной локальной сети.	INT

ExpressRouteCircuitConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства подключения канала Express Route.	ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Имя	Описание	Значение
addressPrefix	/29 пространство IP-адресов, чтобы вырезать адреса клиентов для туннелей.	строка
authorizationKey	Ключ авторизации.	строка
expressRouteCircuitPeering	Ссылка на ресурс частного пиринга канала Express Route для подключения, инициирующего канал.	SubResource
ipv6CircuitConnectionConfig	Префикс IPv6-адресаСвойства подключения к каналу express route.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Ссылка на ресурс частного пиринга канала Express Route для пирингового канала.	SubResource

SubResource

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка

Ipv6CircuitConnectionConfig

Имя	Описание	Значение
addressPrefix	/125 пространство IP-адресов, чтобы вырезать адреса клиентов для глобального охвата.	строка

ExpressRouteConnectionId

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

Ipv6ExpressRouteCircuitPeeringConfig

Имя	Описание	Значение
microsoftPeeringConfig	Конфигурация пиринга Майкрософт.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	Префикс основного адреса.	строка
routeFilter	Ссылка на ресурс RouteFilter.	SubResource
secondaryPeerAddressPrefix	Префикс вторичного адреса.	строка
Состояние	Состояние пиринга.	"Отключено" "Включено"

ExpressRouteCircuitPeeringConfig

Имя	Описание	Значение
объявленныекоммунитивности	Сообщества пиринга bgp. Указывается для пиринга Майкрософт.	string[]
объявленныеPublicPrefixes	Ссылка на ОбъявленныеPublicPrefixes.	string[]
customerASN	CustomerASN пиринга.	INT
legacyMode	Устаревший режим пиринга.	INT
routingRegistryName	RoutingRegistryName конфигурации.	строка

ExpressRouteCircuitStats

Имя	Описание	Значение
primarybytesIn	Основной BytesIn пиринга.	INT
primarybytesOut	Основной элемент BytesOut пиринга.	INT
secondarybytesIn	Дополнительный BytesIn пиринга.	INT
secondarybytesOut	Дополнительный элемент BytesOut пиринга.	INT

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

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

Шаблон	Описание
Канал ExpressRoute с частным пирингом и виртуальной сетью Azure	Этот шаблон настраивает пиринг Майкрософт ExpressRoute, развертывает виртуальную сеть Azure со шлюзом ExpressRoute и связывает виртуальную сеть с каналом ExpressRoute.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCircuits/peerings@2022-11-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    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"
          ]
          customerASN = int
          legacyMode = int
          routingRegistryName = "string"
        }
        primaryPeerAddressPrefix = "string"
        routeFilter = {
          id = "string"
        }
        secondaryPeerAddressPrefix = "string"
        state = "string"
      }
      microsoftPeeringConfig = {
        advertisedCommunities = [
          "string"
        ]
        advertisedPublicPrefixes = [
          "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
    }
  })
}

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

expressRouteCircuits/peerings

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.Network/expressRouteCircuits/peerings@2022-11-01"
name	имя ресурса.	string (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: expressRouteCircuits
properties	Свойства пиринга канала express route.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringPropertiesFormat

Имя	Описание	Значение
azureASN	The Azure ASN.	INT
connections	Список подключений к каналу, связанных с частным пирингом Azure для этого канала.	ExpressRouteCircuitConnection[]
expressRouteConnection	Подключение ExpressRoute.	ExpressRouteConnectionId
gatewayManagerEtag	Тег Etag GatewayManager.	строка
ipv6PeeringConfig	Конфигурация пиринга IPv6.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	Конфигурация пиринга Майкрософт.	ExpressRouteCircuitPeeringConfig
peerASN	Одноранговый ASN.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 4294967295
peeringType	Тип пиринга.	AzurePrivatePeering AzurePublicPeering "MicrosoftPeering"
primaryAzurePort	Основной порт.	строка
primaryPeerAddressPrefix	Префикс основного адреса.	строка
routeFilter	Ссылка на ресурс RouteFilter.	SubResource
secondaryAzurePort	Дополнительный порт.	строка
secondaryPeerAddressPrefix	Префикс вторичного адреса.	строка
sharedKey	Общий ключ.	строка
Состояние	Состояние пиринга.	"Отключено" "Включено"
stats	Статистика пиринга канала express route.	ExpressRouteCircuitStats
vlanId	Идентификатор виртуальной локальной сети.	INT

ExpressRouteCircuitConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства подключения канала Express Route.	ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Имя	Описание	Значение
addressPrefix	/29 пространство IP-адресов, чтобы вырезать адреса клиентов для туннелей.	строка
authorizationKey	Ключ авторизации.	строка
expressRouteCircuitPeering	Ссылка на ресурс частного пиринга канала Express Route для подключения, инициирующего канал.	SubResource
ipv6CircuitConnectionConfig	Префикс IPv6-адресаСвойства подключения к каналу express route.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Ссылка на ресурс частного пиринга канала Express Route для пирингового канала.	SubResource

SubResource

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка

Ipv6CircuitConnectionConfig

Имя	Описание	Значение
addressPrefix	/125 пространство IP-адресов, чтобы вырезать адреса клиентов для глобального охвата.	строка

ExpressRouteConnectionId

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

Ipv6ExpressRouteCircuitPeeringConfig

Имя	Описание	Значение
microsoftPeeringConfig	Конфигурация пиринга Майкрософт.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	Префикс основного адреса.	строка
routeFilter	Ссылка на ресурс RouteFilter.	SubResource
secondaryPeerAddressPrefix	Префикс вторичного адреса.	строка
Состояние	Состояние пиринга.	"Отключено" "Включено"

ExpressRouteCircuitPeeringConfig

Имя	Описание	Значение
объявленныекоммунитивности	Сообщества пиринга bgp. Указывается для пиринга Майкрософт.	string[]
объявленныеPublicPrefixes	Ссылка на ОбъявленныеPublicPrefixes.	string[]
customerASN	CustomerASN пиринга.	INT
legacyMode	Устаревший режим пиринга.	INT
routingRegistryName	RoutingRegistryName конфигурации.	строка

ExpressRouteCircuitStats

Имя	Описание	Значение
primarybytesIn	Основной BytesIn пиринга.	INT
primarybytesOut	Основной элемент BytesOut пиринга.	INT
secondarybytesIn	Дополнительный BytesIn пиринга.	INT
secondarybytesOut	Дополнительный элемент BytesOut пиринга.	INT