1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getSupervisorAgent
Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi

    Public Beta

    Using getSupervisorAgent

    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 getSupervisorAgent(args: GetSupervisorAgentArgs, opts?: InvokeOptions): Promise<GetSupervisorAgentResult>
    function getSupervisorAgentOutput(args: GetSupervisorAgentOutputArgs, opts?: InvokeOptions): Output<GetSupervisorAgentResult>
    def get_supervisor_agent(name: Optional[str] = None,
                             provider_config: Optional[GetSupervisorAgentProviderConfig] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSupervisorAgentResult
    def get_supervisor_agent_output(name: pulumi.Input[Optional[str]] = None,
                             provider_config: pulumi.Input[Optional[GetSupervisorAgentProviderConfigArgs]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSupervisorAgentResult]
    func LookupSupervisorAgent(ctx *Context, args *LookupSupervisorAgentArgs, opts ...InvokeOption) (*LookupSupervisorAgentResult, error)
    func LookupSupervisorAgentOutput(ctx *Context, args *LookupSupervisorAgentOutputArgs, opts ...InvokeOption) LookupSupervisorAgentResultOutput

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

    public static class GetSupervisorAgent 
    {
        public static Task<GetSupervisorAgentResult> InvokeAsync(GetSupervisorAgentArgs args, InvokeOptions? opts = null)
        public static Output<GetSupervisorAgentResult> Invoke(GetSupervisorAgentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSupervisorAgentResult> getSupervisorAgent(GetSupervisorAgentArgs args, InvokeOptions options)
    public static Output<GetSupervisorAgentResult> getSupervisorAgent(GetSupervisorAgentArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getSupervisorAgent:getSupervisorAgent
      arguments:
        # arguments dictionary
    data "databricks_getsupervisoragent" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    ProviderConfig GetSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    Name string
    The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    ProviderConfig GetSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    name string
    The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    provider_config object
    Configure the provider for management through account provider.
    name String
    The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    providerConfig GetSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    name string
    The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    providerConfig GetSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    name str
    The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    provider_config GetSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    name String
    The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getSupervisorAgent Result

    The following output properties are available:

    CreateTime string
    (string) - Creation timestamp
    Creator string
    (string) - The creator of the Supervisor Agent
    Description string
    (string) - Description of what this agent can do (user-facing)
    DisplayName string
    (string) - The display name of the Supervisor Agent, unique at workspace level
    EndpointName string
    (string) - The name of the supervisor agent's serving endpoint
    ExperimentId string
    (string) - The MLflow experiment ID
    Id string
    (string, deprecated) - Deprecated: Use supervisorAgentId instead
    Instructions string
    (string) - Optional natural-language instructions for the supervisor agent
    Name string
    (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    SupervisorAgentId string
    (string) - The universally unique identifier (UUID) of the Supervisor Agent
    ProviderConfig GetSupervisorAgentProviderConfig
    CreateTime string
    (string) - Creation timestamp
    Creator string
    (string) - The creator of the Supervisor Agent
    Description string
    (string) - Description of what this agent can do (user-facing)
    DisplayName string
    (string) - The display name of the Supervisor Agent, unique at workspace level
    EndpointName string
    (string) - The name of the supervisor agent's serving endpoint
    ExperimentId string
    (string) - The MLflow experiment ID
    Id string
    (string, deprecated) - Deprecated: Use supervisorAgentId instead
    Instructions string
    (string) - Optional natural-language instructions for the supervisor agent
    Name string
    (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    SupervisorAgentId string
    (string) - The universally unique identifier (UUID) of the Supervisor Agent
    ProviderConfig GetSupervisorAgentProviderConfig
    create_time string
    (string) - Creation timestamp
    creator string
    (string) - The creator of the Supervisor Agent
    description string
    (string) - Description of what this agent can do (user-facing)
    display_name string
    (string) - The display name of the Supervisor Agent, unique at workspace level
    endpoint_name string
    (string) - The name of the supervisor agent's serving endpoint
    experiment_id string
    (string) - The MLflow experiment ID
    id string
    (string, deprecated) - Deprecated: Use supervisorAgentId instead
    instructions string
    (string) - Optional natural-language instructions for the supervisor agent
    name string
    (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    supervisor_agent_id string
    (string) - The universally unique identifier (UUID) of the Supervisor Agent
    provider_config object
    createTime String
    (string) - Creation timestamp
    creator String
    (string) - The creator of the Supervisor Agent
    description String
    (string) - Description of what this agent can do (user-facing)
    displayName String
    (string) - The display name of the Supervisor Agent, unique at workspace level
    endpointName String
    (string) - The name of the supervisor agent's serving endpoint
    experimentId String
    (string) - The MLflow experiment ID
    id String
    (string, deprecated) - Deprecated: Use supervisorAgentId instead
    instructions String
    (string) - Optional natural-language instructions for the supervisor agent
    name String
    (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    supervisorAgentId String
    (string) - The universally unique identifier (UUID) of the Supervisor Agent
    providerConfig GetSupervisorAgentProviderConfig
    createTime string
    (string) - Creation timestamp
    creator string
    (string) - The creator of the Supervisor Agent
    description string
    (string) - Description of what this agent can do (user-facing)
    displayName string
    (string) - The display name of the Supervisor Agent, unique at workspace level
    endpointName string
    (string) - The name of the supervisor agent's serving endpoint
    experimentId string
    (string) - The MLflow experiment ID
    id string
    (string, deprecated) - Deprecated: Use supervisorAgentId instead
    instructions string
    (string) - Optional natural-language instructions for the supervisor agent
    name string
    (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    supervisorAgentId string
    (string) - The universally unique identifier (UUID) of the Supervisor Agent
    providerConfig GetSupervisorAgentProviderConfig
    create_time str
    (string) - Creation timestamp
    creator str
    (string) - The creator of the Supervisor Agent
    description str
    (string) - Description of what this agent can do (user-facing)
    display_name str
    (string) - The display name of the Supervisor Agent, unique at workspace level
    endpoint_name str
    (string) - The name of the supervisor agent's serving endpoint
    experiment_id str
    (string) - The MLflow experiment ID
    id str
    (string, deprecated) - Deprecated: Use supervisorAgentId instead
    instructions str
    (string) - Optional natural-language instructions for the supervisor agent
    name str
    (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    supervisor_agent_id str
    (string) - The universally unique identifier (UUID) of the Supervisor Agent
    provider_config GetSupervisorAgentProviderConfig
    createTime String
    (string) - Creation timestamp
    creator String
    (string) - The creator of the Supervisor Agent
    description String
    (string) - Description of what this agent can do (user-facing)
    displayName String
    (string) - The display name of the Supervisor Agent, unique at workspace level
    endpointName String
    (string) - The name of the supervisor agent's serving endpoint
    experimentId String
    (string) - The MLflow experiment ID
    id String
    (string, deprecated) - Deprecated: Use supervisorAgentId instead
    instructions String
    (string) - Optional natural-language instructions for the supervisor agent
    name String
    (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
    supervisorAgentId String
    (string) - The universally unique identifier (UUID) of the Supervisor Agent
    providerConfig Property Map

    Supporting Types

    GetSupervisorAgentProviderConfig

    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.

    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
      Try Pulumi Cloud free. Your team will thank you.