AgentSessionFiles.Delete Method

Definition

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.ClientModel.ClientResult Delete(string localPath, bool? recursive = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Delete : string * Nullable<bool> * System.Threading.CancellationToken -> System.ClientModel.ClientResult
override this.Delete : string * Nullable<bool> * System.Threading.CancellationToken -> System.ClientModel.ClientResult
Public Overridable Function Delete (localPath As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClientResult

Parameters

localPath
String

The file or directory path to delete, relative to the session home directory.

recursive
Nullable<Boolean>

Whether to recursively delete directory contents. Defaults to false.

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.

Applies to