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

databricks.getPostgresRoles

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

    Public Beta

    Using getPostgresRoles

    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 getPostgresRoles(args: GetPostgresRolesArgs, opts?: InvokeOptions): Promise<GetPostgresRolesResult>
function getPostgresRolesOutput(args: GetPostgresRolesOutputArgs, opts?: InvokeOptions): Output<GetPostgresRolesResult>
    def get_postgres_roles(page_size: Optional[int] = None,
                       parent: Optional[str] = None,
                       provider_config: Optional[GetPostgresRolesProviderConfig] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPostgresRolesResult
def get_postgres_roles_output(page_size: Optional[pulumi.Input[int]] = None,
                       parent: Optional[pulumi.Input[str]] = None,
                       provider_config: Optional[pulumi.Input[GetPostgresRolesProviderConfigArgs]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPostgresRolesResult]
    func GetPostgresRoles(ctx *Context, args *GetPostgresRolesArgs, opts ...InvokeOption) (*GetPostgresRolesResult, error)
func GetPostgresRolesOutput(ctx *Context, args *GetPostgresRolesOutputArgs, opts ...InvokeOption) GetPostgresRolesResultOutput

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

    public static class GetPostgresRoles 
{
    public static Task<GetPostgresRolesResult> InvokeAsync(GetPostgresRolesArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresRolesResult> Invoke(GetPostgresRolesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresRolesResult> getPostgresRoles(GetPostgresRolesArgs args, InvokeOptions options)
public static Output<GetPostgresRolesResult> getPostgresRoles(GetPostgresRolesArgs args, InvokeOptions options)

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

    The following arguments are supported:

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

    getPostgresRoles Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Parent string
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    Roles List<GetPostgresRolesRole>
    PageSize int
    ProviderConfig GetPostgresRolesProviderConfig
    Id string
    The provider-assigned unique ID for this managed resource.
    Parent string
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    Roles []GetPostgresRolesRole
    PageSize int
    ProviderConfig GetPostgresRolesProviderConfig
    id String
    The provider-assigned unique ID for this managed resource.
    parent String
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    roles List<GetPostgresRolesRole>
    pageSize Integer
    providerConfig GetPostgresRolesProviderConfig
    id string
    The provider-assigned unique ID for this managed resource.
    parent string
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    roles GetPostgresRolesRole[]
    pageSize number
    providerConfig GetPostgresRolesProviderConfig
    id str
    The provider-assigned unique ID for this managed resource.
    parent str
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    roles Sequence[GetPostgresRolesRole]
    page_size int
    provider_config GetPostgresRolesProviderConfig
    id String
    The provider-assigned unique ID for this managed resource.
    parent String
    (string) - The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}
    roles List<Property Map>
    pageSize Number
    providerConfig Property Map

    Supporting Types

    GetPostgresRolesProviderConfig

    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.

    GetPostgresRolesRole

    CreateTime string
    (string)
    Name string
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    Parent string
    The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresRolesRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    Status GetPostgresRolesRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    UpdateTime string
    (string)
    ProviderConfig GetPostgresRolesRoleProviderConfig
    Configure the provider for management through account provider.
    CreateTime string
    (string)
    Name string
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    Parent string
    The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresRolesRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    Status GetPostgresRolesRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    UpdateTime string
    (string)
    ProviderConfig GetPostgresRolesRoleProviderConfig
    Configure the provider for management through account provider.
    createTime String
    (string)
    name String
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent String
    The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresRolesRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    status GetPostgresRolesRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    updateTime String
    (string)
    providerConfig GetPostgresRolesRoleProviderConfig
    Configure the provider for management through account provider.
    createTime string
    (string)
    name string
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent string
    The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresRolesRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    status GetPostgresRolesRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    updateTime string
    (string)
    providerConfig GetPostgresRolesRoleProviderConfig
    Configure the provider for management through account provider.
    create_time str
    (string)
    name str
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent str
    The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresRolesRoleSpec
    (RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes
    status GetPostgresRolesRoleStatus
    (RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes
    update_time str
    (string)
    provider_config GetPostgresRolesRoleProviderConfig
    Configure the provider for management through account provider.
    createTime String
    (string)
    name String
    (string) - Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    parent String
    The Branch that owns this collection of roles. 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
    Configure the provider for management through account provider.

    GetPostgresRolesRoleProviderConfig

    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.

    GetPostgresRolesRoleSpec

    Attributes GetPostgresRolesRoleSpecAttributes
    (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 GetPostgresRolesRoleSpecAttributes
    (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 GetPostgresRolesRoleSpecAttributes
    (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 GetPostgresRolesRoleSpecAttributes
    (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 GetPostgresRolesRoleSpecAttributes
    (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

    GetPostgresRolesRoleSpecAttributes

    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)

    GetPostgresRolesRoleStatus

    Attributes GetPostgresRolesRoleStatusAttributes
    (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 GetPostgresRolesRoleStatusAttributes
    (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 GetPostgresRolesRoleStatusAttributes
    (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 GetPostgresRolesRoleStatusAttributes
    (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 GetPostgresRolesRoleStatusAttributes
    (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

    GetPostgresRolesRoleStatusAttributes

    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.90.0
    published on Thursday, Mar 19, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.