AgentAdministrationClient.DeleteAgentVersionAsync 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.
Overloads
| Name | Description |
|---|---|
| DeleteAgentVersionAsync(String, String, Nullable<Boolean>, CancellationToken) |
Deletes a specific version of an agent. |
| DeleteAgentVersionAsync(String, String, CancellationToken) |
Deletes a specific version of an agent. |
DeleteAgentVersionAsync(String, String, Nullable<Boolean>, CancellationToken)
- Source:
- AgentAdministrationClient.cs
Deletes a specific version of an agent.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> DeleteAgentVersionAsync(string agentName, string agentVersion, bool? force, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteAgentVersionAsync : string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.DeleteAgentVersionAsync : string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>Public Overridable Function DeleteAgentVersionAsync (agentName As String, agentVersion As String, force As Nullable(Of Boolean), Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult)Parameters
- agentName
- String
The name of the agent to delete.
- agentVersion
- String
The version of the agent to delete.
For Hosted Agents, if true, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. This value is not relevant for other Agent types. Defaults to false.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
agentName or agentVersion is null.
agentName or agentVersion is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
DeleteAgentVersionAsync(String, String, CancellationToken)
- Source:
- AgentAdministrationClient.cs
- Source:
- AgentAdministrationClient.cs
Deletes a specific version of an agent.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> DeleteAgentVersionAsync(string agentName, string agentVersion, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteAgentVersionAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.DeleteAgentVersionAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>Public Overridable Function DeleteAgentVersionAsync (agentName As String, agentVersion As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult)Parameters
- agentName
- String
The name of the agent to delete.
- agentVersion
- String
The version of the agent to delete.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
agentName or agentVersion is null.
agentName or agentVersion is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
