Peerings - Get

Obtém um peering existente com o nome especificado sob a assinatura e o grupo de recursos especificados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}?api-version=2021-01-01

Parâmetros de URI

Name In Required Type Description
peeringName
path True
  • string

O nome do peering.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

subscriptionId
path True
  • string

A ID de assinatura do Azure.

api-version
query True
  • string

A versão da API do cliente.

Respostas

Name Type Description
200 OK

OK

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory fluxo OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Get a peering

Sample Request

GET https://management.azure.com/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName?api-version=2021-01-01

Sample Response

{
  "sku": {
    "name": "Basic_Exchange_Free",
    "tier": "Basic",
    "family": "Exchange",
    "size": "Free"
  },
  "kind": "Exchange",
  "properties": {
    "exchange": {
      "connections": [
        {
          "peeringDBFacilityId": 99999,
          "connectionState": "Active",
          "bgpSession": {
            "microsoftSessionIPv4Address": "192.168.3.1",
            "microsoftSessionIPv6Address": "fd00::1:1",
            "peerSessionIPv4Address": "192.168.2.1",
            "peerSessionIPv6Address": "fd00::1",
            "sessionStateV4": "Established",
            "sessionStateV6": "Established",
            "maxPrefixesAdvertisedV4": 1000,
            "maxPrefixesAdvertisedV6": 100,
            "md5AuthenticationKey": "test-md5-auth-key"
          },
          "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D"
        },
        {
          "peeringDBFacilityId": 99999,
          "connectionState": "Active",
          "bgpSession": {
            "microsoftSessionIPv4Address": "192.168.3.2",
            "microsoftSessionIPv6Address": "fd00::1:2",
            "peerSessionIPv4Address": "192.168.2.2",
            "peerSessionIPv6Address": "fd00::2",
            "sessionStateV4": "Established",
            "sessionStateV6": "Established",
            "maxPrefixesAdvertisedV4": 1000,
            "maxPrefixesAdvertisedV6": 100,
            "md5AuthenticationKey": "test-md5-auth-key"
          },
          "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B"
        }
      ],
      "peerAsn": {
        "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1"
      }
    },
    "peeringLocation": "peeringLocation0",
    "provisioningState": "Succeeded"
  },
  "location": "eastus",
  "name": "peeringName",
  "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName",
  "type": "Microsoft.Peering/peerings"
}

Definições

BgpSession

As propriedades que definem uma sessão BGP.

connectionState

O estado da conexão.

DirectConnection

As propriedades que definem uma conexão direta.

directPeeringType

O tipo de peering direto.

ErrorDetail

O detalhe do erro que descreve por que uma operação falhou.

ErrorResponse

A resposta de erro que indica por que uma operação falhou.

ExchangeConnection

As propriedades que definem uma conexão de troca.

family

A família da SKU de peering.

kind

O tipo do peering.

Peering

O peering é uma representação lógica de um conjunto de conexões com o Microsoft Cloud Edge em um local.

PeeringPropertiesDirect

As propriedades que definem um peering direto.

PeeringPropertiesExchange

As propriedades que definem um peering de troca.

PeeringSku

O SKU que define a camada e o tipo do peering.

provisioningState

O estado de provisionamento do recurso.

sessionAddressProvider

O campo que indica se a Microsoft fornece endereços IP de sessão.

sessionStateV4

O estado da sessão IPv4.

sessionStateV6

O estado da sessão IPv6.

size

O tamanho da SKU de peering.

SubResource

O sub-recurso.

tier

A camada do SKU de peering.

BgpSession

As propriedades que definem uma sessão BGP.

Name Type Description
maxPrefixesAdvertisedV4
  • integer

O número máximo de prefixos anunciados na sessão IPv4.

maxPrefixesAdvertisedV6
  • integer

O número máximo de prefixos anunciados na sessão IPv6.

md5AuthenticationKey
  • string

A chave de autenticação MD5 da sessão.

microsoftSessionIPv4Address
  • string

O endereço de sessão IPv4 no final da Microsoft.

microsoftSessionIPv6Address
  • string

O endereço de sessão IPv6 no final da Microsoft.

peerSessionIPv4Address
  • string

O endereço de sessão IPv4 no final do par.

peerSessionIPv6Address
  • string

O endereço de sessão IPv6 no final do par.

sessionPrefixV4
  • string

O prefixo IPv4 que contém os endereços IPv4 de ambas as extremidades.

sessionPrefixV6
  • string

O prefixo IPv6 que contém os endereços IPv6 de ambas as extremidades.

sessionStateV4

O estado da sessão IPv4.

sessionStateV6

O estado da sessão IPv6.

connectionState

O estado da conexão.

Name Type Description
Active
  • string
Approved
  • string
None
  • string
PendingApproval
  • string
ProvisioningCompleted
  • string
ProvisioningFailed
  • string
ProvisioningStarted
  • string
Validating
  • string

DirectConnection

As propriedades que definem uma conexão direta.

Name Type Description
bandwidthInMbps
  • integer

A largura de banda da conexão.

bgpSession

A sessão BGP associada à conexão.

connectionIdentifier
  • string

O GUID (identificador exclusivo) para a conexão.

connectionState

O estado da conexão.

errorMessage
  • string

A mensagem de erro relacionada ao estado da conexão, se for o caso.

microsoftTrackingId
  • string

A ID usada no sistema de provisionamento de peering da Microsoft para acompanhar a conexão

peeringDBFacilityId
  • integer

A PeeringDB.com ID do recurso no qual a conexão deve ser configurada.

provisionedBandwidthInMbps
  • integer

A largura de banda que é realmente provisionada.

sessionAddressProvider

O campo que indica se a Microsoft fornece endereços IP de sessão.

useForPeeringService
  • boolean

O sinalizador que indica se a conexão é usada ou não para o serviço de peering.

directPeeringType

O tipo de peering direto.

Name Type Description
Cdn
  • string
Edge
  • string
Internal
  • string
Ix
  • string
IxRs
  • string
Transit
  • string
Voice
  • string

ErrorDetail

O detalhe do erro que descreve por que uma operação falhou.

Name Type Description
code
  • string

O código de erro.

message
  • string

A mensagem de erro.

ErrorResponse

A resposta de erro que indica por que uma operação falhou.

Name Type Description
error

O detalhe do erro que descreve por que uma operação falhou.

ExchangeConnection

As propriedades que definem uma conexão de troca.

Name Type Description
bgpSession

A sessão BGP associada à conexão.

connectionIdentifier
  • string

O GUID (identificador exclusivo) para a conexão.

connectionState

O estado da conexão.

errorMessage
  • string

A mensagem de erro relacionada ao estado da conexão, se for o caso.

peeringDBFacilityId
  • integer

A PeeringDB.com ID do recurso no qual a conexão deve ser configurada.

family

A família da SKU de peering.

Name Type Description
Direct
  • string
Exchange
  • string

kind

O tipo do peering.

Name Type Description
Direct
  • string
Exchange
  • string

Peering

O peering é uma representação lógica de um conjunto de conexões com o Microsoft Cloud Edge em um local.

Name Type Description
id
  • string

A ID do recurso.

kind

O tipo do peering.

location
  • string

A localização do recurso.

name
  • string

O nome do recurso.

properties.direct

As propriedades que definem um peering direto.

properties.exchange

As propriedades que definem um peering de troca.

properties.peeringLocation
  • string

O local do peering.

properties.provisioningState

O estado de provisionamento do recurso.

sku

O SKU que define a camada e o tipo do peering.

tags
  • object

As marcas do recurso.

type
  • string

Tipo do recurso.

PeeringPropertiesDirect

As propriedades que definem um peering direto.

Name Type Description
connections

O conjunto de conexões que constituem um peering direto.

directPeeringType

O tipo de peering direto.

peerAsn

A referência do ASN par.

useForPeeringService
  • boolean

O sinalizador que indica se o peering é usado ou não para o serviço de peering.

PeeringPropertiesExchange

As propriedades que definem um peering de troca.

Name Type Description
connections

O conjunto de conexões que constituem um par de troca.

peerAsn

A referência do ASN par.

PeeringSku

O SKU que define a camada e o tipo do peering.

Name Type Description
family

A família da SKU de peering.

name
  • string

O nome do SKU de peering.

size

O tamanho da SKU de peering.

tier

A camada do SKU de peering.

provisioningState

O estado de provisionamento do recurso.

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

sessionAddressProvider

O campo que indica se a Microsoft fornece endereços IP de sessão.

Name Type Description
Microsoft
  • string
Peer
  • string

sessionStateV4

O estado da sessão IPv4.

Name Type Description
Active
  • string
Connect
  • string
Established
  • string
Idle
  • string
None
  • string
OpenConfirm
  • string
OpenReceived
  • string
OpenSent
  • string
PendingAdd
  • string
PendingRemove
  • string
PendingUpdate
  • string

sessionStateV6

O estado da sessão IPv6.

Name Type Description
Active
  • string
Connect
  • string
Established
  • string
Idle
  • string
None
  • string
OpenConfirm
  • string
OpenReceived
  • string
OpenSent
  • string
PendingAdd
  • string
PendingRemove
  • string
PendingUpdate
  • string

size

O tamanho da SKU de peering.

Name Type Description
Free
  • string
Metered
  • string
Unlimited
  • string

SubResource

O sub-recurso.

Name Type Description
id
  • string

O identificador do recurso referenciado.

tier

A camada do SKU de peering.

Name Type Description
Basic
  • string
Premium
  • string