AgentToolboxes.GetToolbox 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 |
|---|---|
| GetToolbox(String, RequestOptions) |
[Protocol Method] Retrieve a toolbox.
|
| GetToolbox(String, CancellationToken) |
Retrieve a toolbox. |
GetToolbox(String, RequestOptions)
- Source:
- AgentToolboxes.cs
[Protocol Method] Retrieve a toolbox.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.ClientModel.ClientResult GetToolbox(string name, System.ClientModel.Primitives.RequestOptions options);abstract member GetToolbox : string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
override this.GetToolbox : string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResultPublic Overridable Function GetToolbox (name As String, options As RequestOptions) As ClientResultParameters
- 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
GetToolbox(String, CancellationToken)
- Source:
- AgentToolboxes.cs
Retrieve a toolbox.
public virtual System.ClientModel.ClientResult<Azure.AI.Projects.Agents.ToolboxRecord> GetToolbox(string name, System.Threading.CancellationToken cancellationToken = default);abstract member GetToolbox : string * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.Agents.ToolboxRecord>
override this.GetToolbox : string * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.Agents.ToolboxRecord>Public Overridable Function GetToolbox (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.
