Start-AzureVirtualNetworkGatewayDiagnostics
Starts diagnostics for a virtual network gateway.
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
Start-AzureVirtualNetworkGatewayDiagnostics
-GatewayId <String>
[-CaptureDurationInSeconds <Int32>]
[-ContainerName <String>]
[-StorageContext <AzureStorageContext>]
[-Profile <AzureSMProfile>]
[<CommonParameters>] Description
The Start-AzureVirtualNetworkGatewayDiagnostics cmdlet starts a new gateway diagnostics session for a virtual network gateway. Only one gateway diagnostics session can run at a time. If you run this cmdlet while a gateway diagnostics session is running, this cmdlet returns an error.
Parameters
-CaptureDurationInSeconds
Specifies the capture duration in seconds.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContainerName
Specifies the name of an Azure container. This cmdlet stores results in the container that this parameter specifies.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GatewayId
Specifies the ID of a gateway.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageContext
Specifies an Azure storage context. This cmdlet stores results by using the storage context that this parameter specifies.
| Type: | AzureStorageContext |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |