SupervisorAgent

Databricks v1.92.0, May 12 26

Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Create SupervisorAgent Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SupervisorAgent(name: string, args: SupervisorAgentArgs, opts?: CustomResourceOptions);

@overload
def SupervisorAgent(resource_name: str,
                    args: SupervisorAgentArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SupervisorAgent(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    display_name: Optional[str] = None,
                    description: Optional[str] = None,
                    instructions: Optional[str] = None,
                    provider_config: Optional[SupervisorAgentProviderConfigArgs] = None)

func NewSupervisorAgent(ctx *Context, name string, args SupervisorAgentArgs, opts ...ResourceOption) (*SupervisorAgent, error)

public SupervisorAgent(string name, SupervisorAgentArgs args, CustomResourceOptions? opts = null)

public SupervisorAgent(String name, SupervisorAgentArgs args)
public SupervisorAgent(String name, SupervisorAgentArgs args, CustomResourceOptions options)

type: databricks:SupervisorAgent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "databricks_supervisoragent" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args SupervisorAgentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SupervisorAgentArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SupervisorAgentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SupervisorAgentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SupervisorAgentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var supervisorAgentResource = new Databricks.SupervisorAgent("supervisorAgentResource", new()
{
    DisplayName = "string",
    Description = "string",
    Instructions = "string",
    ProviderConfig = new Databricks.Inputs.SupervisorAgentProviderConfigArgs
    {
        WorkspaceId = "string",
    },
});

example, err := databricks.NewSupervisorAgent(ctx, "supervisorAgentResource", &databricks.SupervisorAgentArgs{
	DisplayName:  pulumi.String("string"),
	Description:  pulumi.String("string"),
	Instructions: pulumi.String("string"),
	ProviderConfig: &databricks.SupervisorAgentProviderConfigArgs{
		WorkspaceId: pulumi.String("string"),
	},
})

resource "databricks_supervisoragent" "supervisorAgentResource" {
  display_name = "string"
  description  = "string"
  instructions = "string"
  provider_config = {
    workspace_id = "string"
  }
}

var supervisorAgentResource = new SupervisorAgent("supervisorAgentResource", SupervisorAgentArgs.builder()
    .displayName("string")
    .description("string")
    .instructions("string")
    .providerConfig(SupervisorAgentProviderConfigArgs.builder()
        .workspaceId("string")
        .build())
    .build());

supervisor_agent_resource = databricks.SupervisorAgent("supervisorAgentResource",
    display_name="string",
    description="string",
    instructions="string",
    provider_config={
        "workspace_id": "string",
    })

const supervisorAgentResource = new databricks.SupervisorAgent("supervisorAgentResource", {
    displayName: "string",
    description: "string",
    instructions: "string",
    providerConfig: {
        workspaceId: "string",
    },
});

type: databricks:SupervisorAgent
properties:
    description: string
    displayName: string
    instructions: string
    providerConfig:
        workspaceId: string

SupervisorAgent Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SupervisorAgent resource accepts the following input properties:

DisplayName string: The display name of the Supervisor Agent, unique at workspace level
Description string: Description of what this agent can do (user-facing)
Instructions string: Optional natural-language instructions for the supervisor agent
ProviderConfig SupervisorAgentProviderConfig: Configure the provider for management through account provider.

DisplayName string: The display name of the Supervisor Agent, unique at workspace level
Description string: Description of what this agent can do (user-facing)
Instructions string: Optional natural-language instructions for the supervisor agent
ProviderConfig SupervisorAgentProviderConfigArgs: Configure the provider for management through account provider.

display_name string: The display name of the Supervisor Agent, unique at workspace level
description string: Description of what this agent can do (user-facing)
instructions string: Optional natural-language instructions for the supervisor agent
provider_config object: Configure the provider for management through account provider.

displayName String: The display name of the Supervisor Agent, unique at workspace level
description String: Description of what this agent can do (user-facing)
instructions String: Optional natural-language instructions for the supervisor agent
providerConfig SupervisorAgentProviderConfig: Configure the provider for management through account provider.

displayName string: The display name of the Supervisor Agent, unique at workspace level
description string: Description of what this agent can do (user-facing)
instructions string: Optional natural-language instructions for the supervisor agent
providerConfig SupervisorAgentProviderConfig: Configure the provider for management through account provider.

display_name str: The display name of the Supervisor Agent, unique at workspace level
description str: Description of what this agent can do (user-facing)
instructions str: Optional natural-language instructions for the supervisor agent
provider_config SupervisorAgentProviderConfigArgs: Configure the provider for management through account provider.

displayName String: The display name of the Supervisor Agent, unique at workspace level
description String: Description of what this agent can do (user-facing)
instructions String: Optional natural-language instructions for the supervisor agent
providerConfig Property Map: Configure the provider for management through account provider.

Outputs

All input properties are implicitly available as output properties. Additionally, the SupervisorAgent resource produces the following output properties:

CreateTime string: (string) - Creation timestamp
Creator string: (string) - The creator of the Supervisor Agent
EndpointName string: (string) - The name of the supervisor agent's serving endpoint
ExperimentId string: (string) - The MLflow experiment ID
Id string: The provider-assigned unique ID for this managed resource.
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

CreateTime string: (string) - Creation timestamp
Creator string: (string) - The creator of the Supervisor Agent
EndpointName string: (string) - The name of the supervisor agent's serving endpoint
ExperimentId string: (string) - The MLflow experiment ID
Id string: The provider-assigned unique ID for this managed resource.
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

create_time string: (string) - Creation timestamp
creator string: (string) - The creator of the Supervisor Agent
endpoint_name string: (string) - The name of the supervisor agent's serving endpoint
experiment_id string: (string) - The MLflow experiment ID
id string: The provider-assigned unique ID for this managed resource.
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

createTime String: (string) - Creation timestamp
creator String: (string) - The creator of the Supervisor Agent
endpointName String: (string) - The name of the supervisor agent's serving endpoint
experimentId String: (string) - The MLflow experiment ID
id String: The provider-assigned unique ID for this managed resource.
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

createTime string: (string) - Creation timestamp
creator string: (string) - The creator of the Supervisor Agent
endpointName string: (string) - The name of the supervisor agent's serving endpoint
experimentId string: (string) - The MLflow experiment ID
id string: The provider-assigned unique ID for this managed resource.
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

create_time str: (string) - Creation timestamp
creator str: (string) - The creator of the Supervisor Agent
endpoint_name str: (string) - The name of the supervisor agent's serving endpoint
experiment_id str: (string) - The MLflow experiment ID
id str: The provider-assigned unique ID for this managed resource.
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

createTime String: (string) - Creation timestamp
creator String: (string) - The creator of the Supervisor Agent
endpointName String: (string) - The name of the supervisor agent's serving endpoint
experimentId String: (string) - The MLflow experiment ID
id String: The provider-assigned unique ID for this managed resource.
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

Look up Existing SupervisorAgent Resource

Get an existing SupervisorAgent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SupervisorAgentState, opts?: CustomResourceOptions): SupervisorAgent

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        creator: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        experiment_id: Optional[str] = None,
        instructions: Optional[str] = None,
        name: Optional[str] = None,
        provider_config: Optional[SupervisorAgentProviderConfigArgs] = None,
        supervisor_agent_id: Optional[str] = None) -> SupervisorAgent

func GetSupervisorAgent(ctx *Context, name string, id IDInput, state *SupervisorAgentState, opts ...ResourceOption) (*SupervisorAgent, error)

public static SupervisorAgent Get(string name, Input<string> id, SupervisorAgentState? state, CustomResourceOptions? opts = null)

public static SupervisorAgent get(String name, Output<String> id, SupervisorAgentState state, CustomResourceOptions options)

resources:  _:    type: databricks:SupervisorAgent    get:      id: ${id}

import {
  to = databricks_supervisoragent.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreateTime string: (string) - Creation timestamp
Creator string: (string) - The creator of the Supervisor Agent
Description string: Description of what this agent can do (user-facing)
DisplayName 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
Instructions string: Optional natural-language instructions for the supervisor agent
Name string: (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
ProviderConfig SupervisorAgentProviderConfig: Configure the provider for management through account provider.
SupervisorAgentId string: (string) - The universally unique identifier (UUID) of the Supervisor Agent

CreateTime string: (string) - Creation timestamp
Creator string: (string) - The creator of the Supervisor Agent
Description string: Description of what this agent can do (user-facing)
DisplayName 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
Instructions string: Optional natural-language instructions for the supervisor agent
Name string: (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
ProviderConfig SupervisorAgentProviderConfigArgs: Configure the provider for management through account provider.
SupervisorAgentId string: (string) - The universally unique identifier (UUID) of the Supervisor Agent

create_time string: (string) - Creation timestamp
creator string: (string) - The creator of the Supervisor Agent
description string: Description of what this agent can do (user-facing)
display_name 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
instructions string: Optional natural-language instructions for the supervisor agent
name string: (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
provider_config object: Configure the provider for management through account provider.
supervisor_agent_id string: (string) - The universally unique identifier (UUID) of the Supervisor Agent

createTime String: (string) - Creation timestamp
creator String: (string) - The creator of the Supervisor Agent
description String: Description of what this agent can do (user-facing)
displayName 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
instructions String: Optional natural-language instructions for the supervisor agent
name String: (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
providerConfig SupervisorAgentProviderConfig: Configure the provider for management through account provider.
supervisorAgentId String: (string) - The universally unique identifier (UUID) of the Supervisor Agent

createTime string: (string) - Creation timestamp
creator string: (string) - The creator of the Supervisor Agent
description string: Description of what this agent can do (user-facing)
displayName 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
instructions string: Optional natural-language instructions for the supervisor agent
name string: (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
providerConfig SupervisorAgentProviderConfig: Configure the provider for management through account provider.
supervisorAgentId string: (string) - The universally unique identifier (UUID) of the Supervisor Agent

create_time str: (string) - Creation timestamp
creator str: (string) - The creator of the Supervisor Agent
description str: Description of what this agent can do (user-facing)
display_name str: 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
instructions str: Optional natural-language instructions for the supervisor agent
name str: (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
provider_config SupervisorAgentProviderConfigArgs: Configure the provider for management through account provider.
supervisor_agent_id str: (string) - The universally unique identifier (UUID) of the Supervisor Agent

createTime String: (string) - Creation timestamp
creator String: (string) - The creator of the Supervisor Agent
description String: Description of what this agent can do (user-facing)
displayName 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
instructions String: Optional natural-language instructions for the supervisor agent
name String: (string) - The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
providerConfig Property Map: Configure the provider for management through account provider.
supervisorAgentId String: (string) - The universally unique identifier (UUID) of the Supervisor Agent

Supporting Types

SupervisorAgentProviderConfig, SupervisorAgentProviderConfigArgs

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.

Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

databricks.SupervisorAgent

On this page

On this page

Create SupervisorAgent Resource

Constructor syntax

Parameters

Constructor example

SupervisorAgent Resource Properties

Inputs

Outputs

Look up Existing SupervisorAgent Resource

Supporting Types

SupervisorAgentProviderConfig, SupervisorAgentProviderConfigArgs

Package Details

On this page

On this page