TeamFoundationBuildService.DeleteBuilds Method
Deletes builds and supporting data. Labels, test results, and test impact data are deleted synchronously.
Build binaries and symbols are queued and deleted as a background job.
Namespace: Microsoft.TeamFoundation.Build.Server
Assembly: Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)
Syntax
'Declaration
Public Function DeleteBuilds ( _
requestContext As TeamFoundationRequestContext, _
uris As IList(Of String), _
options As DeleteOptions, _
throwIfInvalidUri As Boolean _
) As List(Of BuildDeletionResult)
public List<BuildDeletionResult> DeleteBuilds(
TeamFoundationRequestContext requestContext,
IList<string> uris,
DeleteOptions options,
bool throwIfInvalidUri
)
public:
List<BuildDeletionResult^>^ DeleteBuilds(
TeamFoundationRequestContext^ requestContext,
IList<String^>^ uris,
DeleteOptions options,
bool throwIfInvalidUri
)
member DeleteBuilds :
requestContext:TeamFoundationRequestContext *
uris:IList<string> *
options:DeleteOptions *
throwIfInvalidUri:bool -> List<BuildDeletionResult>
public function DeleteBuilds(
requestContext : TeamFoundationRequestContext,
uris : IList<String>,
options : DeleteOptions,
throwIfInvalidUri : boolean
) : List<BuildDeletionResult>
Parameters
requestContext
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContextThe request context.
uris
Type: System.Collections.Generic.IList<String>The URIs of builds to delete.
options
Type: Microsoft.TeamFoundation.Build.Server.DeleteOptionsThe data that should be deleted.
throwIfInvalidUri
Type: System.BooleanTrue to throw an exception for a build that does not exist, false otherwise.
Return Value
Type: System.Collections.Generic.List<BuildDeletionResult>
A list of results indicating success or failure for particular operations during the delete.
.NET Framework Security
[M:F:Microsoft.TeamFoundation.Build.Common.BuildPermissions.DeleteBuilds]
The caller must have DeleteBuilds permission for the target build definitions.
[M:F:Microsoft.TeamFoundation.Build.Common.BuildPermissions.DeleteBuilds]
The caller must have [DeleteBuilds] permission for the target build definitions.
Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.