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

databricks.getSupervisorAgents

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 getSupervisorAgents

    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 getSupervisorAgents(args: GetSupervisorAgentsArgs, opts?: InvokeOptions): Promise<GetSupervisorAgentsResult>
function getSupervisorAgentsOutput(args: GetSupervisorAgentsOutputArgs, opts?: InvokeOptions): Output<GetSupervisorAgentsResult>
    def get_supervisor_agents(page_size: Optional[int] = None,
                          provider_config: Optional[GetSupervisorAgentsProviderConfig] = None,
                          opts: Optional[InvokeOptions] = None) -> GetSupervisorAgentsResult
def get_supervisor_agents_output(page_size: pulumi.Input[Optional[int]] = None,
                          provider_config: pulumi.Input[Optional[GetSupervisorAgentsProviderConfigArgs]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetSupervisorAgentsResult]
    func GetSupervisorAgents(ctx *Context, args *GetSupervisorAgentsArgs, opts ...InvokeOption) (*GetSupervisorAgentsResult, error)
func GetSupervisorAgentsOutput(ctx *Context, args *GetSupervisorAgentsOutputArgs, opts ...InvokeOption) GetSupervisorAgentsResultOutput

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

    public static class GetSupervisorAgents 
{
    public static Task<GetSupervisorAgentsResult> InvokeAsync(GetSupervisorAgentsArgs args, InvokeOptions? opts = null)
    public static Output<GetSupervisorAgentsResult> Invoke(GetSupervisorAgentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSupervisorAgentsResult> getSupervisorAgents(GetSupervisorAgentsArgs args, InvokeOptions options)
public static Output<GetSupervisorAgentsResult> getSupervisorAgents(GetSupervisorAgentsArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getSupervisorAgents:getSupervisorAgents
  arguments:
    # arguments dictionary
    data "databricks_getsupervisoragents" "name" {
    # arguments
}

    The following arguments are supported:

    PageSize int
    The maximum number of supervisor agents to return. If unspecified, at most 100 supervisor agents will be returned. The maximum value is 100; values above 100 will be coerced to 100
    ProviderConfig GetSupervisorAgentsProviderConfig
    Configure the provider for management through account provider.
    PageSize int
    The maximum number of supervisor agents to return. If unspecified, at most 100 supervisor agents will be returned. The maximum value is 100; values above 100 will be coerced to 100
    ProviderConfig GetSupervisorAgentsProviderConfig
    Configure the provider for management through account provider.
    page_size number
    The maximum number of supervisor agents to return. If unspecified, at most 100 supervisor agents will be returned. The maximum value is 100; values above 100 will be coerced to 100
    provider_config object
    Configure the provider for management through account provider.
    pageSize Integer
    The maximum number of supervisor agents to return. If unspecified, at most 100 supervisor agents will be returned. The maximum value is 100; values above 100 will be coerced to 100
    providerConfig GetSupervisorAgentsProviderConfig
    Configure the provider for management through account provider.
    pageSize number
    The maximum number of supervisor agents to return. If unspecified, at most 100 supervisor agents will be returned. The maximum value is 100; values above 100 will be coerced to 100
    providerConfig GetSupervisorAgentsProviderConfig
    Configure the provider for management through account provider.
    page_size int
    The maximum number of supervisor agents to return. If unspecified, at most 100 supervisor agents will be returned. The maximum value is 100; values above 100 will be coerced to 100
    provider_config GetSupervisorAgentsProviderConfig
    Configure the provider for management through account provider.
    pageSize Number
    The maximum number of supervisor agents to return. If unspecified, at most 100 supervisor agents will be returned. The maximum value is 100; values above 100 will be coerced to 100
    providerConfig Property Map
    Configure the provider for management through account provider.

    getSupervisorAgents Result

    The following output properties are available:

    id string
    The provider-assigned unique ID for this managed resource.
    supervisor_agents list(object)
    page_size number
    provider_config object
    id string
    The provider-assigned unique ID for this managed resource.
    supervisorAgents GetSupervisorAgentsSupervisorAgent[]
    pageSize number
    providerConfig GetSupervisorAgentsProviderConfig
    id String
    The provider-assigned unique ID for this managed resource.
    supervisorAgents List<Property Map>
    pageSize Number
    providerConfig Property Map

    Supporting Types

    GetSupervisorAgentsProviderConfig

    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.

    GetSupervisorAgentsSupervisorAgent

    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 GetSupervisorAgentsSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    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 GetSupervisorAgentsSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    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
    Configure the provider for management through account provider.
    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 GetSupervisorAgentsSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    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 GetSupervisorAgentsSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    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 GetSupervisorAgentsSupervisorAgentProviderConfig
    Configure the provider for management through account provider.
    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
    Configure the provider for management through account provider.

    GetSupervisorAgentsSupervisorAgentProviderConfig

    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
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial