1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getSupervisorAgentTool
Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getSupervisorAgentTool

databricks logo
Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    Using getSupervisorAgentTool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSupervisorAgentTool(args: GetSupervisorAgentToolArgs, opts?: InvokeOptions): Promise<GetSupervisorAgentToolResult>
function getSupervisorAgentToolOutput(args: GetSupervisorAgentToolOutputArgs, opts?: InvokeOptions): Output<GetSupervisorAgentToolResult>
    def get_supervisor_agent_tool(name: Optional[str] = None,
                              provider_config: Optional[GetSupervisorAgentToolProviderConfig] = None,
                              opts: Optional[InvokeOptions] = None) -> GetSupervisorAgentToolResult
def get_supervisor_agent_tool_output(name: pulumi.Input[Optional[str]] = None,
                              provider_config: pulumi.Input[Optional[GetSupervisorAgentToolProviderConfigArgs]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetSupervisorAgentToolResult]
    func LookupSupervisorAgentTool(ctx *Context, args *LookupSupervisorAgentToolArgs, opts ...InvokeOption) (*LookupSupervisorAgentToolResult, error)
func LookupSupervisorAgentToolOutput(ctx *Context, args *LookupSupervisorAgentToolOutputArgs, opts ...InvokeOption) LookupSupervisorAgentToolResultOutput

    > Note: This function is named LookupSupervisorAgentTool in the Go SDK.

    public static class GetSupervisorAgentTool 
{
    public static Task<GetSupervisorAgentToolResult> InvokeAsync(GetSupervisorAgentToolArgs args, InvokeOptions? opts = null)
    public static Output<GetSupervisorAgentToolResult> Invoke(GetSupervisorAgentToolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSupervisorAgentToolResult> getSupervisorAgentTool(GetSupervisorAgentToolArgs args, InvokeOptions options)
public static Output<GetSupervisorAgentToolResult> getSupervisorAgentTool(GetSupervisorAgentToolArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getSupervisorAgentTool:getSupervisorAgentTool
  arguments:
    # arguments dictionary
    data "databricks_getsupervisoragenttool" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    ProviderConfig GetSupervisorAgentToolProviderConfig
    Configure the provider for management through account provider.
    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    ProviderConfig GetSupervisorAgentToolProviderConfig
    Configure the provider for management through account provider.
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    provider_config object
    Configure the provider for management through account provider.
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    providerConfig GetSupervisorAgentToolProviderConfig
    Configure the provider for management through account provider.
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    providerConfig GetSupervisorAgentToolProviderConfig
    Configure the provider for management through account provider.
    name str
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    provider_config GetSupervisorAgentToolProviderConfig
    Configure the provider for management through account provider.
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getSupervisorAgentTool Result

    The following output properties are available:

    App GetSupervisorAgentToolApp
    (App)
    Description string
    (string) - Description of what this tool does (user-facing)
    GenieSpace GetSupervisorAgentToolGenieSpace
    (GenieSpace)
    Id string
    (string) - The ID of the genie space
    KnowledgeAssistant GetSupervisorAgentToolKnowledgeAssistant
    (KnowledgeAssistant)
    Name string
    (string) - Full uc volume name
    ToolId string
    (string) - User specified id of the Tool
    ToolType string
    (string) - Tool type. Must be one of: "genieSpace", "knowledgeAssistant", "ucFunction", "ucConnection", "app", "volume", "lakeviewDashboard", "servingEndpoint", "ucTable", "vectorSearchIndex", "catalog", "schema", "supervisorAgent", "webSearch"
    UcConnection GetSupervisorAgentToolUcConnection
    (UcConnection)
    UcFunction GetSupervisorAgentToolUcFunction
    (UcFunction)
    Volume GetSupervisorAgentToolVolume
    (Volume)
    ProviderConfig GetSupervisorAgentToolProviderConfig
    App GetSupervisorAgentToolApp
    (App)
    Description string
    (string) - Description of what this tool does (user-facing)
    GenieSpace GetSupervisorAgentToolGenieSpace
    (GenieSpace)
    Id string
    (string) - The ID of the genie space
    KnowledgeAssistant GetSupervisorAgentToolKnowledgeAssistant
    (KnowledgeAssistant)
    Name string
    (string) - Full uc volume name
    ToolId string
    (string) - User specified id of the Tool
    ToolType string
    (string) - Tool type. Must be one of: "genieSpace", "knowledgeAssistant", "ucFunction", "ucConnection", "app", "volume", "lakeviewDashboard", "servingEndpoint", "ucTable", "vectorSearchIndex", "catalog", "schema", "supervisorAgent", "webSearch"
    UcConnection GetSupervisorAgentToolUcConnection
    (UcConnection)
    UcFunction GetSupervisorAgentToolUcFunction
    (UcFunction)
    Volume GetSupervisorAgentToolVolume
    (Volume)
    ProviderConfig GetSupervisorAgentToolProviderConfig
    app object
    (App)
    description string
    (string) - Description of what this tool does (user-facing)
    genie_space object
    (GenieSpace)
    id string
    (string) - The ID of the genie space
    knowledge_assistant object
    (KnowledgeAssistant)
    name string
    (string) - Full uc volume name
    tool_id string
    (string) - User specified id of the Tool
    tool_type string
    (string) - Tool type. Must be one of: "genieSpace", "knowledgeAssistant", "ucFunction", "ucConnection", "app", "volume", "lakeviewDashboard", "servingEndpoint", "ucTable", "vectorSearchIndex", "catalog", "schema", "supervisorAgent", "webSearch"
    uc_connection object
    (UcConnection)
    uc_function object
    (UcFunction)
    volume object
    (Volume)
    provider_config object
    app GetSupervisorAgentToolApp
    (App)
    description String
    (string) - Description of what this tool does (user-facing)
    genieSpace GetSupervisorAgentToolGenieSpace
    (GenieSpace)
    id String
    (string) - The ID of the genie space
    knowledgeAssistant GetSupervisorAgentToolKnowledgeAssistant
    (KnowledgeAssistant)
    name String
    (string) - Full uc volume name
    toolId String
    (string) - User specified id of the Tool
    toolType String
    (string) - Tool type. Must be one of: "genieSpace", "knowledgeAssistant", "ucFunction", "ucConnection", "app", "volume", "lakeviewDashboard", "servingEndpoint", "ucTable", "vectorSearchIndex", "catalog", "schema", "supervisorAgent", "webSearch"
    ucConnection GetSupervisorAgentToolUcConnection
    (UcConnection)
    ucFunction GetSupervisorAgentToolUcFunction
    (UcFunction)
    volume GetSupervisorAgentToolVolume
    (Volume)
    providerConfig GetSupervisorAgentToolProviderConfig
    app GetSupervisorAgentToolApp
    (App)
    description string
    (string) - Description of what this tool does (user-facing)
    genieSpace GetSupervisorAgentToolGenieSpace
    (GenieSpace)
    id string
    (string) - The ID of the genie space
    knowledgeAssistant GetSupervisorAgentToolKnowledgeAssistant
    (KnowledgeAssistant)
    name string
    (string) - Full uc volume name
    toolId string
    (string) - User specified id of the Tool
    toolType string
    (string) - Tool type. Must be one of: "genieSpace", "knowledgeAssistant", "ucFunction", "ucConnection", "app", "volume", "lakeviewDashboard", "servingEndpoint", "ucTable", "vectorSearchIndex", "catalog", "schema", "supervisorAgent", "webSearch"
    ucConnection GetSupervisorAgentToolUcConnection
    (UcConnection)
    ucFunction GetSupervisorAgentToolUcFunction
    (UcFunction)
    volume GetSupervisorAgentToolVolume
    (Volume)
    providerConfig GetSupervisorAgentToolProviderConfig
    app GetSupervisorAgentToolApp
    (App)
    description str
    (string) - Description of what this tool does (user-facing)
    genie_space GetSupervisorAgentToolGenieSpace
    (GenieSpace)
    id str
    (string) - The ID of the genie space
    knowledge_assistant GetSupervisorAgentToolKnowledgeAssistant
    (KnowledgeAssistant)
    name str
    (string) - Full uc volume name
    tool_id str
    (string) - User specified id of the Tool
    tool_type str
    (string) - Tool type. Must be one of: "genieSpace", "knowledgeAssistant", "ucFunction", "ucConnection", "app", "volume", "lakeviewDashboard", "servingEndpoint", "ucTable", "vectorSearchIndex", "catalog", "schema", "supervisorAgent", "webSearch"
    uc_connection GetSupervisorAgentToolUcConnection
    (UcConnection)
    uc_function GetSupervisorAgentToolUcFunction
    (UcFunction)
    volume GetSupervisorAgentToolVolume
    (Volume)
    provider_config GetSupervisorAgentToolProviderConfig
    app Property Map
    (App)
    description String
    (string) - Description of what this tool does (user-facing)
    genieSpace Property Map
    (GenieSpace)
    id String
    (string) - The ID of the genie space
    knowledgeAssistant Property Map
    (KnowledgeAssistant)
    name String
    (string) - Full uc volume name
    toolId String
    (string) - User specified id of the Tool
    toolType String
    (string) - Tool type. Must be one of: "genieSpace", "knowledgeAssistant", "ucFunction", "ucConnection", "app", "volume", "lakeviewDashboard", "servingEndpoint", "ucTable", "vectorSearchIndex", "catalog", "schema", "supervisorAgent", "webSearch"
    ucConnection Property Map
    (UcConnection)
    ucFunction Property Map
    (UcFunction)
    volume Property Map
    (Volume)
    providerConfig Property Map

    Supporting Types

    GetSupervisorAgentToolApp

    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name str
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

    GetSupervisorAgentToolGenieSpace

    Id string
    (string) - The ID of the genie space
    Id string
    (string) - The ID of the genie space
    id string
    (string) - The ID of the genie space
    id String
    (string) - The ID of the genie space
    id string
    (string) - The ID of the genie space
    id str
    (string) - The ID of the genie space
    id String
    (string) - The ID of the genie space

    GetSupervisorAgentToolKnowledgeAssistant

    KnowledgeAssistantId string
    (string) - The ID of the knowledge assistant
    ServingEndpointName string
    (string, deprecated) - Deprecated: use knowledgeAssistantId instead
    KnowledgeAssistantId string
    (string) - The ID of the knowledge assistant
    ServingEndpointName string
    (string, deprecated) - Deprecated: use knowledgeAssistantId instead
    knowledge_assistant_id string
    (string) - The ID of the knowledge assistant
    serving_endpoint_name string
    (string, deprecated) - Deprecated: use knowledgeAssistantId instead
    knowledgeAssistantId String
    (string) - The ID of the knowledge assistant
    servingEndpointName String
    (string, deprecated) - Deprecated: use knowledgeAssistantId instead
    knowledgeAssistantId string
    (string) - The ID of the knowledge assistant
    servingEndpointName string
    (string, deprecated) - Deprecated: use knowledgeAssistantId instead
    knowledge_assistant_id str
    (string) - The ID of the knowledge assistant
    serving_endpoint_name str
    (string, deprecated) - Deprecated: use knowledgeAssistantId instead
    knowledgeAssistantId String
    (string) - The ID of the knowledge assistant
    servingEndpointName String
    (string, deprecated) - Deprecated: use knowledgeAssistantId instead

    GetSupervisorAgentToolProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    GetSupervisorAgentToolUcConnection

    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name str
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

    GetSupervisorAgentToolUcFunction

    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name str
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

    GetSupervisorAgentToolVolume

    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    Name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name string
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name str
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
    name String
    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.92.0
    published on Tuesday, May 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.