IGatewayOperations.StartDiagnosticsAsync Method

The Start Diagnostics operation starts a diagnostics session for the specified virtual network gateway in Azure. (see https://msdn.microsoft.com/en-us/library/windowsazure/jj154119.aspx for more information)

Namespace: Microsoft.WindowsAzure.Management.Network
Assembly: Microsoft.WindowsAzure.Management.Network (in Microsoft.WindowsAzure.Management.Network.dll)

Usage

'Usage
Dim instance As IGatewayOperations
Dim networkName As String
Dim parameters As StartGatewayPublicDiagnosticsParameters
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of GatewayGetOperationStatusResponse)

returnValue = instance.StartDiagnosticsAsync(networkName, parameters, cancellationToken)

Syntax

'Declaration
Function StartDiagnosticsAsync ( _
    networkName As String, _
    parameters As StartGatewayPublicDiagnosticsParameters, _
    cancellationToken As CancellationToken _
) As Task(Of GatewayGetOperationStatusResponse)

Task<GatewayGetOperationStatusResponse> StartDiagnosticsAsync (
    string networkName,
    StartGatewayPublicDiagnosticsParameters parameters,
    CancellationToken cancellationToken
)

Task<GatewayGetOperationStatusResponse^>^ StartDiagnosticsAsync (
    String^ networkName, 
    StartGatewayPublicDiagnosticsParameters^ parameters, 
    CancellationToken cancellationToken
)

Task<GatewayGetOperationStatusResponse> StartDiagnosticsAsync (
    String networkName, 
    StartGatewayPublicDiagnosticsParameters parameters, 
    CancellationToken cancellationToken
)

function StartDiagnosticsAsync (
    networkName : String, 
    parameters : StartGatewayPublicDiagnosticsParameters, 
    cancellationToken : CancellationToken
) : Task<GatewayGetOperationStatusResponse>

Parameters

• networkName
  The name of the virtual network for this gateway.

• parameters
  Parameters supplied to the Start Diagnostics operation.

• cancellationToken
  Cancellation token.

Return Value

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request, and also includes error information regarding the failure.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms

See Also

Reference

IGatewayOperations Interface
IGatewayOperations Members
Microsoft.WindowsAzure.Management.Network Namespace