ConfigurationPolicyGroups 2 - Get

Retrieves the details of a ConfigurationPolicyGroup.

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

URI Parameters

Name In Required Type Description
configurationPolicyGroupName
path True
  • string

The name of the ConfigurationPolicyGroup being retrieved.

resourceGroupName
path True
  • string

The resource group name of the VpnServerConfiguration.

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.

vpnServerConfigurationName
path True
  • string

The name of the VpnServerConfiguration.

api-version
query True
  • string

Client API version.

Responses

Name Type Description
200 OK

Request successful. Returns the details of the ConfigurationPolicyGroup retrieved.

Other Status Codes

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

ConfigurationPolicyGroupGet

Sample Request

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

Sample Response

{
  "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"
      }
    ]
  }
}

Definitions

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ProvisioningState

The current provisioning state.

SubResource

Reference to another subresource.

VpnPolicyMemberAttributeType

The Vpn Policy member attribute type.

VpnServerConfigurationPolicyGroup

VpnServerConfigurationPolicyGroup Resource.

VpnServerConfigurationPolicyGroupMember

VpnServerConfiguration PolicyGroup member

CloudError

An error response from the service.

Name Type Description
error

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

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.

ProvisioningState

The current provisioning state.

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

SubResource

Reference to another subresource.

Name Type Description
id
  • string

Resource ID.

VpnPolicyMemberAttributeType

The Vpn Policy member attribute type.

Name Type Description
AADGroupId
  • string
CertificateGroupId
  • string
RadiusAzureGroupId
  • string

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

List of references to P2SConnectionConfigurations.

properties.policyMembers

Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.

properties.priority
  • integer

Priority for VpnServerConfigurationPolicyGroup.

properties.provisioningState

The provisioning state of the VpnServerConfigurationPolicyGroup resource.

type
  • string

Resource type.

VpnServerConfigurationPolicyGroupMember

VpnServerConfiguration PolicyGroup member

Name Type Description
attributeType

The Vpn Policy member attribute type.

attributeValue
  • string

The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.

name
  • string

Name of the VpnServerConfigurationPolicyGroupMember.