1. Packages
  2. Databricks Provider
  3. API Docs
  4. getPostgresDatabases
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getPostgresDatabases

databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Private Preview

    Using getPostgresDatabases

    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 getPostgresDatabases(args: GetPostgresDatabasesArgs, opts?: InvokeOptions): Promise<GetPostgresDatabasesResult>
function getPostgresDatabasesOutput(args: GetPostgresDatabasesOutputArgs, opts?: InvokeOptions): Output<GetPostgresDatabasesResult>
    def get_postgres_databases(page_size: Optional[int] = None,
                           parent: Optional[str] = None,
                           provider_config: Optional[GetPostgresDatabasesProviderConfig] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPostgresDatabasesResult
def get_postgres_databases_output(page_size: Optional[pulumi.Input[int]] = None,
                           parent: Optional[pulumi.Input[str]] = None,
                           provider_config: Optional[pulumi.Input[GetPostgresDatabasesProviderConfigArgs]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPostgresDatabasesResult]
    func GetPostgresDatabases(ctx *Context, args *GetPostgresDatabasesArgs, opts ...InvokeOption) (*GetPostgresDatabasesResult, error)
func GetPostgresDatabasesOutput(ctx *Context, args *GetPostgresDatabasesOutputArgs, opts ...InvokeOption) GetPostgresDatabasesResultOutput

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

    public static class GetPostgresDatabases 
{
    public static Task<GetPostgresDatabasesResult> InvokeAsync(GetPostgresDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresDatabasesResult> Invoke(GetPostgresDatabasesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresDatabasesResult> getPostgresDatabases(GetPostgresDatabasesArgs args, InvokeOptions options)
public static Output<GetPostgresDatabasesResult> getPostgresDatabases(GetPostgresDatabasesArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getPostgresDatabases:getPostgresDatabases
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Parent string
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    PageSize int
    Upper bound for items returned
    ProviderConfig GetPostgresDatabasesProviderConfig
    Configure the provider for management through account provider.
    Parent string
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    PageSize int
    Upper bound for items returned
    ProviderConfig GetPostgresDatabasesProviderConfig
    Configure the provider for management through account provider.
    parent String
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    pageSize Integer
    Upper bound for items returned
    providerConfig GetPostgresDatabasesProviderConfig
    Configure the provider for management through account provider.
    parent string
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    pageSize number
    Upper bound for items returned
    providerConfig GetPostgresDatabasesProviderConfig
    Configure the provider for management through account provider.
    parent str
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    page_size int
    Upper bound for items returned
    provider_config GetPostgresDatabasesProviderConfig
    Configure the provider for management through account provider.
    parent String
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    pageSize Number
    Upper bound for items returned
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresDatabases Result

    The following output properties are available:

    Databases List<GetPostgresDatabasesDatabase>
    Id string
    The provider-assigned unique ID for this managed resource.
    Parent string
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    PageSize int
    ProviderConfig GetPostgresDatabasesProviderConfig
    Databases []GetPostgresDatabasesDatabase
    Id string
    The provider-assigned unique ID for this managed resource.
    Parent string
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    PageSize int
    ProviderConfig GetPostgresDatabasesProviderConfig
    databases List<GetPostgresDatabasesDatabase>
    id String
    The provider-assigned unique ID for this managed resource.
    parent String
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    pageSize Integer
    providerConfig GetPostgresDatabasesProviderConfig
    databases GetPostgresDatabasesDatabase[]
    id string
    The provider-assigned unique ID for this managed resource.
    parent string
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    pageSize number
    providerConfig GetPostgresDatabasesProviderConfig
    databases Sequence[GetPostgresDatabasesDatabase]
    id str
    The provider-assigned unique ID for this managed resource.
    parent str
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    page_size int
    provider_config GetPostgresDatabasesProviderConfig
    databases List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    parent String
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    pageSize Number
    providerConfig Property Map

    Supporting Types

    GetPostgresDatabasesDatabase

    CreateTime string
    (string) - A timestamp indicating when the database was created
    Name string
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    Parent string
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresDatabasesDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    Status GetPostgresDatabasesDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    UpdateTime string
    (string) - A timestamp indicating when the database was last updated
    ProviderConfig GetPostgresDatabasesDatabaseProviderConfig
    Configure the provider for management through account provider.
    CreateTime string
    (string) - A timestamp indicating when the database was created
    Name string
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    Parent string
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresDatabasesDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    Status GetPostgresDatabasesDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    UpdateTime string
    (string) - A timestamp indicating when the database was last updated
    ProviderConfig GetPostgresDatabasesDatabaseProviderConfig
    Configure the provider for management through account provider.
    createTime String
    (string) - A timestamp indicating when the database was created
    name String
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    parent String
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresDatabasesDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    status GetPostgresDatabasesDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    updateTime String
    (string) - A timestamp indicating when the database was last updated
    providerConfig GetPostgresDatabasesDatabaseProviderConfig
    Configure the provider for management through account provider.
    createTime string
    (string) - A timestamp indicating when the database was created
    name string
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    parent string
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresDatabasesDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    status GetPostgresDatabasesDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    updateTime string
    (string) - A timestamp indicating when the database was last updated
    providerConfig GetPostgresDatabasesDatabaseProviderConfig
    Configure the provider for management through account provider.
    create_time str
    (string) - A timestamp indicating when the database was created
    name str
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    parent str
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresDatabasesDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    status GetPostgresDatabasesDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    update_time str
    (string) - A timestamp indicating when the database was last updated
    provider_config GetPostgresDatabasesDatabaseProviderConfig
    Configure the provider for management through account provider.
    createTime String
    (string) - A timestamp indicating when the database was created
    name String
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    parent String
    The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}
    spec Property Map
    (DatabaseDatabaseSpec) - The desired state of the Database
    status Property Map
    (DatabaseDatabaseStatus) - The observed state of the Database
    updateTime String
    (string) - A timestamp indicating when the database was last updated
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetPostgresDatabasesDatabaseProviderConfig

    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.

    GetPostgresDatabasesDatabaseSpec

    PostgresDatabase string
    (string) - The name of the Postgres database
    Role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    PostgresDatabase string
    (string) - The name of the Postgres database
    Role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase String
    (string) - The name of the Postgres database
    role String
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase string
    (string) - The name of the Postgres database
    role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgres_database str
    (string) - The name of the Postgres database
    role str
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase String
    (string) - The name of the Postgres database
    role String
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}

    GetPostgresDatabasesDatabaseStatus

    PostgresDatabase string
    (string) - The name of the Postgres database
    Role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    PostgresDatabase string
    (string) - The name of the Postgres database
    Role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase String
    (string) - The name of the Postgres database
    role String
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase string
    (string) - The name of the Postgres database
    role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgres_database str
    (string) - The name of the Postgres database
    role str
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase String
    (string) - The name of the Postgres database
    role String
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}

    GetPostgresDatabasesProviderConfig

    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
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.