Microsoft.Network expressRouteCircuits/peerings 2023-11-01

Artigo
05/08/2024

Definição de recurso do Bicep

O tipo de recurso expressRouteCircuits/peerings pode ser implementado com operações que visam:

Grupos de recursos – veja comandos de implementação de grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/expressRouteCircuits/peerings, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Network/expressRouteCircuits/peerings@2023-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
  }
}

Valores de propriedade

expressRouteCircuits/peerings

Nome	Descrição	Valor
name	O nome do recurso Veja como definir nomes e tipos para recursos subordinados no Bicep.	cadeia (obrigatório)
principal	No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal. Para obter mais informações, veja Recurso subordinado fora do recurso principal.	Nome simbólico para recurso do tipo: expressRouteCircuits
propriedades	Propriedades do peering do circuito de rota rápida.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringPropertiesFormat

Nome	Descrição	Valor
azureASN	O ASN do Azure.	int
ligações	A lista de ligações de circuito associadas ao Peering Privado do Azure para este circuito.	ExpressRouteCircuitConnection[]
expressRouteConnection	A ligação do ExpressRoute.	ExpressRouteConnectionId
gatewayManagerEtag	O GatewayManager Etag.	string
ipv6PeeringConfig	A configuração de peering IPv6.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	A configuração do peering da Microsoft.	ExpressRouteCircuitPeeringConfig
peerASN	O ASN do elemento da rede.	int Restrições: Valor mínimo = 1 Valor máximo = 4294967295
peeringType	O tipo de peering.	"AzurePrivatePeering" "AzurePublicPeering" "MicrosoftPeering"
primaryAzurePort	A porta primária.	string
primaryPeerAddressPrefix	O prefixo de endereço principal.	string
routeFilter	A referência ao recurso RouteFilter.	Sub-origem
secondaryAzurePort	A porta secundária.	string
secondaryPeerAddressPrefix	O prefixo de endereço secundário.	string
sharedKey	A chave partilhada.	string
state	O estado do peering.	"Desativado" "Ativado"
stats	As estatísticas de peering do circuito express route.	ExpressRouteCircuitStats
vlanId	O ID da VLAN.	int

ExpressRouteCircuitConnection

Nome	Descrição	Valor
ID	ID do Recurso.	string
name	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.	string
propriedades	Propriedades da ligação do circuito de rota rápida.	ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Nome	Descrição	Valor
addressPrefix	/29 espaço de endereços IP para esculpir endereços de cliente para túneis.	string
authorizationKey	A chave de autorização.	string
expressRouteCircuitPeering	Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito que inicia a ligação.	Sub-origem
ipv6CircuitConnectionConfig	Prefixo de Endereço IPv6Propriedades da ligação do circuito de rota rápida.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito em modo de peering.	Sub-origem

Sub-origem

Nome	Descrição	Valor
ID	ID do Recurso.	string

Ipv6CircuitConnectionConfig

Nome	Descrição	Valor
addressPrefix	/125 espaço de endereços IP para esculpe os endereços dos clientes para alcance global.	string

ExpressRouteConnectionId

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

Ipv6ExpressRouteCircuitPeeringConfig

Nome	Descrição	Valor
microsoftPeeringConfig	A configuração do peering da Microsoft.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	O prefixo de endereço principal.	string
routeFilter	A referência ao recurso RouteFilter.	Sub-origem
secondaryPeerAddressPrefix	O prefixo de endereço secundário.	string
state	O estado do peering.	"Desativado" "Ativado"

ExpressRouteCircuitPeeringConfig

Nome	Descrição	Valor
advertisedCommunities	As comunidades do peering bgp. Especificado para peering da Microsoft.	cadeia[]
advertisedPublicPrefixes	A referência a AdvertisedPublicPrefixes.	cadeia[]
customerASN	O CustomerASN do peering.	int
legacyMode	O modo legado do peering.	int
routingRegistryName	O RoutingRegistryName da configuração.	string

ExpressRouteCircuitStats

Nome	Descrição	Valor
primarybytesIn	O BytesIn Principal do peering.	int
primarybytesOut	O BytesOut principal do peering.	int
secondarybytesIn	O BytesIn secundário do peering.	int
secondarybytesOut	O BytesOut secundário do peering.	int

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Circuito do ExpressRoute com peering privado e VNet do Azure	Este modelo configura o peering da Microsoft do ExpressRoute, implementa uma VNet do Azure com o gateway do Expressroute e liga a VNet ao circuito do ExpressRoute

Definição de recurso do modelo arm

O tipo de recurso expressRouteCircuits/peerings pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/expressRouteCircuits/peerings, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Network/expressRouteCircuits/peerings",
  "apiVersion": "2023-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"
  }
}

Valores de propriedade

expressRouteCircuits/peerings

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Network/expressRouteCircuits/peerings"
apiVersion	A versão da API de recursos	'2023-11-01'
name	O nome do recurso Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.	cadeia (obrigatório)
propriedades	Propriedades do peering do circuito do expressroute.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringPropertiesFormat

Nome	Descrição	Valor
azureASN	O ASN do Azure.	int
ligações	A lista de ligações de circuito associadas ao Peering Privado do Azure para este circuito.	ExpressRouteCircuitConnection[]
expressRouteConnection	A ligação do ExpressRoute.	ExpressRouteConnectionId
gatewayManagerEtag	O GatewayManager Etag.	string
ipv6PeeringConfig	A configuração de peering IPv6.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	A configuração do peering da Microsoft.	ExpressRouteCircuitPeeringConfig
peerASN	O ASN do elemento da rede.	int Restrições: Valor mínimo = 1 Valor máximo = 4294967295
peeringType	O tipo de peering.	"AzurePrivatePeering" "AzurePublicPeering" "MicrosoftPeering"
primaryAzurePort	A porta primária.	string
primaryPeerAddressPrefix	O prefixo do endereço principal.	string
routeFilter	A referência ao recurso RouteFilter.	Sub-origem
secondaryAzurePort	A porta secundária.	string
secondaryPeerAddressPrefix	O prefixo de endereço secundário.	string
sharedKey	A chave partilhada.	string
state	O estado do peering.	"Desativado" "Ativado"
stats	As estatísticas de peering do circuito express route.	ExpressRouteCircuitStats
vlanId	O ID da VLAN.	int

ExpressRouteCircuitConnection

Nome	Descrição	Valor
ID	ID do Recurso.	string
name	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.	string
propriedades	Propriedades da ligação do circuito do expressroute.	ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Nome	Descrição	Valor
addressPrefix	/29 espaço de endereços IP para criar endereços de cliente para túneis.	string
authorizationKey	A chave de autorização.	string
expressRouteCircuitPeering	Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito que inicia a ligação.	Sub-origem
ipv6CircuitConnectionConfig	Prefixo de Endereço IPv6Propriedades da ligação do circuito de rota rápida.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Referência ao Recurso de Peering Privado do Circuito do ExpressRoute do circuito em modo de peering.	Sub-origem

Sub-origem

Nome	Descrição	Valor
ID	ID do Recurso.	string

Ipv6CircuitConnectionConfig

Nome	Descrição	Valor
addressPrefix	/125 espaço de endereços IP para criar endereços de cliente para alcance global.	string

ExpressRouteConnectionId

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

Ipv6ExpressRouteCircuitPeeringConfig

Nome	Descrição	Valor
microsoftPeeringConfig	A configuração do peering da Microsoft.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	O prefixo do endereço principal.	string
routeFilter	A referência ao recurso RouteFilter.	Sub-origem
secondaryPeerAddressPrefix	O prefixo de endereço secundário.	string
state	O estado do peering.	"Desativado" "Ativado"

ExpressRouteCircuitPeeringConfig

Nome	Descrição	Valor
advertisedCommunities	As comunidades do peering bgp. Especificado para peering da Microsoft.	string[]
advertisedPublicPrefixes	A referência a AdvertisedPublicPrefixes.	string[]
customerASN	O CustomerASN do peering.	int
legacyMode	O modo legado do peering.	int
routingRegistryName	O RoutingRegistryName da configuração.	string

ExpressRouteCircuitStats

Nome	Descrição	Valor
primarybytesIn	O BytesIn Principal do peering.	int
primarybytesOut	O BytesOut principal do peering.	int
secondarybytesIn	O BytesIn secundário do peering.	int
secondarybytesOut	O BytesOut secundário do peering.	int

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Circuito do ExpressRoute com peering privado e VNet do Azure	Este modelo configura o peering da Microsoft do ExpressRoute, implementa uma VNet do Azure com o gateway do Expressroute e liga a VNet ao circuito do ExpressRoute

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso expressRouteCircuits/peerings pode ser implementado com operações que visam:

Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/expressRouteCircuits/peerings, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCircuits/peerings@2023-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
    }
  })
}

Valores de propriedade

expressRouteCircuits/peerings

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Network/expressRouteCircuits/peerings@2023-11-01"
name	O nome do recurso	cadeia (obrigatório)
parent_id	O ID do recurso que é o principal para este recurso.	ID do recurso do tipo: expressRouteCircuits
propriedades	Propriedades do peering do circuito do expressroute.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringPropertiesFormat

Nome	Descrição	Valor
azureASN	O ASN do Azure.	int
ligações	A lista de ligações de circuito associadas ao Peering Privado do Azure para este circuito.	ExpressRouteCircuitConnection[]
expressRouteConnection	A ligação do ExpressRoute.	ExpressRouteConnectionId
gatewayManagerEtag	O GatewayManager Etag.	string
ipv6PeeringConfig	A configuração de peering IPv6.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	A configuração do peering da Microsoft.	ExpressRouteCircuitPeeringConfig
peerASN	O ASN do elemento da rede.	int Restrições: Valor mínimo = 1 Valor máximo = 4294967295
peeringType	O tipo de peering.	"AzurePrivatePeering" "AzurePublicPeering" "MicrosoftPeering"
primaryAzurePort	A porta primária.	string
primaryPeerAddressPrefix	O prefixo do endereço principal.	string
routeFilter	A referência ao recurso RouteFilter.	Sub-origem
secondaryAzurePort	A porta secundária.	string
secondaryPeerAddressPrefix	O prefixo de endereço secundário.	string
sharedKey	A chave partilhada.	string
state	O estado do peering.	"Desativado" "Ativado"
stats	As estatísticas de peering do circuito express route.	ExpressRouteCircuitStats
vlanId	O ID da VLAN.	int

ExpressRouteCircuitConnection

Nome	Descrição	Valor
ID	ID do Recurso.	string
name	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.	string
propriedades	Propriedades da ligação do circuito do expressroute.	ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Nome	Descrição	Valor
addressPrefix	/29 espaço de endereços IP para criar endereços de cliente para túneis.	string
authorizationKey	A chave de autorização.	string
expressRouteCircuitPeering	Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito que inicia a ligação.	Sub-origem
ipv6CircuitConnectionConfig	Prefixo de Endereço IPv6Propriedades da ligação do circuito de rota rápida.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Referência ao Recurso de Peering Privado do Circuito do ExpressRoute do circuito em modo de peering.	Sub-origem

Sub-origem

Nome	Descrição	Valor
ID	ID do Recurso.	string

Ipv6CircuitConnectionConfig

Nome	Descrição	Valor
addressPrefix	/125 espaço de endereços IP para criar endereços de cliente para alcance global.	string

ExpressRouteConnectionId

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

Ipv6ExpressRouteCircuitPeeringConfig

Nome	Descrição	Valor
microsoftPeeringConfig	A configuração do peering da Microsoft.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	O prefixo do endereço principal.	string
routeFilter	A referência ao recurso RouteFilter.	Sub-origem
secondaryPeerAddressPrefix	O prefixo de endereço secundário.	string
state	O estado do peering.	"Desativado" "Ativado"

ExpressRouteCircuitPeeringConfig

Nome	Descrição	Valor
advertisedCommunities	As comunidades do peering bgp. Especificado para peering da Microsoft.	string[]
advertisedPublicPrefixes	A referência a AdvertisedPublicPrefixes.	string[]
customerASN	O CustomerASN do peering.	int
legacyMode	O modo legado do peering.	int
routingRegistryName	O RoutingRegistryName da configuração.	string

ExpressRouteCircuitStats

Nome	Descrição	Valor
primarybytesIn	O BytesIn Principal do peering.	int
primarybytesOut	O BytesOut principal do peering.	int
secondarybytesIn	O BytesIn secundário do peering.	int
secondarybytesOut	O BytesOut secundário do peering.	int

Partilhar via

Microsoft.Network expressRouteCircuits/peerings 2023-11-01

Definição de recurso do Bicep

Formato do recurso

Valores de propriedade

expressRouteCircuits/peerings

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitConnection

ExpressRouteCircuitConnectionPropertiesFormat

Sub-origem

Ipv6CircuitConnectionConfig

ExpressRouteConnectionId

Ipv6ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitStats

Modelos de início rápido

Definição de recurso do modelo arm

Formato do recurso

Valores de propriedade

expressRouteCircuits/peerings

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitConnection

ExpressRouteCircuitConnectionPropertiesFormat

Sub-origem

Ipv6CircuitConnectionConfig

ExpressRouteConnectionId

Ipv6ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitStats

Modelos de início rápido

Definição de recurso terraform (fornecedor AzAPI)

Formato do recurso

Valores de propriedade

expressRouteCircuits/peerings

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitConnection

ExpressRouteCircuitConnectionPropertiesFormat

Sub-origem

Ipv6CircuitConnectionConfig

ExpressRouteConnectionId

Ipv6ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitStats

Comentários

Recursos adicionais