AgentsClient.DeleteAgent(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.3

Source:: AgentsClient.cs

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.

Deletes an agent.

public virtual Azure.Response<bool> DeleteAgent(string agentId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAgent : string * System.Threading.CancellationToken -> Azure.Response<bool>
override this.DeleteAgent : string * System.Threading.CancellationToken -> Azure.Response<bool>

Public Overridable Function DeleteAgent (agentId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Boolean)

Parameters

agentId: String

The ID of the agent to delete.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<Boolean>

Exceptions

ArgumentNullException

agentId is null.

ArgumentException

agentId is an empty string, and was expected to be non-empty.

Applies to

Share via