FabricIQPreviewToolboxTool Class

Definition

A FabricIQ tool stored in a toolbox.

public class FabricIQPreviewToolboxTool : Azure.AI.Projects.Agents.ToolboxTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.FabricIQPreviewToolboxTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.FabricIQPreviewToolboxTool>
type FabricIQPreviewToolboxTool = class
    inherit ToolboxTool
    interface IJsonModel<FabricIQPreviewToolboxTool>
    interface IPersistableModel<FabricIQPreviewToolboxTool>
Public Class FabricIQPreviewToolboxTool
Inherits ToolboxTool
Implements IJsonModel(Of FabricIQPreviewToolboxTool), IPersistableModel(Of FabricIQPreviewToolboxTool)
Inheritance
FabricIQPreviewToolboxTool
Implements

Constructors

Name Description
FabricIQPreviewToolboxTool(String)

Initializes a new instance of FabricIQPreviewToolboxTool.

Properties

Name Description
Description

Optional user-defined description for this tool or configuration.

(Inherited from ToolboxTool)
Name

Optional user-defined name for this tool or configuration.

(Inherited from ToolboxTool)
ProjectConnectionId

The ID of the FabricIQ project connection.

RequireApproval

Approval policy for FabricIQ tools.

RequireApprovalInternal

(Optional) Whether the agent requires approval before executing actions. Default is always.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

  • OpenAI.Responses.McpToolCallApprovalPolicy.
  • String.
</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

ServerLabel

(Optional) The label of the FabricIQ MCP server to connect to.

ServerUri

(Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used.

ToolConfigs

Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

(Inherited from ToolboxTool)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<FabricIQPreviewToolboxTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<FabricIQPreviewToolboxTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ToolboxTool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ToolboxTool)
IJsonModel<ToolboxTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ToolboxTool)
IPersistableModel<FabricIQPreviewToolboxTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<FabricIQPreviewToolboxTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<FabricIQPreviewToolboxTool>.Write(ModelReaderWriterOptions)
IPersistableModel<ToolboxTool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ToolboxTool)
IPersistableModel<ToolboxTool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ToolboxTool)
IPersistableModel<ToolboxTool>.Write(ModelReaderWriterOptions) (Inherited from ToolboxTool)

Applies to