RoleInstanceDiagnosticManager.CancelOnDemandTransfers Method (DataBufferName)

 

Cancel all on-demand transfers that are currently in progress, returning the request ID for each transfer.

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

Syntax

public IEnumerable<Guid> CancelOnDemandTransfers(
    DataBufferName dataBufferName
)

public:
IEnumerable<Guid>^ CancelOnDemandTransfers(
    DataBufferName dataBufferName
)

member CancelOnDemandTransfers : 
        dataBufferName:DataBufferName -> IEnumerable<Guid>

Public Function CancelOnDemandTransfers (
    dataBufferName As DataBufferName
) As IEnumerable(Of Guid)

Parameters

• dataBufferName
  Type: Microsoft.WindowsAzure.Diagnostics.DataBufferName

  Type: Microsoft.WindowsAzure.Diagnostics.DataBufferName

  Name of the data buffer.

Return Value

Type: System.Collections.Generic.IEnumerable<Guid>

Type: System.Collections.Generic.IEnumerable

A list of request IDs for the on-demand transfers that are in progress.

Remarks

The CancelOnDemandTransfers method cancels all enqueued on-demand transfers for the specified DataBufferName. Currently there can be only one active transfer per data buffer.

For example, the following code snippet cancels all on-demand transfers for performance counter data.

// Cancel all on-demand transfers for performance counters.
roleInstanceDiagnosticManager.CancelOnDemandTransfers(DataBufferName.PerformanceCounters);

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