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

databricks.getPostgresRole

databricks logo
Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    This data source retrieves a single Postgres role.

    Example Usage

    Retrieve Role by Name

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const _this = databricks.getPostgresRole({
    name: "projects/my-project/branches/main/roles/jane",
});
export const rolePostgresName = _this.then(_this => _this.status?.postgresRole);
export const roleIdentityType = _this.then(_this => _this.status?.identityType);
export const roleAuthMethod = _this.then(_this => _this.status?.authMethod);

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_postgres_role(name="projects/my-project/branches/main/roles/jane")
pulumi.export("rolePostgresName", this.status.postgres_role)
pulumi.export("roleIdentityType", this.status.identity_type)
pulumi.export("roleAuthMethod", this.status.auth_method)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := databricks.GetPostgresRole(ctx, &databricks.LookupPostgresRoleArgs{
			Name: "projects/my-project/branches/main/roles/jane",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("rolePostgresName", this.Status.PostgresRole)
		ctx.Export("roleIdentityType", this.Status.IdentityType)
		ctx.Export("roleAuthMethod", this.Status.AuthMethod)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetPostgresRole.Invoke(new()
    {
        Name = "projects/my-project/branches/main/roles/jane",
    });

    return new Dictionary<string, object?>
    {
        ["rolePostgresName"] = @this.Apply(@this => @this.Apply(getPostgresRoleResult => getPostgresRoleResult.Status?.PostgresRole)),
        ["roleIdentityType"] = @this.Apply(@this => @this.Apply(getPostgresRoleResult => getPostgresRoleResult.Status?.IdentityType)),
        ["roleAuthMethod"] = @this.Apply(@this => @this.Apply(getPostgresRoleResult => getPostgresRoleResult.Status?.AuthMethod)),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetPostgresRoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var this = DatabricksFunctions.getPostgresRole(GetPostgresRoleArgs.builder()
            .name("projects/my-project/branches/main/roles/jane")
            .build());

        ctx.export("rolePostgresName", this_.status().postgresRole());
        ctx.export("roleIdentityType", this_.status().identityType());
        ctx.export("roleAuthMethod", this_.status().authMethod());
    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getPostgresRole
      arguments:
        name: projects/my-project/branches/main/roles/jane
outputs:
  rolePostgresName: ${this.status.postgresRole}
  roleIdentityType: ${this.status.identityType}
  roleAuthMethod: ${this.status.authMethod}

    Example coming soon!

    Using getPostgresRole

    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 getPostgresRole(args: GetPostgresRoleArgs, opts?: InvokeOptions): Promise<GetPostgresRoleResult>
function getPostgresRoleOutput(args: GetPostgresRoleOutputArgs, opts?: InvokeOptions): Output<GetPostgresRoleResult>
    def get_postgres_role(name: Optional[str] = None,
                      provider_config: Optional[GetPostgresRoleProviderConfig] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPostgresRoleResult
def get_postgres_role_output(name: pulumi.Input[Optional[str]] = None,
                      provider_config: pulumi.Input[Optional[GetPostgresRoleProviderConfigArgs]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPostgresRoleResult]
    func LookupPostgresRole(ctx *Context, args *LookupPostgresRoleArgs, opts ...InvokeOption) (*LookupPostgresRoleResult, error)
func LookupPostgresRoleOutput(ctx *Context, args *LookupPostgresRoleOutputArgs, opts ...InvokeOption) LookupPostgresRoleResultOutput

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

    public static class GetPostgresRole 
{
    public static Task<GetPostgresRoleResult> InvokeAsync(GetPostgresRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresRoleResult> Invoke(GetPostgresRoleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresRoleResult> getPostgresRole(GetPostgresRoleArgs args, InvokeOptions options)
public static Output<GetPostgresRoleResult> getPostgresRole(GetPostgresRoleArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getPostgresRole:getPostgresRole
  arguments:
    # arguments dictionary
    data "databricks_getpostgresrole" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    ProviderConfig GetPostgresRoleProviderConfig
    Configure the provider for management through account provider.
    Name string
    Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    ProviderConfig GetPostgresRoleProviderConfig
    Configure the provider for management through account provider.
    name string
    Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    provider_config object
    Configure the provider for management through account provider.
    name String
    Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    providerConfig GetPostgresRoleProviderConfig
    Configure the provider for management through account provider.
    name string
    Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    providerConfig GetPostgresRoleProviderConfig
    Configure the provider for management through account provider.
    name str
    Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    provider_config GetPostgresRoleProviderConfig
    Configure the provider for management through account provider.
    name String
    Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresRole Result

    The following output properties are available:

    CreateTime string
    (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    Parent string
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    Status GetPostgresRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    UpdateTime string
    (string)
    ProviderConfig GetPostgresRoleProviderConfig
    CreateTime string
    (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    Parent string
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    Status GetPostgresRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    UpdateTime string
    (string)
    ProviderConfig GetPostgresRoleProviderConfig
    create_time string
    (string)
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent string
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    spec object
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    status object
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    update_time string
    (string)
    provider_config object
    createTime String
    (string)
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent String
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    status GetPostgresRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    updateTime String
    (string)
    providerConfig GetPostgresRoleProviderConfig
    createTime string
    (string)
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent string
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    status GetPostgresRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    updateTime string
    (string)
    providerConfig GetPostgresRoleProviderConfig
    create_time str
    (string)
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent str
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    status GetPostgresRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    update_time str
    (string)
    provider_config GetPostgresRoleProviderConfig
    createTime String
    (string)
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent String
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    spec Property Map
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    status Property Map
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    updateTime String
    (string)
    providerConfig Property Map

    Supporting Types

    GetPostgresRoleProviderConfig

    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.

    GetPostgresRoleSpec

    Attributes GetPostgresRoleSpecAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    AuthMethod string
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    IdentityType string
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    MembershipRoles List<string>
    (list of string) - An enum value for a standard role that this role is a member of
    PostgresRole string
    (string) - The name of the Postgres role
    Attributes GetPostgresRoleSpecAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    AuthMethod string
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    IdentityType string
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    MembershipRoles []string
    (list of string) - An enum value for a standard role that this role is a member of
    PostgresRole string
    (string) - The name of the Postgres role
    attributes object
    (RoleAttributes) - The PG role attributes associated with the role
    auth_method string
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identity_type string
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membership_roles list(string)
    (list of string) - An enum value for a standard role that this role is a member of
    postgres_role string
    (string) - The name of the Postgres role
    attributes GetPostgresRoleSpecAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    authMethod String
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identityType String
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membershipRoles List<String>
    (list of string) - An enum value for a standard role that this role is a member of
    postgresRole String
    (string) - The name of the Postgres role
    attributes GetPostgresRoleSpecAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    authMethod string
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identityType string
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membershipRoles string[]
    (list of string) - An enum value for a standard role that this role is a member of
    postgresRole string
    (string) - The name of the Postgres role
    attributes GetPostgresRoleSpecAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    auth_method str
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identity_type str
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membership_roles Sequence[str]
    (list of string) - An enum value for a standard role that this role is a member of
    postgres_role str
    (string) - The name of the Postgres role
    attributes Property Map
    (RoleAttributes) - The PG role attributes associated with the role
    authMethod String
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identityType String
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membershipRoles List<String>
    (list of string) - An enum value for a standard role that this role is a member of
    postgresRole String
    (string) - The name of the Postgres role

    GetPostgresRoleSpecAttributes

    Bypassrls bool
    (boolean)
    Createdb bool
    (boolean)
    Createrole bool
    (boolean)
    Bypassrls bool
    (boolean)
    Createdb bool
    (boolean)
    Createrole bool
    (boolean)
    bypassrls bool
    (boolean)
    createdb bool
    (boolean)
    createrole bool
    (boolean)
    bypassrls Boolean
    (boolean)
    createdb Boolean
    (boolean)
    createrole Boolean
    (boolean)
    bypassrls boolean
    (boolean)
    createdb boolean
    (boolean)
    createrole boolean
    (boolean)
    bypassrls bool
    (boolean)
    createdb bool
    (boolean)
    createrole bool
    (boolean)
    bypassrls Boolean
    (boolean)
    createdb Boolean
    (boolean)
    createrole Boolean
    (boolean)

    GetPostgresRoleStatus

    RoleId string
    (string) - The short identifier of the role, suitable for showing to the users. For a role with name projects/my-project/branches/my-branch/roles/my-role, the roleId is my-role.
    Attributes GetPostgresRoleStatusAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    AuthMethod string
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    IdentityType string
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    MembershipRoles List<string>
    (list of string) - An enum value for a standard role that this role is a member of
    PostgresRole string
    (string) - The name of the Postgres role
    RoleId string
    (string) - The short identifier of the role, suitable for showing to the users. For a role with name projects/my-project/branches/my-branch/roles/my-role, the roleId is my-role.
    Attributes GetPostgresRoleStatusAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    AuthMethod string
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    IdentityType string
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    MembershipRoles []string
    (list of string) - An enum value for a standard role that this role is a member of
    PostgresRole string
    (string) - The name of the Postgres role
    role_id string
    (string) - The short identifier of the role, suitable for showing to the users. For a role with name projects/my-project/branches/my-branch/roles/my-role, the roleId is my-role.
    attributes object
    (RoleAttributes) - The PG role attributes associated with the role
    auth_method string
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identity_type string
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membership_roles list(string)
    (list of string) - An enum value for a standard role that this role is a member of
    postgres_role string
    (string) - The name of the Postgres role
    roleId String
    (string) - The short identifier of the role, suitable for showing to the users. For a role with name projects/my-project/branches/my-branch/roles/my-role, the roleId is my-role.
    attributes GetPostgresRoleStatusAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    authMethod String
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identityType String
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membershipRoles List<String>
    (list of string) - An enum value for a standard role that this role is a member of
    postgresRole String
    (string) - The name of the Postgres role
    roleId string
    (string) - The short identifier of the role, suitable for showing to the users. For a role with name projects/my-project/branches/my-branch/roles/my-role, the roleId is my-role.
    attributes GetPostgresRoleStatusAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    authMethod string
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identityType string
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membershipRoles string[]
    (list of string) - An enum value for a standard role that this role is a member of
    postgresRole string
    (string) - The name of the Postgres role
    role_id str
    (string) - The short identifier of the role, suitable for showing to the users. For a role with name projects/my-project/branches/my-branch/roles/my-role, the roleId is my-role.
    attributes GetPostgresRoleStatusAttributes
    (RoleAttributes) - The PG role attributes associated with the role
    auth_method str
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identity_type str
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membership_roles Sequence[str]
    (list of string) - An enum value for a standard role that this role is a member of
    postgres_role str
    (string) - The name of the Postgres role
    roleId String
    (string) - The short identifier of the role, suitable for showing to the users. For a role with name projects/my-project/branches/my-branch/roles/my-role, the roleId is my-role.
    attributes Property Map
    (RoleAttributes) - The PG role attributes associated with the role
    authMethod String
    (string) - Possible values are: LAKEBASE_OAUTH_V1, NO_LOGIN, PG_PASSWORD_SCRAM_SHA_256
    identityType String
    (string) - The type of the role. Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    membershipRoles List<String>
    (list of string) - An enum value for a standard role that this role is a member of
    postgresRole String
    (string) - The name of the Postgres role

    GetPostgresRoleStatusAttributes

    Bypassrls bool
    (boolean)
    Createdb bool
    (boolean)
    Createrole bool
    (boolean)
    Bypassrls bool
    (boolean)
    Createdb bool
    (boolean)
    Createrole bool
    (boolean)
    bypassrls bool
    (boolean)
    createdb bool
    (boolean)
    createrole bool
    (boolean)
    bypassrls Boolean
    (boolean)
    createdb Boolean
    (boolean)
    createrole Boolean
    (boolean)
    bypassrls boolean
    (boolean)
    createdb boolean
    (boolean)
    createrole boolean
    (boolean)
    bypassrls bool
    (boolean)
    createdb bool
    (boolean)
    createrole bool
    (boolean)
    bypassrls Boolean
    (boolean)
    createdb Boolean
    (boolean)
    createrole Boolean
    (boolean)

    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.