AgentToolboxes.Get Method

Definition

Overloads

Name Description
Get(String, RequestOptions)

[Protocol Method] Retrieves the specified toolbox and its current configuration.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Get(String, CancellationToken)

Retrieves the specified toolbox and its current configuration.

Get(String, RequestOptions)

Source:
AgentToolboxes.cs

[Protocol Method] Retrieves the specified toolbox and its current configuration.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.ClientModel.ClientResult Get(string name, System.ClientModel.Primitives.RequestOptions options);
abstract member Get : string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
override this.Get : string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
Public Overridable Function Get (name As String, options As RequestOptions) As ClientResult

Parameters

name
String

The name of the toolbox to retrieve.

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

Get(String, CancellationToken)

Source:
AgentToolboxes.cs

Retrieves the specified toolbox and its current configuration.

public virtual System.ClientModel.ClientResult<Azure.AI.Projects.Agents.ToolboxRecord> Get(string name, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.Agents.ToolboxRecord>
override this.Get : string * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.Agents.ToolboxRecord>
Public Overridable Function Get (name As String, Optional cancellationToken As CancellationToken = Nothing) As ClientResult(Of ToolboxRecord)

Parameters

name
String

The name of the toolbox to retrieve.

cancellationToken
CancellationToken

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

Returns

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