Update-AzVpnServerConfigurationPolicyGroup

Reference

Module:: Az.Network

Update an existing VpnServerConfigurationPolicyGroup under VpnServerConfiguration for point to site connectivity.

Syntax

Update-AzVpnServerConfigurationPolicyGroup
      -ResourceGroupName <String>
      -ServerConfigurationName <String>
      -Name <String>
      [-Priority <Int32>]
      [-DefaultPolicyGroup <Boolean>]
      [-PolicyMember <PSVpnServerConfigurationPolicyGroupMember[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnServerConfigurationPolicyGroup
      -ServerConfigurationObject <PSVpnServerConfiguration>
      [-Priority <Int32>]
      [-DefaultPolicyGroup <Boolean>]
      [-PolicyMember <PSVpnServerConfigurationPolicyGroupMember[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnServerConfigurationPolicyGroup
      -ServerConfigurationResourceId <String>
      [-Priority <Int32>]
      [-DefaultPolicyGroup <Boolean>]
      [-PolicyMember <PSVpnServerConfigurationPolicyGroupMember[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzVpnServerConfigurationPolicyGroup cmdlet enables you to update an existing VpnServerConfigurationPolicyGroup under VpnServerConfiguration with new policyGroupMember and/or Priority.

Examples

Example 1

# Update existing VpnServerConfigurationPolicyGroup with new PolicyGroupMember2 & Priority to 2.
Update-AzVpnServerConfigurationPolicyGroup -ResourceGroupName TestRG -ServerConfigurationName VpnServerConfig2 -Name Group2 -PolicyMember $policyGroupMember2 -Priority 2

ProvisioningState               : Succeeded
IsDefault                       : False
Priority                        : 2
PolicyMembers                   : {policyGroupMember2}
P2SConnectionConfigurations     : {/subscriptions/64c5a05b-0859-4e60-9634-d52db66832bd/resourceGroups/TestRG/providers/Microsoft.Network/p2sVpnGateways/d8c79d4be6fd47a497f8ac8f8eb545ad-eastus-gw/p2sConnectionConfigurations/P2SConConfig2}
PolicyMembersText               : [
                                    {
                                      "Name": "policyGroupMember2",
                                      "AttributeType": "AADGroupId",
                                      "AttributeValue": "41b23e61-6c1e-4545-b367-cd054e0ed4b5"
                                    }
                                  ]
P2SConnectionConfigurationsText : [
                                    {
                                      "Id": "/subscriptions/64c5a05b-0859-4e60-9634-d52db66832bd/resourceGroups/TestRG/providers/Microsoft.Network/p2sVpnGateways/d8c79d4be6fd47a497f8ac8f8eb545ad-eastus-gw/p2sConnectionConfigurations/P2SConConfig2"
                                    }
                                  ]
Name                            : Group2
Etag                            : W/"44998fce-7fde-43f9-bafb-4599452d672c"
Id                              : /subscriptions/64c5a05b-0859-4e60-9634-d52db66832bd/resourceGroups/TestRG/providers/Microsoft.Network/vpnServerConfigurations/VpnServerConfig2/configurationPolicyGroups/Group2

The Update-AzVpnServerConfigurationPolicyGroup cmdlet enables you to update an existing VpnServerConfigurationPolicyGroup under VpnServerConfiguration with new policyGroupMember and/or Priority.

Parameters

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultPolicyGroup

Set this as Default Policy Group on this VpnServerConfiguration.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The resource name.

Type:	String
Aliases:	ResourceName, VpnServerConfigurationPolicyGroupName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PolicyMember

The list of Policy members.

Type:	PSVpnServerConfigurationPolicyGroupMember[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Priority

The Priority of the policy group. Priority should be in consecutive orders.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

The resource group name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ServerConfigurationName

The VpnServerConfiguration name this PolicyGroup is linked to.

Type:	String
Aliases:	ParentVpnServerConfigurationName, VpnServerConfigurationName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ServerConfigurationObject

The VpnServerConfiguration object this PolicyGroup is linked to.

Type:	PSVpnServerConfiguration
Aliases:	ParentVpnServerConfiguration, VpnServerConfiguration
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ServerConfigurationResourceId

The id of VpnServerConfiguration object this PolicyGroup is linked to.

Type:	String
Aliases:	ParentVpnServerConfigurationId, VpnServerConfigurationId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False