Vpn Server Configurations - List

Reference

Service:: Virtual WAN

API Version:: 2023-09-01

Lists all the VpnServerConfigurations in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ListVpnServerConfigurationsResult	Request successful. Returns the details of all the VpnServerConfigurations in the subscription.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

VpnServerConfigurationList

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/vpnServerConfigurations?api-version=2023-09-01


/**
 * Samples for VpnServerConfigurations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnServerConfigurationList.
     * json
     */
    /**
     * Sample code: VpnServerConfigurationList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnServerConfigurationList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnServerConfigurations().list(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 vpn_server_configuration_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.vpn_server_configurations.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnServerConfigurationList.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/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/VpnServerConfigurationList.json
func ExampleVPNServerConfigurationsClient_NewListPager() {
	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.NewVPNServerConfigurationsClient().NewListPager(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.ListVPNServerConfigurationsResult = armnetwork.ListVPNServerConfigurationsResult{
		// 	Value: []*armnetwork.VPNServerConfiguration{
		// 		{
		// 			Name: to.Ptr("vpnServerConfiguration1"),
		// 			Type: to.Ptr("Microsoft.Network/vpnServerConfigurations"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1"),
		// 			Location: to.Ptr("West US"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 			},
		// 			Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 			Properties: &armnetwork.VPNServerConfigurationProperties{
		// 				ConfigurationPolicyGroups: []*armnetwork.VPNServerConfigurationPolicyGroup{
		// 					{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1"),
		// 						Name: to.Ptr("policyGroup1"),
		// 						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"),
		// 							}},
		// 							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("policy2"),
		// 									AttributeType: to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeCertificateGroupID),
		// 									AttributeValue: to.Ptr("red.com"),
		// 							}},
		// 							Priority: to.Ptr[int32](0),
		// 							ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 						},
		// 				}},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RadiusClientRootCertificates: []*armnetwork.VPNServerConfigRadiusClientRootCertificate{
		// 					{
		// 						Name: to.Ptr("vpnServerConfigRadiusClientRootCert1"),
		// 						Thumbprint: to.Ptr("83FFBFC8848B5A5836C94D0112367E16148A286F"),
		// 				}},
		// 				RadiusServerAddress: to.Ptr("8.9.9.9"),
		// 				RadiusServerRootCertificates: []*armnetwork.VPNServerConfigRadiusServerRootCertificate{
		// 					{
		// 						Name: to.Ptr("vpnServerConfigRadiusServerRootCer1"),
		// 						PublicCertData: to.Ptr("MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"),
		// 				}},
		// 				RadiusServerSecret: to.Ptr("<password>"),
		// 				VPNAuthenticationTypes: []*armnetwork.VPNAuthenticationType{
		// 					to.Ptr(armnetwork.VPNAuthenticationTypeCertificate)},
		// 					VPNClientIPSecPolicies: []*armnetwork.IPSecPolicy{
		// 						{
		// 							DhGroup: to.Ptr(armnetwork.DhGroupDHGroup14),
		// 							IkeEncryption: to.Ptr(armnetwork.IkeEncryptionAES256),
		// 							IkeIntegrity: to.Ptr(armnetwork.IkeIntegritySHA384),
		// 							IPSecEncryption: to.Ptr(armnetwork.IPSecEncryptionAES256),
		// 							IPSecIntegrity: to.Ptr(armnetwork.IPSecIntegritySHA256),
		// 							PfsGroup: to.Ptr(armnetwork.PfsGroupPFS14),
		// 							SaDataSizeKilobytes: to.Ptr[int32](429497),
		// 							SaLifeTimeSeconds: to.Ptr[int32](86472),
		// 					}},
		// 					VPNClientRevokedCertificates: []*armnetwork.VPNServerConfigVPNClientRevokedCertificate{
		// 						{
		// 							Name: to.Ptr("vpnServerConfigVpnClientRevokedCert1"),
		// 							Thumbprint: to.Ptr("83FFBFC8848B5A5836C94D0112367E16148A286F"),
		// 					}},
		// 					VPNClientRootCertificates: []*armnetwork.VPNServerConfigVPNClientRootCertificate{
		// 						{
		// 							Name: to.Ptr("vpnServerConfigVpnClientRootCert1"),
		// 							PublicCertData: to.Ptr("MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"),
		// 					}},
		// 					VPNProtocols: []*armnetwork.VPNGatewayTunnelingProtocol{
		// 						to.Ptr(armnetwork.VPNGatewayTunnelingProtocolIkeV2)},
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("vpnServerConfiguration2"),
		// 					Type: to.Ptr("Microsoft.Network/vpnServerConfigurations"),
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration2"),
		// 					Location: to.Ptr("East US"),
		// 					Tags: map[string]*string{
		// 						"key1": to.Ptr("value1"),
		// 					},
		// 					Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 					Properties: &armnetwork.VPNServerConfigurationProperties{
		// 						ConfigurationPolicyGroups: []*armnetwork.VPNServerConfigurationPolicyGroup{
		// 							{
		// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1"),
		// 								Name: to.Ptr("policyGroup1"),
		// 								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"),
		// 									}},
		// 									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("policy2"),
		// 											AttributeType: to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeCertificateGroupID),
		// 											AttributeValue: to.Ptr("red.com"),
		// 									}},
		// 									Priority: to.Ptr[int32](0),
		// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 								},
		// 						}},
		// 						ProvisioningState: to.Ptr("Succeeded"),
		// 						RadiusClientRootCertificates: []*armnetwork.VPNServerConfigRadiusClientRootCertificate{
		// 							{
		// 								Name: to.Ptr("vpnServerConfigRadiusClientRootCert1"),
		// 								Thumbprint: to.Ptr("83FFBFC8848B5A5836C94D0112367E16148A286F"),
		// 						}},
		// 						RadiusServerRootCertificates: []*armnetwork.VPNServerConfigRadiusServerRootCertificate{
		// 							{
		// 								Name: to.Ptr("vpnServerConfigRadiusServerRootCer1"),
		// 								PublicCertData: to.Ptr("MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"),
		// 						}},
		// 						RadiusServers: []*armnetwork.RadiusServer{
		// 							{
		// 								RadiusServerAddress: to.Ptr("10.0.0.0"),
		// 								RadiusServerScore: to.Ptr[int64](25),
		// 						}},
		// 						VPNAuthenticationTypes: []*armnetwork.VPNAuthenticationType{
		// 							to.Ptr(armnetwork.VPNAuthenticationTypeCertificate)},
		// 							VPNClientIPSecPolicies: []*armnetwork.IPSecPolicy{
		// 								{
		// 									DhGroup: to.Ptr(armnetwork.DhGroupDHGroup14),
		// 									IkeEncryption: to.Ptr(armnetwork.IkeEncryptionAES256),
		// 									IkeIntegrity: to.Ptr(armnetwork.IkeIntegritySHA384),
		// 									IPSecEncryption: to.Ptr(armnetwork.IPSecEncryptionAES256),
		// 									IPSecIntegrity: to.Ptr(armnetwork.IPSecIntegritySHA256),
		// 									PfsGroup: to.Ptr(armnetwork.PfsGroupPFS14),
		// 									SaDataSizeKilobytes: to.Ptr[int32](429497),
		// 									SaLifeTimeSeconds: to.Ptr[int32](86472),
		// 							}},
		// 							VPNClientRevokedCertificates: []*armnetwork.VPNServerConfigVPNClientRevokedCertificate{
		// 								{
		// 									Name: to.Ptr("vpnServerConfigVpnClientRevokedCert1"),
		// 									Thumbprint: to.Ptr("83FFBFC8848B5A5836C94D0112367E16148A286F"),
		// 							}},
		// 							VPNClientRootCertificates: []*armnetwork.VPNServerConfigVPNClientRootCertificate{
		// 								{
		// 									Name: to.Ptr("vpnServerConfigVpnClientRootCert1"),
		// 									PublicCertData: to.Ptr("MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"),
		// 							}},
		// 							VPNProtocols: []*armnetwork.VPNGatewayTunnelingProtocol{
		// 								to.Ptr(armnetwork.VPNGatewayTunnelingProtocolIkeV2)},
		// 							},
		// 					}},
		// 				}
	}
}

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 VpnServerConfigurations in a subscription.
 *
 * @summary Lists all the VpnServerConfigurations in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnServerConfigurationList.json
 */
async function vpnServerConfigurationList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.vpnServerConfigurations.list()) {
    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 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;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnServerConfigurationList.json
// this example is just showing the usage of "VpnServerConfigurations_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (VpnServerConfigurationResource item in subscriptionResource.GetVpnServerConfigurationsAsync())
{
    // 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
    VpnServerConfigurationData 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/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "vpnServerConfiguration1",
      "type": "Microsoft.Network/vpnServerConfigurations",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "vpnProtocols": [
          "IkeV2"
        ],
        "vpnAuthenticationTypes": [
          "Certificate"
        ],
        "vpnClientIpsecPolicies": [
          {
            "saLifeTimeSeconds": 86472,
            "saDataSizeKilobytes": 429497,
            "ipsecEncryption": "AES256",
            "ipsecIntegrity": "SHA256",
            "ikeEncryption": "AES256",
            "ikeIntegrity": "SHA384",
            "dhGroup": "DHGroup14",
            "pfsGroup": "PFS14"
          }
        ],
        "configurationPolicyGroups": [
          {
            "name": "policyGroup1",
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "properties": {
              "provisioningState": "Succeeded",
              "isDefault": true,
              "priority": 0,
              "policyMembers": [
                {
                  "name": "policy1",
                  "attributeType": "RadiusAzureGroupId",
                  "attributeValue": "6ad1bd08"
                }
              ],
              "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": "policy2",
                  "attributeType": "CertificateGroupId",
                  "attributeValue": "red.com"
                }
              ]
            }
          }
        ],
        "vpnClientRootCertificates": [
          {
            "name": "vpnServerConfigVpnClientRootCert1",
            "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"
          }
        ],
        "vpnClientRevokedCertificates": [
          {
            "name": "vpnServerConfigVpnClientRevokedCert1",
            "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
          }
        ],
        "radiusServerAddress": "8.9.9.9",
        "radiusServerSecret": "<password>",
        "radiusServerRootCertificates": [
          {
            "name": "vpnServerConfigRadiusServerRootCer1",
            "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"
          }
        ],
        "radiusClientRootCertificates": [
          {
            "name": "vpnServerConfigRadiusClientRootCert1",
            "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "East US",
      "name": "vpnServerConfiguration2",
      "type": "Microsoft.Network/vpnServerConfigurations",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "vpnProtocols": [
          "IkeV2"
        ],
        "vpnAuthenticationTypes": [
          "Certificate"
        ],
        "vpnClientIpsecPolicies": [
          {
            "saLifeTimeSeconds": 86472,
            "saDataSizeKilobytes": 429497,
            "ipsecEncryption": "AES256",
            "ipsecIntegrity": "SHA256",
            "ikeEncryption": "AES256",
            "ikeIntegrity": "SHA384",
            "dhGroup": "DHGroup14",
            "pfsGroup": "PFS14"
          }
        ],
        "configurationPolicyGroups": [
          {
            "name": "policyGroup1",
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "properties": {
              "provisioningState": "Succeeded",
              "isDefault": true,
              "priority": 0,
              "policyMembers": [
                {
                  "name": "policy1",
                  "attributeType": "RadiusAzureGroupId",
                  "attributeValue": "6ad1bd08"
                }
              ],
              "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": "policy2",
                  "attributeType": "CertificateGroupId",
                  "attributeValue": "red.com"
                }
              ]
            }
          }
        ],
        "vpnClientRootCertificates": [
          {
            "name": "vpnServerConfigVpnClientRootCert1",
            "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"
          }
        ],
        "vpnClientRevokedCertificates": [
          {
            "name": "vpnServerConfigVpnClientRevokedCert1",
            "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
          }
        ],
        "radiusServers": [
          {
            "radiusServerAddress": "10.0.0.0",
            "radiusServerScore": 25
          }
        ],
        "radiusServerRootCertificates": [
          {
            "name": "vpnServerConfigRadiusServerRootCer1",
            "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"
          }
        ],
        "radiusClientRootCertificates": [
          {
            "name": "vpnServerConfigRadiusClientRootCert1",
            "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
AadAuthenticationParameters	AAD Vpn authentication type related parameters.
AddressSpace	AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
DhGroup	The DH Groups used in IKE Phase 1 for initial SA.
IkeEncryption	The IKE encryption algorithm (IKE phase 2).
IkeIntegrity	The IKE integrity algorithm (IKE phase 2).
IpsecEncryption	The IPSec encryption algorithm (IKE phase 1).
IpsecIntegrity	The IPSec integrity algorithm (IKE phase 1).
IpsecPolicy	An IPSec Policy configuration for a virtual network gateway connection.
ListVpnServerConfigurationsResult	Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results.
P2SConnectionConfiguration	P2SConnectionConfiguration Resource.
P2SVpnGateway	P2SVpnGateway Resource.
PfsGroup	The Pfs Groups used in IKE Phase 2 for new child SA.
PropagatedRouteTable	The list of RouteTables to advertise the routes to.
ProvisioningState	The current provisioning state.
RadiusServer	Radius Server Settings.
RoutingConfiguration	Routing Configuration indicating the associated and propagated route tables for this connection.
StaticRoute	List of all Static Routes.
StaticRoutesConfig	Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.
SubResource	Reference to another subresource.
VnetLocalRouteOverrideCriteria	Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.
VnetRoute	List of routes that control routing from VirtualHub into a virtual network connection.
VpnAuthenticationType	VPN authentication types for the VpnServerConfiguration.
VpnClientConnectionHealth	VpnClientConnectionHealth properties.
VpnGatewayTunnelingProtocol	VPN protocols for the VpnServerConfiguration.
VpnPolicyMemberAttributeType	The Vpn Policy member attribute type.
VpnServerConfigRadiusClientRootCertificate	Properties of the Radius client root certificate of VpnServerConfiguration.
VpnServerConfigRadiusServerRootCertificate	Properties of Radius Server root certificate of VpnServerConfiguration.
VpnServerConfiguration	VpnServerConfiguration Resource.
VpnServerConfigurationPolicyGroup	VpnServerConfigurationPolicyGroup Resource.
VpnServerConfigurationPolicyGroupMember	VpnServerConfiguration PolicyGroup member
VpnServerConfigVpnClientRevokedCertificate	Properties of the revoked VPN client certificate of VpnServerConfiguration.
VpnServerConfigVpnClientRootCertificate	Properties of VPN client root certificate of VpnServerConfiguration.

AadAuthenticationParameters

AAD Vpn authentication type related parameters.

Name	Type	Description
aadAudience	string	AAD Vpn authentication parameter AAD audience.
aadIssuer	string	AAD Vpn authentication parameter AAD issuer.
aadTenant	string	AAD Vpn authentication parameter AAD tenant.

AddressSpace

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Name	Type	Description
addressPrefixes	string[]	A list of address blocks reserved for this virtual network in CIDR notation.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

DhGroup

The DH Groups used in IKE Phase 1 for initial SA.

Name	Type	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

IkeEncryption

The IKE encryption algorithm (IKE phase 2).

Name	Type	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

The IKE integrity algorithm (IKE phase 2).

Name	Type	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

The IPSec encryption algorithm (IKE phase 1).

Name	Type	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1).

Name	Type	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

An IPSec Policy configuration for a virtual network gateway connection.

Name	Type	Description
dhGroup	DhGroup	The DH Group used in IKE Phase 1 for initial SA.
ikeEncryption	IkeEncryption	The IKE encryption algorithm (IKE phase 2).
ikeIntegrity	IkeIntegrity	The IKE integrity algorithm (IKE phase 2).
ipsecEncryption	IpsecEncryption	The IPSec encryption algorithm (IKE phase 1).
ipsecIntegrity	IpsecIntegrity	The IPSec integrity algorithm (IKE phase 1).
pfsGroup	PfsGroup	The Pfs Group used in IKE Phase 2 for new child SA.
saDataSizeKilobytes	integer	The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
saLifeTimeSeconds	integer	The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

ListVpnServerConfigurationsResult

Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results.

Name	Type	Description
nextLink	string	URL to get the next set of operation list results if there are any.
value	VpnServerConfiguration[]	List of VpnServerConfigurations.

P2SConnectionConfiguration

P2SConnectionConfiguration Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.configurationPolicyGroupAssociations	SubResource[]	List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
properties.enableInternetSecurity	boolean	Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
properties.previousConfigurationPolicyGroupAssociations	VpnServerConfigurationPolicyGroup[]	List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
properties.provisioningState	ProvisioningState	The provisioning state of the P2SConnectionConfiguration resource.
properties.routingConfiguration	RoutingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.
properties.vpnClientAddressPool	AddressSpace	The reference to the address space resource which represents Address space for P2S VpnClient.

P2SVpnGateway

P2SVpnGateway Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.customDnsServers	string[]	List of all customer specified DNS servers IP addresses.
properties.isRoutingPreferenceInternet	boolean	Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
properties.p2SConnectionConfigurations	P2SConnectionConfiguration[]	List of all p2s connection configurations of the gateway.
properties.provisioningState	ProvisioningState	The provisioning state of the P2S VPN gateway resource.
properties.virtualHub	SubResource	The VirtualHub to which the gateway belongs.
properties.vpnClientConnectionHealth	VpnClientConnectionHealth	All P2S VPN clients' connection health status.
properties.vpnGatewayScaleUnit	integer	The scale unit for this p2s vpn gateway.
properties.vpnServerConfiguration	SubResource	The VpnServerConfiguration to which the p2sVpnGateway is attached to.
tags	object	Resource tags.
type	string	Resource type.

PfsGroup

The Pfs Groups used in IKE Phase 2 for new child SA.

Name	Type	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

The list of RouteTables to advertise the routes to.

Name	Type	Description
ids	SubResource[]	The list of resource ids of all the RouteTables.
labels	string[]	The list of labels.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RadiusServer

Radius Server Settings.

Name	Type	Description
radiusServerAddress	string	The address of this radius server.
radiusServerScore	integer	The initial score assigned to this radius server.
radiusServerSecret	string	The secret used for this radius server.

RoutingConfiguration

Routing Configuration indicating the associated and propagated route tables for this connection.

Name	Type	Description
associatedRouteTable	SubResource	The resource id RouteTable associated with this RoutingConfiguration.
inboundRouteMap	SubResource	The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outboundRouteMap	SubResource	The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagatedRouteTables	PropagatedRouteTable	The list of RouteTables to advertise the routes to.
vnetRoutes	VnetRoute	List of routes that control routing from VirtualHub into a virtual network connection.

StaticRoute

List of all Static Routes.

Name	Type	Description
addressPrefixes	string[]	List of all address prefixes.
name	string	The name of the StaticRoute that is unique within a VnetRoute.
nextHopIpAddress	string	The ip address of the next hop.

StaticRoutesConfig

Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.

Name	Type	Description
propagateStaticRoutes	boolean	Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

VnetLocalRouteOverrideCriteria

Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.

Name	Type	Description
Contains	string
Equal	string

VnetRoute

List of routes that control routing from VirtualHub into a virtual network connection.

Name	Type	Description
bgpConnections	SubResource[]	The list of references to HubBgpConnection objects.
staticRoutes	StaticRoute[]	List of all Static Routes.
staticRoutesConfig	StaticRoutesConfig	Configuration for static routes on this HubVnetConnection.

VpnAuthenticationType

VPN authentication types for the VpnServerConfiguration.

Name	Type	Description
AAD	string
Certificate	string
Radius	string

VpnClientConnectionHealth

VpnClientConnectionHealth properties.

Name	Type	Description
allocatedIpAddresses	string[]	List of allocated ip addresses to the connected p2s vpn clients.
totalEgressBytesTransferred	integer	Total of the Egress Bytes Transferred in this connection.
totalIngressBytesTransferred	integer	Total of the Ingress Bytes Transferred in this P2S Vpn connection.
vpnClientConnectionsCount	integer	The total of p2s vpn clients connected at this time to this P2SVpnGateway.

VpnGatewayTunnelingProtocol

VPN protocols for the VpnServerConfiguration.

Name	Type	Description
IkeV2	string
OpenVPN	string

VpnPolicyMemberAttributeType

The Vpn Policy member attribute type.

Name	Type	Description
AADGroupId	string
CertificateGroupId	string
RadiusAzureGroupId	string

VpnServerConfigRadiusClientRootCertificate

Properties of the Radius client root certificate of VpnServerConfiguration.

Name	Type	Description
name	string	The certificate name.
thumbprint	string	The Radius client root certificate thumbprint.

VpnServerConfigRadiusServerRootCertificate

Properties of Radius Server root certificate of VpnServerConfiguration.

Name	Type	Description
name	string	The certificate name.
publicCertData	string	The certificate public data.

VpnServerConfiguration

VpnServerConfiguration Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.aadAuthenticationParameters	AadAuthenticationParameters	The set of aad vpn authentication parameters.
properties.configurationPolicyGroups	VpnServerConfigurationPolicyGroup[]	List of all VpnServerConfigurationPolicyGroups.
properties.etag	string	A unique read-only string that changes whenever the resource is updated.
properties.name	string	The name of the VpnServerConfiguration that is unique within a resource group.
properties.p2SVpnGateways	P2SVpnGateway[]	List of references to P2SVpnGateways.
properties.provisioningState	string	The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
properties.radiusClientRootCertificates	VpnServerConfigRadiusClientRootCertificate[]	Radius client root certificate of VpnServerConfiguration.
properties.radiusServerAddress	string	The radius server address property of the VpnServerConfiguration resource for point to site client connection.
properties.radiusServerRootCertificates	VpnServerConfigRadiusServerRootCertificate[]	Radius Server root certificate of VpnServerConfiguration.
properties.radiusServerSecret	string	The radius secret property of the VpnServerConfiguration resource for point to site client connection.
properties.radiusServers	RadiusServer[]	Multiple Radius Server configuration for VpnServerConfiguration.
properties.vpnAuthenticationTypes	VpnAuthenticationType[]	VPN authentication types for the VpnServerConfiguration.
properties.vpnClientIpsecPolicies	IpsecPolicy[]	VpnClientIpsecPolicies for VpnServerConfiguration.
properties.vpnClientRevokedCertificates	VpnServerConfigVpnClientRevokedCertificate[]	VPN client revoked certificate of VpnServerConfiguration.
properties.vpnClientRootCertificates	VpnServerConfigVpnClientRootCertificate[]	VPN client root certificate of VpnServerConfiguration.
properties.vpnProtocols	VpnGatewayTunnelingProtocol[]	VPN protocols for the VpnServerConfiguration.
tags	object	Resource tags.
type	string	Resource type.

VpnServerConfigurationPolicyGroup

VpnServerConfigurationPolicyGroup Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.isDefault	boolean	Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
properties.p2SConnectionConfigurations	SubResource[]	List of references to P2SConnectionConfigurations.
properties.policyMembers	VpnServerConfigurationPolicyGroupMember[]	Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
properties.priority	integer	Priority for VpnServerConfigurationPolicyGroup.
properties.provisioningState	ProvisioningState	The provisioning state of the VpnServerConfigurationPolicyGroup resource.
type	string	Resource type.

VpnServerConfigurationPolicyGroupMember

VpnServerConfiguration PolicyGroup member

Name	Type	Description
attributeType	VpnPolicyMemberAttributeType	The Vpn Policy member attribute type.
attributeValue	string	The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
name	string	Name of the VpnServerConfigurationPolicyGroupMember.

VpnServerConfigVpnClientRevokedCertificate

Properties of the revoked VPN client certificate of VpnServerConfiguration.

Name	Type	Description
name	string	The certificate name.
thumbprint	string	The revoked VPN client certificate thumbprint.

VpnServerConfigVpnClientRootCertificate

Properties of VPN client root certificate of VpnServerConfiguration.

Name	Type	Description
name	string	The certificate name.
publicCertData	string	The certificate public data.