Virtual Network Peerings - Get

Obtient le peering de réseau virtuel spécifié.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}?api-version=2023-09-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

Nom du groupe de ressources.

subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de façon unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

virtualNetworkName
path True

string

nom du réseau virtuel.

virtualNetworkPeeringName
path True

string

Nom du peering de réseau virtuel.

api-version
query True

string

Version d’API client.

Réponses

Nom Type Description
200 OK

VirtualNetworkPeering

Demande réussie. L’opération retourne la ressource VirtualNetworkPeering résultante.

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Get peering
Get peering with remote virtual network encryption

Get peering

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer?api-version=2023-09-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer",
  "name": "peer",
  "properties": {
    "allowVirtualNetworkAccess": true,
    "allowForwardedTraffic": true,
    "allowGatewayTransit": false,
    "useRemoteGateways": false,
    "remoteVirtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"
    },
    "remoteAddressSpace": {
      "addressPrefixes": [
        "12.0.0.0/8"
      ]
    },
    "remoteVirtualNetworkAddressSpace": {
      "addressPrefixes": [
        "12.0.0.0/8"
      ]
    },
    "remoteBgpCommunities": {
      "virtualNetworkCommunity": "12076:20002",
      "regionalCommunity": "12076:50004"
    },
    "peeringState": "Initiated",
    "peeringSyncLevel": "FullyInSync",
    "provisioningState": "Succeeded"
  }
}

Get peering with remote virtual network encryption

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer?api-version=2023-09-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer",
  "name": "peer",
  "properties": {
    "allowVirtualNetworkAccess": true,
    "allowForwardedTraffic": true,
    "allowGatewayTransit": false,
    "useRemoteGateways": false,
    "remoteVirtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"
    },
    "remoteAddressSpace": {
      "addressPrefixes": [
        "12.0.0.0/8"
      ]
    },
    "remoteBgpCommunities": {
      "virtualNetworkCommunity": "12076:20002",
      "regionalCommunity": "12076:50004"
    },
    "remoteVirtualNetworkEncryption": {
      "enabled": true,
      "enforcement": "AllowUnencrypted"
    },
    "peeringState": "Initiated",
    "provisioningState": "Succeeded"
  }
}

Définitions

Nom Description
AddressSpace

AddressSpace contient un tableau de plages d'adresses IP qui peuvent être utilisées par les sous-réseaux du réseau virtuel.

CloudError

Réponse d’erreur du service.

CloudErrorBody

Réponse d’erreur du service.

ProvisioningState

État d’approvisionnement actuel.

SubResource

Référence à une autre sous-ressource.

VirtualNetworkBgpCommunities

Communautés Bgp envoyées via ExpressRoute avec chaque itinéraire correspondant à un préfixe dans ce réseau virtuel.

VirtualNetworkEncryption

Indique si le chiffrement est activé sur le réseau virtuel et si la machine virtuelle sans chiffrement est autorisée dans le réseau virtuel chiffré.

VirtualNetworkEncryptionEnforcement

Si le réseau virtuel chiffré autorise la machine virtuelle qui ne prend pas en charge le chiffrement

VirtualNetworkPeering

Peerings dans une ressource de réseau virtuel.

VirtualNetworkPeeringLevel

La synchronisation de peering status du peering de réseau virtuel.

VirtualNetworkPeeringState

Status du peering de réseaux virtuels.

AddressSpace

AddressSpace contient un tableau de plages d'adresses IP qui peuvent être utilisées par les sous-réseaux du réseau virtuel.

Nom Type Description
addressPrefixes

string[]

Liste des blocs d’adresses réservés à ce réseau virtuel en notation CIDR.

CloudError

Réponse d’erreur du service.

Nom Type Description
error

CloudErrorBody

Corps de l’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom Type Description
code

string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.

details

CloudErrorBody[]

Liste des détails supplémentaires sur l’erreur.

message

string

Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.

target

string

Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur.

ProvisioningState

État d’approvisionnement actuel.

Nom Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

SubResource

Référence à une autre sous-ressource.

Nom Type Description
id

string

ID de la ressource

VirtualNetworkBgpCommunities

Communautés Bgp envoyées via ExpressRoute avec chaque itinéraire correspondant à un préfixe dans ce réseau virtuel.

Nom Type Description
regionalCommunity

string

Communauté BGP associée à la région du réseau virtuel.

virtualNetworkCommunity

string

Communauté BGP associée au réseau virtuel.

VirtualNetworkEncryption

Indique si le chiffrement est activé sur le réseau virtuel et si la machine virtuelle sans chiffrement est autorisée dans le réseau virtuel chiffré.

Nom Type Description
enabled

boolean

Indique si le chiffrement est activé sur le réseau virtuel.

enforcement

VirtualNetworkEncryptionEnforcement

Si le réseau virtuel chiffré autorise la machine virtuelle qui ne prend pas en charge le chiffrement

VirtualNetworkEncryptionEnforcement

Si le réseau virtuel chiffré autorise la machine virtuelle qui ne prend pas en charge le chiffrement

Nom Type Description
AllowUnencrypted

string

DropUnencrypted

string

VirtualNetworkPeering

Peerings dans une ressource de réseau virtuel.

Nom Type Description
etag

string

Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.

id

string

ID de la ressource

name

string

Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.

properties.allowForwardedTraffic

boolean

Indique si le trafic transféré à partir des machines virtuelles du réseau virtuel local sera autorisé/interdit dans le réseau virtuel distant.

properties.allowGatewayTransit

boolean

Si des liens de passerelle peuvent être utilisés dans un réseau virtuel distant pour établir une liaison à ce réseau virtuel.

properties.allowVirtualNetworkAccess

boolean

Indique si les machines virtuelles de l’espace réseau virtuel local peuvent accéder aux machines virtuelles dans l’espace du réseau virtuel distant.

properties.doNotVerifyRemoteGateways

boolean

Si nous devons vérifier l’état d’approvisionnement de la passerelle distante.

properties.peeringState

VirtualNetworkPeeringState

Status du peering de réseaux virtuels.

properties.peeringSyncLevel

VirtualNetworkPeeringLevel

La synchronisation de peering status du peering de réseau virtuel.

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource de peering de réseaux virtuels.

properties.remoteAddressSpace

AddressSpace

Référence à l’espace d’adressage appairé avec le réseau virtuel distant.

properties.remoteBgpCommunities

VirtualNetworkBgpCommunities

Référence aux communautés Bgp du réseau virtuel distant.

properties.remoteVirtualNetwork

SubResource

Référence au réseau virtuel distant. Le réseau virtuel distant peut se trouver dans la même région ou dans une autre région (préversion). Consultez ici pour vous inscrire à la préversion et en savoir plus (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).

properties.remoteVirtualNetworkAddressSpace

AddressSpace

Référence à l’espace d’adressage actuel du réseau virtuel distant.

properties.remoteVirtualNetworkEncryption

VirtualNetworkEncryption

Référence au chiffrement du réseau virtuel distant

properties.resourceGuid

string

Propriété resourceGuid de la ressource de peering Réseau virtuel.

properties.useRemoteGateways

boolean

Si les passerelles distantes peuvent être utilisées sur ce réseau virtuel. Si l’indicateur est défini sur true et que allowGatewayTransit sur le peering distant a également la valeur true, le réseau virtuel utilise des passerelles de réseau virtuel distant pour le transit. Un seul peering peut avoir cet indicateur défini sur true. Cet indicateur ne peut pas être défini si le réseau virtuel dispose déjà d’une passerelle.

type

string

Type de ressource.

VirtualNetworkPeeringLevel

La synchronisation de peering status du peering de réseau virtuel.

Nom Type Description
FullyInSync

string

LocalAndRemoteNotInSync

string

LocalNotInSync

string

RemoteNotInSync

string

VirtualNetworkPeeringState

Status du peering de réseaux virtuels.

Nom Type Description
Connected

string

Disconnected

string

Initiated

string