你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

configuration Policy Groups - List By Vpn Server Configuration

参考

服务:: Virtual WAN

API 版本:: 2024-05-01

列出 vpnServerConfiguration 资源组中的所有 configurationPolicyGroup。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups?api-version=2024-05-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	VpnServerConfiguration 的资源组名称。
subscriptionId	path	True	string	唯一标识 Azure 订阅Microsoft的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
vpnServerConfigurationName	path	True	string	VpnServerConfiguration 的名称。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	ListVpnServerConfigurationPolicyGroupsResult	请求成功。返回资源组中所有 VpnServerConfiguration 的详细信息。
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ConfigurationPolicyGroupListByVpnServerConfiguration

示例请求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups?api-version=2024-05-01


/**
 * Samples for ConfigurationPolicyGroups ListByVpnServerConfiguration.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * ConfigurationPolicyGroupListByVpnServerConfiguration.json
     */
    /**
     * Sample code: ConfigurationPolicyGroupListByVpnServerConfiguration.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        configurationPolicyGroupListByVpnServerConfiguration(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getConfigurationPolicyGroups().listByVpnServerConfiguration("rg1",
            "vpnServerConfiguration1", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python configuration_policy_group_list_by_vpn_server_configuration.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.configuration_policy_groups.list_by_vpn_server_configuration(
        resource_group_name="rg1",
        vpn_server_configuration_name="vpnServerConfiguration1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.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

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json
func ExampleConfigurationPolicyGroupsClient_NewListByVPNServerConfigurationPager() {
	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.NewConfigurationPolicyGroupsClient().NewListByVPNServerConfigurationPager("rg1", "vpnServerConfiguration1", 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.ListVPNServerConfigurationPolicyGroupsResult = armnetwork.ListVPNServerConfigurationPolicyGroupsResult{
		// 	Value: []*armnetwork.VPNServerConfigurationPolicyGroup{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1"),
		// 			Name: to.Ptr("policyGroup1"),
		// 			Type: to.Ptr("Microsoft.Network/vpnServerConfigurations/configurationPolicyGroups"),
		// 			Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 			Properties: &armnetwork.VPNServerConfigurationPolicyGroupProperties{
		// 				IsDefault: to.Ptr(true),
		// 				P2SConnectionConfigurations: []*armnetwork.SubResource{
		// 					{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1"),
		// 				}},
		// 				PolicyMembers: []*armnetwork.VPNServerConfigurationPolicyGroupMember{
		// 					{
		// 						Name: to.Ptr("policy1"),
		// 						AttributeType: to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeRadiusAzureGroupID),
		// 						AttributeValue: to.Ptr("6ad1bd08"),
		// 					},
		// 					{
		// 						Name: to.Ptr("policy2"),
		// 						AttributeType: to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeCertificateGroupID),
		// 						AttributeValue: to.Ptr("red.com"),
		// 				}},
		// 				Priority: to.Ptr[int32](0),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 			},
		// 		},
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2"),
		// 			Name: to.Ptr("policyGroup2"),
		// 			Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 			Properties: &armnetwork.VPNServerConfigurationPolicyGroupProperties{
		// 				IsDefault: to.Ptr(true),
		// 				PolicyMembers: []*armnetwork.VPNServerConfigurationPolicyGroupMember{
		// 					{
		// 						Name: to.Ptr("policy1"),
		// 						AttributeType: to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeRadiusAzureGroupID),
		// 						AttributeValue: to.Ptr("6ad1bd08"),
		// 					},
		// 					{
		// 						Name: to.Ptr("policy2"),
		// 						AttributeType: to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeCertificateGroupID),
		// 						AttributeValue: to.Ptr("red.com"),
		// 				}},
		// 				Priority: to.Ptr[int32](0),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration.
 *
 * @summary Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json
 */
async function configurationPolicyGroupListByVpnServerConfiguration() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const vpnServerConfigurationName = "vpnServerConfiguration1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.configurationPolicyGroups.listByVpnServerConfiguration(
    resourceGroupName,
    vpnServerConfigurationName,
  )) {
    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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json
// this example is just showing the usage of "configurationPolicyGroups_ListByVpnServerConfiguration" 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 VpnServerConfigurationResource created on azure
// for more information of creating VpnServerConfigurationResource, please refer to the document of VpnServerConfigurationResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string vpnServerConfigurationName = "vpnServerConfiguration1";
ResourceIdentifier vpnServerConfigurationResourceId = VpnServerConfigurationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vpnServerConfigurationName);
VpnServerConfigurationResource vpnServerConfiguration = client.GetVpnServerConfigurationResource(vpnServerConfigurationResourceId);

// get the collection of this VpnServerConfigurationPolicyGroupResource
VpnServerConfigurationPolicyGroupCollection collection = vpnServerConfiguration.GetVpnServerConfigurationPolicyGroups();

// invoke the operation and iterate over the result
await foreach (VpnServerConfigurationPolicyGroupResource 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
    VpnServerConfigurationPolicyGroupData 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

示例响应

状态代码:: 200

{
  "value": [
    {
      "name": "policyGroup1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "type": "Microsoft.Network/vpnServerConfigurations/configurationPolicyGroups",
      "properties": {
        "provisioningState": "Succeeded",
        "isDefault": true,
        "priority": 0,
        "policyMembers": [
          {
            "name": "policy1",
            "attributeType": "RadiusAzureGroupId",
            "attributeValue": "6ad1bd08"
          },
          {
            "name": "policy2",
            "attributeType": "CertificateGroupId",
            "attributeValue": "red.com"
          }
        ],
        "p2SConnectionConfigurations": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1"
          }
        ]
      }
    },
    {
      "name": "policyGroup2",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "properties": {
        "provisioningState": "Succeeded",
        "isDefault": true,
        "priority": 0,
        "policyMembers": [
          {
            "name": "policy1",
            "attributeType": "RadiusAzureGroupId",
            "attributeValue": "6ad1bd08"
          },
          {
            "name": "policy2",
            "attributeType": "CertificateGroupId",
            "attributeValue": "red.com"
          }
        ]
      }
    }
  ]
}

定义

名称	说明
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
ListVpnServerConfigurationPolicyGroupsResult	列出 VpnServerConfigurationPolicyGroups 的请求的结果。它包含 VpnServerConfigurationPolicyGroups 和 URL nextLink 的列表，用于获取下一组结果。
ProvisioningState	当前预配状态。
SubResource	对另一个子资源的引用。
VpnPolicyMemberAttributeType	Vpn Policy 成员属性类型。
VpnServerConfigurationPolicyGroup	VpnServerConfigurationPolicyGroup 资源。
VpnServerConfigurationPolicyGroupMember	VpnServerConfiguration PolicyGroup 成员

CloudError

Object

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

Object

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

ListVpnServerConfigurationPolicyGroupsResult

Object

列出 VpnServerConfigurationPolicyGroups 的请求的结果。它包含 VpnServerConfigurationPolicyGroups 和 URL nextLink 的列表，用于获取下一组结果。

名称	类型	说明
nextLink	string	用于获取下一组操作列表结果（如果有）的 URL。
value	VpnServerConfigurationPolicyGroup[]	VpnServerConfigurationPolicyGroups 的列表。

ProvisioningState

枚举

当前预配状态。

值	说明
Deleting
Failed
Succeeded
Updating

SubResource

Object

对另一个子资源的引用。

名称	类型	说明
id	string	资源 ID。

VpnPolicyMemberAttributeType

枚举

Vpn Policy 成员属性类型。

值	说明
AADGroupId
CertificateGroupId
RadiusAzureGroupId

VpnServerConfigurationPolicyGroup

Object

VpnServerConfigurationPolicyGroup 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.isDefault	boolean	显示这是否为默认 VpnServerConfigurationPolicyGroup。
properties.p2SConnectionConfigurations	SubResource[]	对 P2SConnectionConfigurations 的引用列表。
properties.policyMembers	VpnServerConfigurationPolicyGroupMember[]	VpnServerConfigurationPolicyGroup 的多个 PolicyMembers。
properties.priority	integer (int32)	VpnServerConfigurationPolicyGroup 的优先级。
properties.provisioningState	ProvisioningState	VpnServerConfigurationPolicyGroup 资源的预配状态。
type	string	资源类型。

VpnServerConfigurationPolicyGroupMember

Object

VpnServerConfiguration PolicyGroup 成员

名称	类型	说明
attributeType	VpnPolicyMemberAttributeType	Vpn Policy 成员属性类型。
attributeValue	string	用于此 VpnServerConfigurationPolicyGroupMember 的属性的值。
name	string	VpnServerConfigurationPolicyGroupMember 的名称。