ShareDirectoryClient.ForceCloseHandleAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.17.1

Source:

ShareDirectoryClient.cs

The ForceCloseHandle(String, CancellationToken) operation closes a handle opened on a directory or a file at the service. It supports closing a single handle specified by handleId.

This API is intended to be used alongside GetHandlesAsync(Nullable<Boolean>, CancellationToken) to force close handles that block operations, such as renaming a directory. These handles may have leaked or been lost track of by SMB clients. The API has client-side impact on the handle being closed, including user visible errors due to failed attempts to read or write files. This API is not intended for use as a replacement or alternative for SMB close.

For more information, see Force Close Handles.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.CloseHandlesResult>> ForceCloseHandleAsync (string handleId, System.Threading.CancellationToken cancellationToken = default);

abstract member ForceCloseHandleAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.CloseHandlesResult>>
override this.ForceCloseHandleAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.CloseHandlesResult>>

Public Overridable Function ForceCloseHandleAsync (handleId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CloseHandlesResult))

Parameters

handleId

String

Specifies the handle ID to be closed.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response<CloseHandlesResult>>

A Response<T> describing the status of the ForceCloseHandleAsync(String, CancellationToken) operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.