AgentToolboxes.GetToolboxesAsync 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 |
|---|---|
| GetToolboxesAsync(Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken) |
List all toolboxes. |
| GetToolboxesAsync(Nullable<Int32>, String, String, String, RequestOptions) |
[Protocol Method] List all toolboxes.
|
GetToolboxesAsync(Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)
- Source:
- AgentToolboxes.cs
List all toolboxes.
public virtual System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Agents.ToolboxRecord> GetToolboxesAsync(int? limit = default, Azure.AI.Projects.Agents.AgentListOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetToolboxesAsync : Nullable<int> * Nullable<Azure.AI.Projects.Agents.AgentListOrder> * string * string * System.Threading.CancellationToken -> System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Agents.ToolboxRecord>
override this.GetToolboxesAsync : Nullable<int> * Nullable<Azure.AI.Projects.Agents.AgentListOrder> * string * string * System.Threading.CancellationToken -> System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Agents.ToolboxRecord>Public Overridable Function GetToolboxesAsync (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 ToolboxRecord)Parameters
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
Service returned a non-success status code.
Applies to
GetToolboxesAsync(Nullable<Int32>, String, String, String, RequestOptions)
- Source:
- AgentToolboxes.cs
[Protocol Method] List all toolboxes.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.ClientModel.Primitives.AsyncCollectionResult GetToolboxesAsync(int? limit, string order, string after, string before, System.ClientModel.Primitives.RequestOptions options);abstract member GetToolboxesAsync : Nullable<int> * string * string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.Primitives.AsyncCollectionResult
override this.GetToolboxesAsync : Nullable<int> * string * string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.Primitives.AsyncCollectionResultPublic Overridable Function GetToolboxesAsync (limit As Nullable(Of Integer), order As String, after As String, before As String, options As RequestOptions) As AsyncCollectionResultParameters
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
Service returned a non-success status code.
