Share via


AgentToolboxes.GetToolboxVersionsAsync Method

Definition

Overloads

Name Description
GetToolboxVersionsAsync(String, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

List all versions of a toolbox.

GetToolboxVersionsAsync(String, Nullable<Int32>, String, String, String, RequestOptions)

[Protocol Method] List all versions of a toolbox.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetToolboxVersionsAsync(String, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Source:
AgentToolboxes.cs

List all versions of a toolbox.

public virtual System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Agents.ToolboxVersion> GetToolboxVersionsAsync(string toolboxName, int? limit = default, Azure.AI.Projects.Agents.AgentListOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetToolboxVersionsAsync : string * Nullable<int> * Nullable<Azure.AI.Projects.Agents.AgentListOrder> * string * string * System.Threading.CancellationToken -> System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Agents.ToolboxVersion>
override this.GetToolboxVersionsAsync : string * Nullable<int> * Nullable<Azure.AI.Projects.Agents.AgentListOrder> * string * string * System.Threading.CancellationToken -> System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Agents.ToolboxVersion>
Public Overridable Function GetToolboxVersionsAsync (toolboxName As String, Optional limit As Nullable(Of Integer) = Nothing, Optional order As Nullable(Of AgentListOrder) = Nothing, Optional after As String = Nothing, Optional before As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncCollectionResult(Of ToolboxVersion)

Parameters

toolboxName
String

The name of the toolbox to list versions for.

limit
Nullable<Int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order
Nullable<AgentListOrder>

Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order.

after
String

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before
String

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Exceptions

toolboxName is null.

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

Service returned a non-success status code.

Applies to

GetToolboxVersionsAsync(String, Nullable<Int32>, String, String, String, RequestOptions)

Source:
AgentToolboxes.cs

[Protocol Method] List all versions of a toolbox.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.ClientModel.Primitives.AsyncCollectionResult GetToolboxVersionsAsync(string name, int? limit, string order, string after, string before, System.ClientModel.Primitives.RequestOptions options);
abstract member GetToolboxVersionsAsync : string * Nullable<int> * string * string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.Primitives.AsyncCollectionResult
override this.GetToolboxVersionsAsync : string * Nullable<int> * string * string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.Primitives.AsyncCollectionResult
Public Overridable Function GetToolboxVersionsAsync (name As String, limit As Nullable(Of Integer), order As String, after As String, before As String, options As RequestOptions) As AsyncCollectionResult

Parameters

name
String

The name of the toolbox to list versions for.

limit
Nullable<Int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order
String

Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order.

after
String

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before
String

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

options
RequestOptions

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

The response returned from the service.

Exceptions

name is null.

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

Service returned a non-success status code.

Applies to