AgentSessionFiles.DeleteAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Delete a file or directory from the session sandbox.
If recursive is false (default) and the target is a non-empty directory, the API returns 409 Conflict.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> DeleteAsync(string localPath, bool? recursive = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteAsync : string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.DeleteAsync : string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>Public Overridable Function DeleteAsync (localPath As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult)Parameters
- localPath
- String
The file or directory path to delete, relative to the session home directory.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
localPath is null.
localPath is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
