Edit

Share via


Stop-AzureVNetGatewayDiagnostics

Stops a running VPN gateway diagnostics session.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Default (Default)

Stop-AzureVNetGatewayDiagnostics
    -VNetName <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Stop-AzureVNetGatewayDiagnostics cmdlet stops a running virtual private network (VPN) gateway diagnostics session. This command saves the results of the diagnostics session to the storage account that the Start-AzureVNetGatewayDiagnostics cmdlet specifies.

Parameters

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:AzureSMProfile
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

-VNetName

Specifies the virtual network that contains a virtual network gateway for which this cmdlet stops diagnostics.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:True
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.