Edit

Share via


Get-AzVpnServerConfigurationPolicyGroup

Gets VpnServerConfigurationPolicyGroup that can be attached to P2SVpnGateway.

Syntax

ByVpnServerConfigurationName (Default)

Get-AzVpnServerConfigurationPolicyGroup
    -ResourceGroupName <String>
    -ServerConfigurationName <String>
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByVpnServerConfigurationObject

Get-AzVpnServerConfigurationPolicyGroup
    -ServerConfigurationObject <PSVpnServerConfiguration>
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByVpnServerConfigurationResourceId

Get-AzVpnServerConfigurationPolicyGroup
    -ServerConfigurationResourceId <String>
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzVpnServerConfigurationPolicyGroup cmdlet enables you to get an existing VpnServerConfigurationPolicyGroup under VpnServerConfiguration

Examples

Example 1

Get-AzVpnServerConfigurationPolicyGroup -ResourceGroupName TestRG -ServerConfigurationName VpnServerConfig2 -Name Group2 | Format-List
ProvisioningState               : Succeeded
IsDefault                       : False
Priority                        : 1
PolicyMembers                   : {policy2}
P2SConnectionConfigurations     : {/subscriptions/64c5a05b-0859-4e60-9634-d52db66832bd/resourceGroups/TestRG/providers/Microsoft.Network/p2sVpnGateways/d8c79d4be6fd47a497f8ac8f8eb545ad-eastus-gw/p2sConnectionConfigurations/P2SConConfig2}
PolicyMembersText               : [
                                    {
                                      "Name": "policy2",
                                      "AttributeType": "CertificateGroupId",
                                      "AttributeValue": "cd"
                                    }
                                  ]
P2SConnectionConfigurationsText : [
                                    {
                                      "Id": "/subscriptions/64c5a05b-0859-4e60-9634-d52db66832bd/resourceGroups/TestRG/providers/Microsoft.Network/p2sVpnGateways/d8c79d4be6fd47a497f8ac8f8eb545ad-eastus-gw/p2sConnectionConfigurations/P2SConConfig2"
                                    }
                                  ]
Name                            : Group2
Etag                            : W/"d3d91ed6-11a9-471f-880e-6459e78aeef9"
Id                              : /subscriptions/64c5a05b-0859-4e60-9634-d52db66832bd/resourceGroups/TestRG/providers/Microsoft.Network/vpnServerConfigurations/VpnServerConfig2/configurationPolicyGroups/Group2

The Get-AzVpnServerConfigurationPolicyGroup cmdlet enables you to get an existing VpnServerConfigurationPolicyGroup under VpnServerConfiguration which can be attached to P2SVpnGateway for Point to site connectivity from Point to site clients to Azure VirtualWan.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The resource name.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False
Aliases:ResourceName, VpnServerConfigurationPolicyGroupName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByVpnServerConfigurationName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerConfigurationName

The parent resource name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ParentVpnServerConfigurationName, VpnServerConfigurationName

Parameter sets

ByVpnServerConfigurationName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerConfigurationObject

The parent VpnServerConfiguration for this VpnServerConfigurationPolicyGroup.

Parameter properties

Type:PSVpnServerConfiguration
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ParentVpnServerConfiguration, VpnServerConfiguration

Parameter sets

ByVpnServerConfigurationObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerConfigurationResourceId

The resource id of the parent VpnServerConfiguration for this VpnServerConfigurationPolicyGroup.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ParentVpnServerConfigurationId, VpnServerConfigurationId

Parameter sets

ByVpnServerConfigurationResourceId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSVpnServerConfiguration

String

Outputs

PSVpnServerConfigurationPolicyGroup