Update-AzVpnServerConfigurationPolicyGroup
Update an existing VpnServerConfigurationPolicyGroup under VpnServerConfiguration for point to site connectivity.
Syntax
ByVpnServerConfigurationName (Default)
Update-AzVpnServerConfigurationPolicyGroup
-ResourceGroupName <String>
-ServerConfigurationName <String>
-Name <String>
[-Priority <Int32>]
[-DefaultPolicyGroup <Boolean>]
[-PolicyMember <PSVpnServerConfigurationPolicyGroupMember[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByVpnServerConfigurationObject
Update-AzVpnServerConfigurationPolicyGroup
-ServerConfigurationObject <PSVpnServerConfiguration>
[-Priority <Int32>]
[-DefaultPolicyGroup <Boolean>]
[-PolicyMember <PSVpnServerConfigurationPolicyGroupMember[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByVpnServerConfigurationResourceId
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
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultPolicyGroup
Set this as Default Policy Group on this VpnServerConfiguration.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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: False DontShow: False Aliases: ResourceName, VpnServerConfigurationPolicyGroupName
Parameter sets
ByVpnServerConfigurationName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PolicyMember
The list of Policy members.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Priority
The Priority of the policy group.
Priority should be in consecutive orders.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True 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 VpnServerConfiguration name this PolicyGroup is linked to.
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: True Value from pipeline by property name: False Value from remaining arguments: False
-ServerConfigurationObject
The VpnServerConfiguration object this PolicyGroup is linked to.
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 id of VpnServerConfiguration object this PolicyGroup is linked to.
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
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False 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 .
Outputs
