ai_gateway_agent_services

Creates, updates, deletes, gets or lists an ai_gateway_agent_services resource.

Overview

Name	ai_gateway_agent_services
Type	Resource
Id	databricks_workspace.catalog.ai_gateway_agent_services

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Resource name of the agent service. Format: ``agent-services/{catalog}.{schema}.{agent_service}``. Each ``{...}`` component is capped at 255 characters individually. Server-derived on Create from ``parent`` + ``agent_service_id``; required and immutable on Update/Get/Delete.
metastore_id	string	Metastore hosting the agent service.
agent_service_type	string	Type of agent service. Required on create. Immutable after creation. For future internal / genie / app kinds, determines how the backing agent surface is provisioned. (AGENT_SERVICE_TYPE_EXTERNAL)
browse_only	boolean	Whether the caller sees only metadata available through the BROWSE privilege.
comment	string	User-provided description.
▶config	object	Operational configuration: connection, base_path, system_prompt, model_service, optional inference table, optional rate limits. Required on CreateAgentService; on UpdateAgentService it is required only when ``config`` (or a ``config.*`` subpath) appears in ``update_mask``.
create_time	string (date-time)	When the agent service was created.
created_by	string	Creator identity.
effective_owner	string	The resolved owner of the agent service. Falls back to the caller's identity when ``owner`` is not explicitly set on creation.
etag	string	Optimistic concurrency control token. Server-generated from the entity's state and returned on every read. To use it as an if-match precondition on a mutation, echo the last-read value back via the dedicated ``etag`` field on the Update / Delete request; the server rejects the mutation if the stored etag differs.
owner	string	The owner of the agent service. Write-only; read owner via effective_owner.
update_time	string (date-time)	When the agent service was last modified.
updated_by	string	Identity of the last updater.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	deployment_name	include_browse, page_size, page_token, parent	Lists the agent services in a Unity Catalog schema. Provide parent as
create	insert	parent, agent_service_id, deployment_name, agent_service		Creates an agent service in a Unity Catalog schema. An agent service is a governed securable that

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agent_service_id	string	Leaf identifier for the agent service (the unqualified name within the parent schema, e.g. "support_agent").
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
parent	string	Resource name of the parent schema. Format: schemas/{catalog}.{schema}. Each {...} component is capped at 255 characters individually.
include_browse	boolean	Whether to include agent services for which the principal can only access selective metadata.
page_size	integer	Maximum number of agent services to return. Defaults to 100 when unset or 0; the maximum is 1000. Use next_page_token to retrieve additional pages.
page_token	string	Opaque pagination token from a previous request.
parent	string	Resource name of the parent schema to list within, as schemas/{catalog}.{schema}. Each {...} component is capped at 255 characters individually.

SELECT examples

list

Lists the agent services in a Unity Catalog schema. Provide parent as

SELECT
name,
metastore_id,
agent_service_type,
browse_only,
comment,
config,
create_time,
created_by,
effective_owner,
etag,
owner,
update_time,
updated_by
FROM databricks_workspace.catalog.ai_gateway_agent_services
WHERE deployment_name = '{{ deployment_name }}' -- required
AND include_browse = '{{ include_browse }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
AND parent = '{{ parent }}'
;

INSERT examples

create

Creates an agent service in a Unity Catalog schema. An agent service is a governed securable that

INSERT INTO databricks_workspace.catalog.ai_gateway_agent_services (
agent_service,
parent,
agent_service_id,
deployment_name
)
SELECT 
'{{ agent_service }}' /* required */,
'{{ parent }}',
'{{ agent_service_id }}',
'{{ deployment_name }}'
RETURNING
name,
metastore_id,
agent_service_type,
browse_only,
comment,
config,
create_time,
created_by,
effective_owner,
etag,
owner,
update_time,
updated_by
;

Manifest

# Description fields are for documentation purposes
- name: ai_gateway_agent_services
props:
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the ai_gateway_agent_services resource.
  - name: agent_service_id
    value: "{{ agent_service_id }}"
    description: Required parameter for the ai_gateway_agent_services resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the ai_gateway_agent_services resource.
  - name: agent_service
    description: |
      The agent service to create. The server populates ``name`` from ``parent`` + ``agent_service_id``; clients should leave it unset.
    value:
      agent_service_type: "{{ agent_service_type }}"
      browse_only: {{ browse_only }}
      comment: "{{ comment }}"
      config:
        base_path: "{{ base_path }}"
        inference_table:
          parent: "{{ parent }}"
          disabled: {{ disabled }}
          is_deleted: {{ is_deleted }}
          table: "{{ table }}"
          table_name_prefix: "{{ table_name_prefix }}"
        model_service: "{{ model_service }}"
        rate_limits:
          - key: "{{ key }}"
            renewal_period: "{{ renewal_period }}"
            principal: "{{ principal }}"
            request_tag_key: "{{ request_tag_key }}"
            request_tag_value: "{{ request_tag_value }}"
            requests: {{ requests }}
            tokens: {{ tokens }}
        source_connection:
          name: "{{ name }}"
          is_deleted: {{ is_deleted }}
        system_prompt: "{{ system_prompt }}"
      create_time: "{{ create_time }}"
      created_by: "{{ created_by }}"
      effective_owner: "{{ effective_owner }}"
      etag: "{{ etag }}"
      metastore_id: "{{ metastore_id }}"
      name: "{{ name }}"
      owner: "{{ owner }}"
      update_time: "{{ update_time }}"
      updated_by: "{{ updated_by }}"