1. Packages
  2. Databricks Provider
  3. API Docs
  4. getPolicyInfos
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi

databricks.getPolicyInfos

Explore with Pulumi AI

databricks logo
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi

    Using getPolicyInfos

    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 getPolicyInfos(opts?: InvokeOptions): Promise<GetPolicyInfosResult>
    function getPolicyInfosOutput(opts?: InvokeOptions): Output<GetPolicyInfosResult>
    def get_policy_infos(opts: Optional[InvokeOptions] = None) -> GetPolicyInfosResult
    def get_policy_infos_output(opts: Optional[InvokeOptions] = None) -> Output[GetPolicyInfosResult]
    func GetPolicyInfos(ctx *Context, opts ...InvokeOption) (*GetPolicyInfosResult, error)
    func GetPolicyInfosOutput(ctx *Context, opts ...InvokeOption) GetPolicyInfosResultOutput

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

    public static class GetPolicyInfos 
    {
        public static Task<GetPolicyInfosResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetPolicyInfosResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyInfosResult> getPolicyInfos(InvokeOptions options)
    public static Output<GetPolicyInfosResult> getPolicyInfos(InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getPolicyInfos:getPolicyInfos
      arguments:
        # arguments dictionary

    getPolicyInfos Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Policies List<GetPolicyInfosPolicy>
    Id string
    The provider-assigned unique ID for this managed resource.
    Policies []GetPolicyInfosPolicy
    id String
    The provider-assigned unique ID for this managed resource.
    policies List<GetPolicyInfosPolicy>
    id string
    The provider-assigned unique ID for this managed resource.
    policies GetPolicyInfosPolicy[]
    id str
    The provider-assigned unique ID for this managed resource.
    policies Sequence[GetPolicyInfosPolicy]
    id String
    The provider-assigned unique ID for this managed resource.
    policies List<Property Map>

    Supporting Types

    GetPolicyInfosPolicy

    CreatedAt int
    (integer) - Time at which the policy was created, in epoch milliseconds. Output only
    CreatedBy string
    (string) - Username of the user who created the policy. Output only
    ForSecurableType string
    (string) - Type of securables that the policy should take effect on. Only table is supported at this moment. Required on create and optional on update. Possible values are: CATALOG, CLEAN_ROOM, CONNECTION, CREDENTIAL, EXTERNAL_LOCATION, EXTERNAL_METADATA, FUNCTION, METASTORE, PIPELINE, PROVIDER, RECIPIENT, SCHEMA, SHARE, STAGING_TABLE, STORAGE_CREDENTIAL, TABLE, VOLUME
    Id string
    (string) - Unique identifier of the policy. This field is output only and is generated by the system
    PolicyType string
    (string) - Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    ToPrincipals List<string>
    (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
    UpdatedAt int
    (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
    UpdatedBy string
    (string) - Username of the user who last modified the policy. Output only
    ColumnMask GetPolicyInfosPolicyColumnMask
    (ColumnMaskOptions) - Options for column mask policies. Valid only if policy_type is POLICY_TYPE_COLUMN_MASK. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    Comment string
    (string) - Optional description of the policy
    ExceptPrincipals List<string>
    (list of string) - Optional list of user or group names that should be excluded from the policy
    MatchColumns List<GetPolicyInfosPolicyMatchColumn>
    (list of MatchColumn) - Optional list of condition expressions used to match table columns. Only valid when for_securable_type is table. When specified, the policy only applies to tables whose columns satisfy all match conditions
    Name string
    (string) - Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    OnSecurableFullname string
    Required. The fully qualified name of securable to list policies for
    OnSecurableType string
    Required. The type of the securable to list policies for
    RowFilter GetPolicyInfosPolicyRowFilter
    (RowFilterOptions) - Options for row filter policies. Valid only if policy_type is POLICY_TYPE_ROW_FILTER. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    WhenCondition string
    (string) - Optional condition when the policy should take effect
    CreatedAt int
    (integer) - Time at which the policy was created, in epoch milliseconds. Output only
    CreatedBy string
    (string) - Username of the user who created the policy. Output only
    ForSecurableType string
    (string) - Type of securables that the policy should take effect on. Only table is supported at this moment. Required on create and optional on update. Possible values are: CATALOG, CLEAN_ROOM, CONNECTION, CREDENTIAL, EXTERNAL_LOCATION, EXTERNAL_METADATA, FUNCTION, METASTORE, PIPELINE, PROVIDER, RECIPIENT, SCHEMA, SHARE, STAGING_TABLE, STORAGE_CREDENTIAL, TABLE, VOLUME
    Id string
    (string) - Unique identifier of the policy. This field is output only and is generated by the system
    PolicyType string
    (string) - Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    ToPrincipals []string
    (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
    UpdatedAt int
    (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
    UpdatedBy string
    (string) - Username of the user who last modified the policy. Output only
    ColumnMask GetPolicyInfosPolicyColumnMask
    (ColumnMaskOptions) - Options for column mask policies. Valid only if policy_type is POLICY_TYPE_COLUMN_MASK. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    Comment string
    (string) - Optional description of the policy
    ExceptPrincipals []string
    (list of string) - Optional list of user or group names that should be excluded from the policy
    MatchColumns []GetPolicyInfosPolicyMatchColumn
    (list of MatchColumn) - Optional list of condition expressions used to match table columns. Only valid when for_securable_type is table. When specified, the policy only applies to tables whose columns satisfy all match conditions
    Name string
    (string) - Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    OnSecurableFullname string
    Required. The fully qualified name of securable to list policies for
    OnSecurableType string
    Required. The type of the securable to list policies for
    RowFilter GetPolicyInfosPolicyRowFilter
    (RowFilterOptions) - Options for row filter policies. Valid only if policy_type is POLICY_TYPE_ROW_FILTER. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    WhenCondition string
    (string) - Optional condition when the policy should take effect
    createdAt Integer
    (integer) - Time at which the policy was created, in epoch milliseconds. Output only
    createdBy String
    (string) - Username of the user who created the policy. Output only
    forSecurableType String
    (string) - Type of securables that the policy should take effect on. Only table is supported at this moment. Required on create and optional on update. Possible values are: CATALOG, CLEAN_ROOM, CONNECTION, CREDENTIAL, EXTERNAL_LOCATION, EXTERNAL_METADATA, FUNCTION, METASTORE, PIPELINE, PROVIDER, RECIPIENT, SCHEMA, SHARE, STAGING_TABLE, STORAGE_CREDENTIAL, TABLE, VOLUME
    id String
    (string) - Unique identifier of the policy. This field is output only and is generated by the system
    policyType String
    (string) - Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    toPrincipals List<String>
    (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
    updatedAt Integer
    (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
    updatedBy String
    (string) - Username of the user who last modified the policy. Output only
    columnMask GetPolicyInfosPolicyColumnMask
    (ColumnMaskOptions) - Options for column mask policies. Valid only if policy_type is POLICY_TYPE_COLUMN_MASK. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    comment String
    (string) - Optional description of the policy
    exceptPrincipals List<String>
    (list of string) - Optional list of user or group names that should be excluded from the policy
    matchColumns List<GetPolicyInfosPolicyMatchColumn>
    (list of MatchColumn) - Optional list of condition expressions used to match table columns. Only valid when for_securable_type is table. When specified, the policy only applies to tables whose columns satisfy all match conditions
    name String
    (string) - Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname String
    Required. The fully qualified name of securable to list policies for
    onSecurableType String
    Required. The type of the securable to list policies for
    rowFilter GetPolicyInfosPolicyRowFilter
    (RowFilterOptions) - Options for row filter policies. Valid only if policy_type is POLICY_TYPE_ROW_FILTER. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    whenCondition String
    (string) - Optional condition when the policy should take effect
    createdAt number
    (integer) - Time at which the policy was created, in epoch milliseconds. Output only
    createdBy string
    (string) - Username of the user who created the policy. Output only
    forSecurableType string
    (string) - Type of securables that the policy should take effect on. Only table is supported at this moment. Required on create and optional on update. Possible values are: CATALOG, CLEAN_ROOM, CONNECTION, CREDENTIAL, EXTERNAL_LOCATION, EXTERNAL_METADATA, FUNCTION, METASTORE, PIPELINE, PROVIDER, RECIPIENT, SCHEMA, SHARE, STAGING_TABLE, STORAGE_CREDENTIAL, TABLE, VOLUME
    id string
    (string) - Unique identifier of the policy. This field is output only and is generated by the system
    policyType string
    (string) - Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    toPrincipals string[]
    (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
    updatedAt number
    (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
    updatedBy string
    (string) - Username of the user who last modified the policy. Output only
    columnMask GetPolicyInfosPolicyColumnMask
    (ColumnMaskOptions) - Options for column mask policies. Valid only if policy_type is POLICY_TYPE_COLUMN_MASK. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    comment string
    (string) - Optional description of the policy
    exceptPrincipals string[]
    (list of string) - Optional list of user or group names that should be excluded from the policy
    matchColumns GetPolicyInfosPolicyMatchColumn[]
    (list of MatchColumn) - Optional list of condition expressions used to match table columns. Only valid when for_securable_type is table. When specified, the policy only applies to tables whose columns satisfy all match conditions
    name string
    (string) - Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname string
    Required. The fully qualified name of securable to list policies for
    onSecurableType string
    Required. The type of the securable to list policies for
    rowFilter GetPolicyInfosPolicyRowFilter
    (RowFilterOptions) - Options for row filter policies. Valid only if policy_type is POLICY_TYPE_ROW_FILTER. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    whenCondition string
    (string) - Optional condition when the policy should take effect
    created_at int
    (integer) - Time at which the policy was created, in epoch milliseconds. Output only
    created_by str
    (string) - Username of the user who created the policy. Output only
    for_securable_type str
    (string) - Type of securables that the policy should take effect on. Only table is supported at this moment. Required on create and optional on update. Possible values are: CATALOG, CLEAN_ROOM, CONNECTION, CREDENTIAL, EXTERNAL_LOCATION, EXTERNAL_METADATA, FUNCTION, METASTORE, PIPELINE, PROVIDER, RECIPIENT, SCHEMA, SHARE, STAGING_TABLE, STORAGE_CREDENTIAL, TABLE, VOLUME
    id str
    (string) - Unique identifier of the policy. This field is output only and is generated by the system
    policy_type str
    (string) - Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    to_principals Sequence[str]
    (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
    updated_at int
    (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
    updated_by str
    (string) - Username of the user who last modified the policy. Output only
    column_mask GetPolicyInfosPolicyColumnMask
    (ColumnMaskOptions) - Options for column mask policies. Valid only if policy_type is POLICY_TYPE_COLUMN_MASK. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    comment str
    (string) - Optional description of the policy
    except_principals Sequence[str]
    (list of string) - Optional list of user or group names that should be excluded from the policy
    match_columns Sequence[GetPolicyInfosPolicyMatchColumn]
    (list of MatchColumn) - Optional list of condition expressions used to match table columns. Only valid when for_securable_type is table. When specified, the policy only applies to tables whose columns satisfy all match conditions
    name str
    (string) - Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    on_securable_fullname str
    Required. The fully qualified name of securable to list policies for
    on_securable_type str
    Required. The type of the securable to list policies for
    row_filter GetPolicyInfosPolicyRowFilter
    (RowFilterOptions) - Options for row filter policies. Valid only if policy_type is POLICY_TYPE_ROW_FILTER. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    when_condition str
    (string) - Optional condition when the policy should take effect
    createdAt Number
    (integer) - Time at which the policy was created, in epoch milliseconds. Output only
    createdBy String
    (string) - Username of the user who created the policy. Output only
    forSecurableType String
    (string) - Type of securables that the policy should take effect on. Only table is supported at this moment. Required on create and optional on update. Possible values are: CATALOG, CLEAN_ROOM, CONNECTION, CREDENTIAL, EXTERNAL_LOCATION, EXTERNAL_METADATA, FUNCTION, METASTORE, PIPELINE, PROVIDER, RECIPIENT, SCHEMA, SHARE, STAGING_TABLE, STORAGE_CREDENTIAL, TABLE, VOLUME
    id String
    (string) - Unique identifier of the policy. This field is output only and is generated by the system
    policyType String
    (string) - Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    toPrincipals List<String>
    (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
    updatedAt Number
    (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
    updatedBy String
    (string) - Username of the user who last modified the policy. Output only
    columnMask Property Map
    (ColumnMaskOptions) - Options for column mask policies. Valid only if policy_type is POLICY_TYPE_COLUMN_MASK. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    comment String
    (string) - Optional description of the policy
    exceptPrincipals List<String>
    (list of string) - Optional list of user or group names that should be excluded from the policy
    matchColumns List<Property Map>
    (list of MatchColumn) - Optional list of condition expressions used to match table columns. Only valid when for_securable_type is table. When specified, the policy only applies to tables whose columns satisfy all match conditions
    name String
    (string) - Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname String
    Required. The fully qualified name of securable to list policies for
    onSecurableType String
    Required. The type of the securable to list policies for
    rowFilter Property Map
    (RowFilterOptions) - Options for row filter policies. Valid only if policy_type is POLICY_TYPE_ROW_FILTER. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole
    whenCondition String
    (string) - Optional condition when the policy should take effect

    GetPolicyInfosPolicyColumnMask

    FunctionName string
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    OnColumn string
    (string) - The alias of the column to be masked. The alias must refer to one of matched columns. The values of the column is passed to the column mask function as the first argument. Required on create and update
    Usings List<GetPolicyInfosPolicyColumnMaskUsing>
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    FunctionName string
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    OnColumn string
    (string) - The alias of the column to be masked. The alias must refer to one of matched columns. The values of the column is passed to the column mask function as the first argument. Required on create and update
    Usings []GetPolicyInfosPolicyColumnMaskUsing
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    functionName String
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    onColumn String
    (string) - The alias of the column to be masked. The alias must refer to one of matched columns. The values of the column is passed to the column mask function as the first argument. Required on create and update
    usings List<GetPolicyInfosPolicyColumnMaskUsing>
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    functionName string
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    onColumn string
    (string) - The alias of the column to be masked. The alias must refer to one of matched columns. The values of the column is passed to the column mask function as the first argument. Required on create and update
    usings GetPolicyInfosPolicyColumnMaskUsing[]
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    function_name str
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    on_column str
    (string) - The alias of the column to be masked. The alias must refer to one of matched columns. The values of the column is passed to the column mask function as the first argument. Required on create and update
    usings Sequence[GetPolicyInfosPolicyColumnMaskUsing]
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    functionName String
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    onColumn String
    (string) - The alias of the column to be masked. The alias must refer to one of matched columns. The values of the column is passed to the column mask function as the first argument. Required on create and update
    usings List<Property Map>
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function

    GetPolicyInfosPolicyColumnMaskUsing

    Alias string
    (string) - Optional alias of the matched column
    Constant string
    (string) - A constant literal
    Alias string
    (string) - Optional alias of the matched column
    Constant string
    (string) - A constant literal
    alias String
    (string) - Optional alias of the matched column
    constant String
    (string) - A constant literal
    alias string
    (string) - Optional alias of the matched column
    constant string
    (string) - A constant literal
    alias str
    (string) - Optional alias of the matched column
    constant str
    (string) - A constant literal
    alias String
    (string) - Optional alias of the matched column
    constant String
    (string) - A constant literal

    GetPolicyInfosPolicyMatchColumn

    Alias string
    (string) - Optional alias of the matched column
    Condition string
    (string) - The condition expression used to match a table column
    Alias string
    (string) - Optional alias of the matched column
    Condition string
    (string) - The condition expression used to match a table column
    alias String
    (string) - Optional alias of the matched column
    condition String
    (string) - The condition expression used to match a table column
    alias string
    (string) - Optional alias of the matched column
    condition string
    (string) - The condition expression used to match a table column
    alias str
    (string) - Optional alias of the matched column
    condition str
    (string) - The condition expression used to match a table column
    alias String
    (string) - Optional alias of the matched column
    condition String
    (string) - The condition expression used to match a table column

    GetPolicyInfosPolicyRowFilter

    FunctionName string
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    Usings List<GetPolicyInfosPolicyRowFilterUsing>
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    FunctionName string
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    Usings []GetPolicyInfosPolicyRowFilterUsing
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    functionName String
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    usings List<GetPolicyInfosPolicyRowFilterUsing>
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    functionName string
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    usings GetPolicyInfosPolicyRowFilterUsing[]
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    function_name str
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    usings Sequence[GetPolicyInfosPolicyRowFilterUsing]
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function
    functionName String
    (string) - The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update
    usings List<Property Map>
    (list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function

    GetPolicyInfosPolicyRowFilterUsing

    Alias string
    (string) - Optional alias of the matched column
    Constant string
    (string) - A constant literal
    Alias string
    (string) - Optional alias of the matched column
    Constant string
    (string) - A constant literal
    alias String
    (string) - Optional alias of the matched column
    constant String
    (string) - A constant literal
    alias string
    (string) - Optional alias of the matched column
    constant string
    (string) - A constant literal
    alias str
    (string) - Optional alias of the matched column
    constant str
    (string) - A constant literal
    alias String
    (string) - Optional alias of the matched column
    constant String
    (string) - A constant literal

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi