Language

DashboardHttpClientBase.DeleteDashboardAsync Method

Definition

[Preview API] Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.

public virtual System.Threading.Tasks.Task DeleteDashboardAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext teamContext, Guid dashboardId, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member DeleteDashboardAsync : Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext * Guid * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteDashboardAsync : Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext * Guid * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

teamContext
TeamContext

The team context for the operation

dashboardId
Guid

ID of the dashboard to delete.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to