Virtual Network Peerings - List

Service:

Virtual Networks

API Version:

2023-09-01

Hiermee haalt u alle peerings van virtuele netwerken in een virtueel netwerk op.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
virtualNetworkName	path	True	string	De naam van het virtuele netwerk.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	VirtualNetworkPeeringListResult	De aanvraag is voltooid. De bewerking retourneert een lijst met VirtualNetworkPeering-resources.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

List peerings

List peerings with remote virtual network encryption

List peerings

Sample Request

HTTP

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

Java

/**
 * Samples for VirtualNetworkPeerings List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringList.
     * json
     */
    /**
     * Sample code: List peerings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listPeerings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkPeerings().list("peerTest", "vnet1",
            com.azure.core.util.Context.NONE);
    }

    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json
     */
    /**
     * Sample code: List peerings with remote virtual network encryption.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listPeeringsWithRemoteVirtualNetworkEncryption(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkPeerings().list("peerTest", "vnet1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_peering_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.virtual_network_peerings.list(
        resource_group_name="peerTest",
        virtual_network_name="vnet1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringList.json
func ExampleVirtualNetworkPeeringsClient_NewListPager_listPeerings() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVirtualNetworkPeeringsClient().NewListPager("peerTest", "vnet1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualNetworkPeeringListResult = armnetwork.VirtualNetworkPeeringListResult{
		// 	Value: []*armnetwork.VirtualNetworkPeering{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer"),
		// 			Name: to.Ptr("peer"),
		// 			Properties: &armnetwork.VirtualNetworkPeeringPropertiesFormat{
		// 				AllowForwardedTraffic: to.Ptr(true),
		// 				AllowGatewayTransit: to.Ptr(false),
		// 				AllowVirtualNetworkAccess: to.Ptr(true),
		// 				PeeringState: to.Ptr(armnetwork.VirtualNetworkPeeringStateInitiated),
		// 				PeeringSyncLevel: to.Ptr(armnetwork.VirtualNetworkPeeringLevelFullyInSync),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				RemoteAddressSpace: &armnetwork.AddressSpace{
		// 					AddressPrefixes: []*string{
		// 						to.Ptr("12.0.0.0/8")},
		// 					},
		// 					RemoteBgpCommunities: &armnetwork.VirtualNetworkBgpCommunities{
		// 						RegionalCommunity: to.Ptr("12076:50004"),
		// 						VirtualNetworkCommunity: to.Ptr("12076:20002"),
		// 					},
		// 					RemoteVirtualNetwork: &armnetwork.SubResource{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"),
		// 					},
		// 					RemoteVirtualNetworkAddressSpace: &armnetwork.AddressSpace{
		// 						AddressPrefixes: []*string{
		// 							to.Ptr("12.0.0.0/8")},
		// 						},
		// 						UseRemoteGateways: to.Ptr(false),
		// 					},
		// 				},
		// 				{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2"),
		// 					Name: to.Ptr("peer"),
		// 					Properties: &armnetwork.VirtualNetworkPeeringPropertiesFormat{
		// 						AllowForwardedTraffic: to.Ptr(false),
		// 						AllowGatewayTransit: to.Ptr(false),
		// 						AllowVirtualNetworkAccess: to.Ptr(true),
		// 						PeeringState: to.Ptr(armnetwork.VirtualNetworkPeeringStateInitiated),
		// 						PeeringSyncLevel: to.Ptr(armnetwork.VirtualNetworkPeeringLevelFullyInSync),
		// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 						RemoteAddressSpace: &armnetwork.AddressSpace{
		// 							AddressPrefixes: []*string{
		// 								to.Ptr("13.0.0.0/8")},
		// 							},
		// 							RemoteBgpCommunities: &armnetwork.VirtualNetworkBgpCommunities{
		// 								RegionalCommunity: to.Ptr("12076:50004"),
		// 								VirtualNetworkCommunity: to.Ptr("12076:20003"),
		// 							},
		// 							RemoteVirtualNetwork: &armnetwork.SubResource{
		// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3"),
		// 							},
		// 							RemoteVirtualNetworkAddressSpace: &armnetwork.AddressSpace{
		// 								AddressPrefixes: []*string{
		// 									to.Ptr("13.0.0.0/8")},
		// 								},
		// 								UseRemoteGateways: to.Ptr(false),
		// 							},
		// 					}},
		// 				}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all virtual network peerings in a virtual network.
 *
 * @summary Gets all virtual network peerings in a virtual network.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringList.json
 */
async function listPeerings() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "peerTest";
  const virtualNetworkName = "vnet1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualNetworkPeerings.list(
    resourceGroupName,
    virtualNetworkName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringList.json
// this example is just showing the usage of "VirtualNetworkPeerings_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualNetworkResource created on azure
// for more information of creating VirtualNetworkResource, please refer to the document of VirtualNetworkResource
string subscriptionId = "subid";
string resourceGroupName = "peerTest";
string virtualNetworkName = "vnet1";
ResourceIdentifier virtualNetworkResourceId = VirtualNetworkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkName);
VirtualNetworkResource virtualNetwork = client.GetVirtualNetworkResource(virtualNetworkResourceId);

// get the collection of this VirtualNetworkPeeringResource
VirtualNetworkPeeringCollection collection = virtualNetwork.GetVirtualNetworkPeerings();

// invoke the operation and iterate over the result
await foreach (VirtualNetworkPeeringResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualNetworkPeeringData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "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"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2",
      "name": "peer",
      "properties": {
        "allowVirtualNetworkAccess": true,
        "allowForwardedTraffic": false,
        "allowGatewayTransit": false,
        "useRemoteGateways": false,
        "remoteVirtualNetwork": {
          "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3"
        },
        "remoteAddressSpace": {
          "addressPrefixes": [
            "13.0.0.0/8"
          ]
        },
        "remoteVirtualNetworkAddressSpace": {
          "addressPrefixes": [
            "13.0.0.0/8"
          ]
        },
        "remoteBgpCommunities": {
          "virtualNetworkCommunity": "12076:20003",
          "regionalCommunity": "12076:50004"
        },
        "peeringState": "Initiated",
        "peeringSyncLevel": "FullyInSync",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

List peerings with remote virtual network encryption

Sample Request

HTTP

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

Java

No code sample is available. To request a code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_peering_list_with_remote_virtual_network_encryption.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.virtual_network_peerings.list(
        resource_group_name="peerTest",
        virtual_network_name="vnet1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json
func ExampleVirtualNetworkPeeringsClient_NewListPager_listPeeringsWithRemoteVirtualNetworkEncryption() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVirtualNetworkPeeringsClient().NewListPager("peerTest", "vnet1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualNetworkPeeringListResult = armnetwork.VirtualNetworkPeeringListResult{
		// 	Value: []*armnetwork.VirtualNetworkPeering{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer"),
		// 			Name: to.Ptr("peer"),
		// 			Properties: &armnetwork.VirtualNetworkPeeringPropertiesFormat{
		// 				AllowForwardedTraffic: to.Ptr(true),
		// 				AllowGatewayTransit: to.Ptr(false),
		// 				AllowVirtualNetworkAccess: to.Ptr(true),
		// 				PeeringState: to.Ptr(armnetwork.VirtualNetworkPeeringStateInitiated),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				RemoteAddressSpace: &armnetwork.AddressSpace{
		// 					AddressPrefixes: []*string{
		// 						to.Ptr("12.0.0.0/8")},
		// 					},
		// 					RemoteBgpCommunities: &armnetwork.VirtualNetworkBgpCommunities{
		// 						RegionalCommunity: to.Ptr("12076:50004"),
		// 						VirtualNetworkCommunity: to.Ptr("12076:20002"),
		// 					},
		// 					RemoteVirtualNetwork: &armnetwork.SubResource{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"),
		// 					},
		// 					RemoteVirtualNetworkEncryption: &armnetwork.VirtualNetworkEncryption{
		// 						Enabled: to.Ptr(true),
		// 						Enforcement: to.Ptr(armnetwork.VirtualNetworkEncryptionEnforcementAllowUnencrypted),
		// 					},
		// 					UseRemoteGateways: to.Ptr(false),
		// 				},
		// 			},
		// 			{
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2"),
		// 				Name: to.Ptr("peer"),
		// 				Properties: &armnetwork.VirtualNetworkPeeringPropertiesFormat{
		// 					AllowForwardedTraffic: to.Ptr(false),
		// 					AllowGatewayTransit: to.Ptr(false),
		// 					AllowVirtualNetworkAccess: to.Ptr(true),
		// 					PeeringState: to.Ptr(armnetwork.VirtualNetworkPeeringStateInitiated),
		// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 					RemoteAddressSpace: &armnetwork.AddressSpace{
		// 						AddressPrefixes: []*string{
		// 							to.Ptr("13.0.0.0/8")},
		// 						},
		// 						RemoteBgpCommunities: &armnetwork.VirtualNetworkBgpCommunities{
		// 							RegionalCommunity: to.Ptr("12076:50004"),
		// 							VirtualNetworkCommunity: to.Ptr("12076:20003"),
		// 						},
		// 						RemoteVirtualNetwork: &armnetwork.SubResource{
		// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3"),
		// 						},
		// 						RemoteVirtualNetworkEncryption: &armnetwork.VirtualNetworkEncryption{
		// 							Enabled: to.Ptr(true),
		// 							Enforcement: to.Ptr(armnetwork.VirtualNetworkEncryptionEnforcementAllowUnencrypted),
		// 						},
		// 						UseRemoteGateways: to.Ptr(false),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all virtual network peerings in a virtual network.
 *
 * @summary Gets all virtual network peerings in a virtual network.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json
 */
async function listPeeringsWithRemoteVirtualNetworkEncryption() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "peerTest";
  const virtualNetworkName = "vnet1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualNetworkPeerings.list(
    resourceGroupName,
    virtualNetworkName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json
// this example is just showing the usage of "VirtualNetworkPeerings_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualNetworkResource created on azure
// for more information of creating VirtualNetworkResource, please refer to the document of VirtualNetworkResource
string subscriptionId = "subid";
string resourceGroupName = "peerTest";
string virtualNetworkName = "vnet1";
ResourceIdentifier virtualNetworkResourceId = VirtualNetworkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkName);
VirtualNetworkResource virtualNetwork = client.GetVirtualNetworkResource(virtualNetworkResourceId);

// get the collection of this VirtualNetworkPeeringResource
VirtualNetworkPeeringCollection collection = virtualNetwork.GetVirtualNetworkPeerings();

// invoke the operation and iterate over the result
await foreach (VirtualNetworkPeeringResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualNetworkPeeringData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "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"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2",
      "name": "peer",
      "properties": {
        "allowVirtualNetworkAccess": true,
        "allowForwardedTraffic": false,
        "allowGatewayTransit": false,
        "useRemoteGateways": false,
        "remoteVirtualNetwork": {
          "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3"
        },
        "remoteAddressSpace": {
          "addressPrefixes": [
            "13.0.0.0/8"
          ]
        },
        "remoteBgpCommunities": {
          "virtualNetworkCommunity": "12076:20003",
          "regionalCommunity": "12076:50004"
        },
        "remoteVirtualNetworkEncryption": {
          "enabled": true,
          "enforcement": "AllowUnencrypted"
        },
        "peeringState": "Initiated",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definities

Name	Description
AddressSpace	AddressSpace bevat een matrix met IP-adresbereiken die kunnen worden gebruikt door subnetten van het virtuele netwerk.
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
ProvisioningState	De huidige inrichtingsstatus.
SubResource	Verwijzing naar een andere subbron.
VirtualNetworkBgpCommunities	Bgp-community's die via ExpressRoute worden verzonden, waarbij elke route overeenkomt met een voorvoegsel in dit VNET.
VirtualNetworkEncryption	Geeft aan of versleuteling is ingeschakeld in het virtuele netwerk en of vm zonder versleuteling is toegestaan in versleuteld VNet.
VirtualNetworkEncryptionEnforcement	Als het versleutelde VNet vm's toestaat die geen ondersteuning biedt voor versleuteling
VirtualNetworkPeering	Peerings in een virtuele netwerkresource.
VirtualNetworkPeeringLevel	De peeringsynchronisatiestatus van de peering van het virtuele netwerk.
VirtualNetworkPeeringListResult	Antwoord voor serviceoproep listsubnets-API. Hiermee haalt u alle subnetten op die deel uitmaken van een virtueel netwerk.
VirtualNetworkPeeringState	De status van de peering van het virtuele netwerk.

AddressSpace

AddressSpace bevat een matrix met IP-adresbereiken die kunnen worden gebruikt door subnetten van het virtuele netwerk.

Name	Type	Description
addressPrefixes	string[]	Een lijst met adresblokken die zijn gereserveerd voor dit virtuele netwerk in CIDR-notatie.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap fout.

ProvisioningState

De huidige inrichtingsstatus.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Verwijzing naar een andere subbron.

Name	Type	Description
id	string	Resource-id.

VirtualNetworkBgpCommunities

Bgp-community's die via ExpressRoute worden verzonden, waarbij elke route overeenkomt met een voorvoegsel in dit VNET.

Name	Type	Description
regionalCommunity	string	De BGP-community die is gekoppeld aan de regio van het virtuele netwerk.
virtualNetworkCommunity	string	De BGP-community die is gekoppeld aan het virtuele netwerk.

VirtualNetworkEncryption

Geeft aan of versleuteling is ingeschakeld in het virtuele netwerk en of vm zonder versleuteling is toegestaan in versleuteld VNet.

Name	Type	Description
enabled	boolean	Geeft aan of versleuteling is ingeschakeld in het virtuele netwerk.
enforcement	VirtualNetworkEncryptionEnforcement	Als het versleutelde VNet vm's toestaat die geen ondersteuning biedt voor versleuteling

VirtualNetworkEncryptionEnforcement

Als het versleutelde VNet vm's toestaat die geen ondersteuning biedt voor versleuteling

Name	Type	Description
AllowUnencrypted	string
DropUnencrypted	string

VirtualNetworkPeering

Peerings in een virtuele netwerkresource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.allowForwardedTraffic	boolean	Of het doorgestuurde verkeer van de VM's in het lokale virtuele netwerk wordt toegestaan/niet toegestaan in een extern virtueel netwerk.
properties.allowGatewayTransit	boolean	Als gatewaykoppelingen kunnen worden gebruikt in externe virtuele netwerken om te koppelen aan dit virtuele netwerk.
properties.allowVirtualNetworkAccess	boolean	Of de VM's in de lokale virtuele netwerkruimte toegang hebben tot de VM's in de ruimte van het externe virtuele netwerk.
properties.doNotVerifyRemoteGateways	boolean	Als we de inrichtingsstatus van de externe gateway moeten controleren.
properties.peeringState	VirtualNetworkPeeringState	De status van de peering van het virtuele netwerk.
properties.peeringSyncLevel	VirtualNetworkPeeringLevel	De peeringsynchronisatiestatus van de peering van het virtuele netwerk.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de peeringresource van het virtuele netwerk.
properties.remoteAddressSpace	AddressSpace	De verwijzing naar de adresruimte die is gekoppeld aan het externe virtuele netwerk.
properties.remoteBgpCommunities	VirtualNetworkBgpCommunities	De verwijzing naar de Bgp-community's van het externe virtuele netwerk.
properties.remoteVirtualNetwork	SubResource	De verwijzing naar het externe virtuele netwerk. Het externe virtuele netwerk kan zich in dezelfde of een andere regio bevinden (preview). Hier kunt u zich registreren voor de preview en meer informatie (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).
properties.remoteVirtualNetworkAddressSpace	AddressSpace	De verwijzing naar de huidige adresruimte van het externe virtuele netwerk.
properties.remoteVirtualNetworkEncryption	VirtualNetworkEncryption	De verwijzing naar de versleuteling van het externe virtuele netwerk
properties.resourceGuid	string	De eigenschap resourceGuid van de Virtual Network peeringresource.
properties.useRemoteGateways	boolean	Als externe gateways kunnen worden gebruikt in dit virtuele netwerk. Als de vlag is ingesteld op true en allowGatewayTransit op externe peering ook waar is, gebruikt het virtuele netwerk gateways van het externe virtuele netwerk voor overdracht. Deze vlag kan slechts op één peering worden ingesteld op true. Deze vlag kan niet worden ingesteld als het virtuele netwerk al een gateway heeft.
type	string	Resourcetype.

VirtualNetworkPeeringLevel

De peeringsynchronisatiestatus van de peering van het virtuele netwerk.

Name	Type	Description
FullyInSync	string
LocalAndRemoteNotInSync	string
LocalNotInSync	string
RemoteNotInSync	string

VirtualNetworkPeeringListResult

Antwoord voor serviceoproep listsubnets-API. Hiermee haalt u alle subnetten op die deel uitmaken van een virtueel netwerk.

Name	Type	Description
nextLink	string	De URL voor het ophalen van de volgende set resultaten.
value	VirtualNetworkPeering[]	De peerings in een virtueel netwerk.

VirtualNetworkPeeringState

De status van de peering van het virtuele netwerk.

Name	Type	Description
Connected	string
Disconnected	string
Initiated	string