1. Packages
  2. Databricks Provider
  3. API Docs
  4. getDatabaseDatabaseCatalogs
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi

    Private Preview

    Using getDatabaseDatabaseCatalogs

    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 getDatabaseDatabaseCatalogs(args: GetDatabaseDatabaseCatalogsArgs, opts?: InvokeOptions): Promise<GetDatabaseDatabaseCatalogsResult>
    function getDatabaseDatabaseCatalogsOutput(args: GetDatabaseDatabaseCatalogsOutputArgs, opts?: InvokeOptions): Output<GetDatabaseDatabaseCatalogsResult>
    def get_database_database_catalogs(instance_name: Optional[str] = None,
                                       page_size: Optional[int] = None,
                                       provider_config: Optional[GetDatabaseDatabaseCatalogsProviderConfig] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetDatabaseDatabaseCatalogsResult
    def get_database_database_catalogs_output(instance_name: Optional[pulumi.Input[str]] = None,
                                       page_size: Optional[pulumi.Input[int]] = None,
                                       provider_config: Optional[pulumi.Input[GetDatabaseDatabaseCatalogsProviderConfigArgs]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseDatabaseCatalogsResult]
    func GetDatabaseDatabaseCatalogs(ctx *Context, args *GetDatabaseDatabaseCatalogsArgs, opts ...InvokeOption) (*GetDatabaseDatabaseCatalogsResult, error)
    func GetDatabaseDatabaseCatalogsOutput(ctx *Context, args *GetDatabaseDatabaseCatalogsOutputArgs, opts ...InvokeOption) GetDatabaseDatabaseCatalogsResultOutput

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

    public static class GetDatabaseDatabaseCatalogs 
    {
        public static Task<GetDatabaseDatabaseCatalogsResult> InvokeAsync(GetDatabaseDatabaseCatalogsArgs args, InvokeOptions? opts = null)
        public static Output<GetDatabaseDatabaseCatalogsResult> Invoke(GetDatabaseDatabaseCatalogsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDatabaseDatabaseCatalogsResult> getDatabaseDatabaseCatalogs(GetDatabaseDatabaseCatalogsArgs args, InvokeOptions options)
    public static Output<GetDatabaseDatabaseCatalogsResult> getDatabaseDatabaseCatalogs(GetDatabaseDatabaseCatalogsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getDatabaseDatabaseCatalogs:getDatabaseDatabaseCatalogs
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceName string
    Name of the instance to get database catalogs for
    PageSize int
    Upper bound for items returned
    ProviderConfig GetDatabaseDatabaseCatalogsProviderConfig
    Configure the provider for management through account provider.
    InstanceName string
    Name of the instance to get database catalogs for
    PageSize int
    Upper bound for items returned
    ProviderConfig GetDatabaseDatabaseCatalogsProviderConfig
    Configure the provider for management through account provider.
    instanceName String
    Name of the instance to get database catalogs for
    pageSize Integer
    Upper bound for items returned
    providerConfig GetDatabaseDatabaseCatalogsProviderConfig
    Configure the provider for management through account provider.
    instanceName string
    Name of the instance to get database catalogs for
    pageSize number
    Upper bound for items returned
    providerConfig GetDatabaseDatabaseCatalogsProviderConfig
    Configure the provider for management through account provider.
    instance_name str
    Name of the instance to get database catalogs for
    page_size int
    Upper bound for items returned
    provider_config GetDatabaseDatabaseCatalogsProviderConfig
    Configure the provider for management through account provider.
    instanceName String
    Name of the instance to get database catalogs for
    pageSize Number
    Upper bound for items returned
    providerConfig Property Map
    Configure the provider for management through account provider.

    getDatabaseDatabaseCatalogs Result

    The following output properties are available:

    databaseCatalogs List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    instanceName String
    pageSize Number
    providerConfig Property Map

    Supporting Types

    GetDatabaseDatabaseCatalogsDatabaseCatalog

    CreateDatabaseIfNotExists bool
    (boolean)
    DatabaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    DatabaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    Name string
    (string) - The name of the catalog in UC
    Uid string
    (string)
    ProviderConfig GetDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig
    Configure the provider for management through account provider.
    CreateDatabaseIfNotExists bool
    (boolean)
    DatabaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    DatabaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    Name string
    (string) - The name of the catalog in UC
    Uid string
    (string)
    ProviderConfig GetDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig
    Configure the provider for management through account provider.
    createDatabaseIfNotExists Boolean
    (boolean)
    databaseInstanceName String
    (string) - The name of the DatabaseInstance housing the database
    databaseName String
    (string) - The name of the database (in a instance) associated with the catalog
    name String
    (string) - The name of the catalog in UC
    uid String
    (string)
    providerConfig GetDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig
    Configure the provider for management through account provider.
    createDatabaseIfNotExists boolean
    (boolean)
    databaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    databaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    name string
    (string) - The name of the catalog in UC
    uid string
    (string)
    providerConfig GetDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig
    Configure the provider for management through account provider.
    create_database_if_not_exists bool
    (boolean)
    database_instance_name str
    (string) - The name of the DatabaseInstance housing the database
    database_name str
    (string) - The name of the database (in a instance) associated with the catalog
    name str
    (string) - The name of the catalog in UC
    uid str
    (string)
    provider_config GetDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig
    Configure the provider for management through account provider.
    createDatabaseIfNotExists Boolean
    (boolean)
    databaseInstanceName String
    (string) - The name of the DatabaseInstance housing the database
    databaseName String
    (string) - The name of the database (in a instance) associated with the catalog
    name String
    (string) - The name of the catalog in UC
    uid String
    (string)
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig

    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.
    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.

    GetDatabaseDatabaseCatalogsProviderConfig

    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.
    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.90.0
    published on Thursday, Mar 19, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.