RoleInstanceDiagnosticManager.EndOnDemandTransfer Method (Guid)

 

Stops an on-demand transfer based on its request ID.

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

Syntax

public bool EndOnDemandTransfer(
    Guid requestId
)

public:
bool EndOnDemandTransfer(
    Guid requestId
)

member EndOnDemandTransfer : 
        requestId:Guid -> bool

Public Function EndOnDemandTransfer (
    requestId As Guid
) As Boolean

Parameters

• requestId
  Type: System.Guid

  Type: System.Guid

  The request ID.

Return Value

Type: System.Boolean

Type: System.Boolean

A boolean indicating whether the on-demand transfer was stopped. This method may return false if the there is no active transfer with the given request ID.

Remarks

The EndOnDemandTransfer method stops an in-progress transfer of diagnostic data. The input parameter, requestId, is the request ID that is returned when you call BeginOnDemandTransfer.

Example

The following code snippet stops an on-demand transfer for the role instance.

// Stop on-demand transfers for the role.
roleInstanceDiagnosticManager.EndOnDemandTransfer(requestID);

Warning

This API is not supported in Azure SDK versions 2.5 and higher. Instead, use the diagnostics.wadcfg XML configuration file. For more information, see Collect Logging Data by Using Azure Diagnostics.

See Also

RoleInstanceDiagnosticManager Class
Microsoft.WindowsAzure.Diagnostics.Management Namespace

Return to top