Edit

Share via


Remove-AzVpnServerConfigurationPolicyGroup

Removes an existing VpnServerConfigurationPolicyGroup.

Syntax

ByVpnServerConfigurationName (Default)

Remove-AzVpnServerConfigurationPolicyGroup
    -ResourceGroupName <String>
    -ServerConfigurationName <String>
    -Name <String>
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVpnServerConfigurationResourceId

Remove-AzVpnServerConfigurationPolicyGroup
    -ServerConfigurationResourceId <String>
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVpnServerConfigurationObject

Remove-AzVpnServerConfigurationPolicyGroup
    -ServerConfigurationObject <PSVpnServerConfiguration>
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-AzVpnServerConfigurationPolicyGroup cmdlet enables you to remove an existing VpnServerConfigurationPolicyGroup under VpnServerConfiguration.

Examples

Example 1

Remove-AzVpnServerConfigurationPolicyGroup -ResourceGroupName TestRG -ServerConfigurationName VpnServerConfig2 -Name Group3 -Force -PassThru
True

The Remove-AzVpnServerConfigurationPolicyGroup cmdlet enables you to remove an existing VpnServerConfigurationPolicyGroup under VpnServerConfiguration.

Parameters

-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

-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

-Force

Do not ask for confirmation if you want to delete a resource

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

-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

-PassThru

Returns an object representing the item on which this operation is being performed.

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

-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.

Inputs

String

PSVpnServerConfiguration

Outputs

Boolean