Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
databricks.getPolicyInfos
Explore with Pulumi AI
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<Get
Policy Infos Policy>
- Id string
- The provider-assigned unique ID for this managed resource.
- Policies
[]Get
Policy Infos Policy
- id String
- The provider-assigned unique ID for this managed resource.
- policies
List<Get
Policy Infos Policy>
- id string
- The provider-assigned unique ID for this managed resource.
- policies
Get
Policy Infos Policy[]
- id str
- The provider-assigned unique ID for this managed resource.
- policies
Sequence[Get
Policy Infos Policy]
- id String
- The provider-assigned unique ID for this managed resource.
- policies List<Property Map>
Supporting Types
GetPolicyInfosPolicy
- Created
At int - (integer) - Time at which the policy was created, in epoch milliseconds. Output only
- Created
By string - (string) - Username of the user who created the policy. Output only
- For
Securable stringType - (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
- Policy
Type string - (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 List<string> - (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 string - (string) - Username of the user who last modified the policy. Output only
- Column
Mask GetPolicy Infos Policy Column Mask - (ColumnMaskOptions) - Options for column mask policies. Valid only if
policy_type
isPOLICY_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
- Except
Principals List<string> - (list of string) - Optional list of user or group names that should be excluded from the policy
- Match
Columns List<GetPolicy Infos Policy Match Column> - (list of MatchColumn) - Optional list of condition expressions used to match table columns.
Only valid when
for_securable_type
istable
. 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 - On
Securable stringFullname - Required. The fully qualified name of securable to list policies for
- On
Securable stringType - Required. The type of the securable to list policies for
- Row
Filter GetPolicy Infos Policy Row Filter - (RowFilterOptions) - Options for row filter policies. Valid only if
policy_type
isPOLICY_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 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 string - (string) - Username of the user who created the policy. Output only
- For
Securable stringType - (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
- Policy
Type string - (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 []string - (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 string - (string) - Username of the user who last modified the policy. Output only
- Column
Mask GetPolicy Infos Policy Column Mask - (ColumnMaskOptions) - Options for column mask policies. Valid only if
policy_type
isPOLICY_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
- Except
Principals []string - (list of string) - Optional list of user or group names that should be excluded from the policy
- Match
Columns []GetPolicy Infos Policy Match Column - (list of MatchColumn) - Optional list of condition expressions used to match table columns.
Only valid when
for_securable_type
istable
. 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 - On
Securable stringFullname - Required. The fully qualified name of securable to list policies for
- On
Securable stringType - Required. The type of the securable to list policies for
- Row
Filter GetPolicy Infos Policy Row Filter - (RowFilterOptions) - Options for row filter policies. Valid only if
policy_type
isPOLICY_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 string - (string) - Optional condition when the policy should take effect
- created
At Integer - (integer) - Time at which the policy was created, in epoch milliseconds. Output only
- created
By String - (string) - Username of the user who created the policy. Output only
- for
Securable StringType - (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
- policy
Type String - (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 List<String> - (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
- updated
At Integer - (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
- updated
By String - (string) - Username of the user who last modified the policy. Output only
- column
Mask GetPolicy Infos Policy Column Mask - (ColumnMaskOptions) - Options for column mask policies. Valid only if
policy_type
isPOLICY_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
- except
Principals List<String> - (list of string) - Optional list of user or group names that should be excluded from the policy
- match
Columns List<GetPolicy Infos Policy Match Column> - (list of MatchColumn) - Optional list of condition expressions used to match table columns.
Only valid when
for_securable_type
istable
. 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 - on
Securable StringFullname - Required. The fully qualified name of securable to list policies for
- on
Securable StringType - Required. The type of the securable to list policies for
- row
Filter GetPolicy Infos Policy Row Filter - (RowFilterOptions) - Options for row filter policies. Valid only if
policy_type
isPOLICY_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 String - (string) - Optional condition when the policy should take effect
- created
At number - (integer) - Time at which the policy was created, in epoch milliseconds. Output only
- created
By string - (string) - Username of the user who created the policy. Output only
- for
Securable stringType - (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
- policy
Type string - (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 string[] - (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
- updated
At number - (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
- updated
By string - (string) - Username of the user who last modified the policy. Output only
- column
Mask GetPolicy Infos Policy Column Mask - (ColumnMaskOptions) - Options for column mask policies. Valid only if
policy_type
isPOLICY_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
- except
Principals string[] - (list of string) - Optional list of user or group names that should be excluded from the policy
- match
Columns GetPolicy Infos Policy Match Column[] - (list of MatchColumn) - Optional list of condition expressions used to match table columns.
Only valid when
for_securable_type
istable
. 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 - on
Securable stringFullname - Required. The fully qualified name of securable to list policies for
- on
Securable stringType - Required. The type of the securable to list policies for
- row
Filter GetPolicy Infos Policy Row Filter - (RowFilterOptions) - Options for row filter policies. Valid only if
policy_type
isPOLICY_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 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_ strtype - (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 GetPolicy Infos Policy Column Mask - (ColumnMaskOptions) - Options for column mask policies. Valid only if
policy_type
isPOLICY_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[GetPolicy Infos Policy Match Column] - (list of MatchColumn) - Optional list of condition expressions used to match table columns.
Only valid when
for_securable_type
istable
. 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_ strfullname - Required. The fully qualified name of securable to list policies for
- on_
securable_ strtype - Required. The type of the securable to list policies for
- row_
filter GetPolicy Infos Policy Row Filter - (RowFilterOptions) - Options for row filter policies. Valid only if
policy_type
isPOLICY_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
- created
At Number - (integer) - Time at which the policy was created, in epoch milliseconds. Output only
- created
By String - (string) - Username of the user who created the policy. Output only
- for
Securable StringType - (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
- policy
Type String - (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 List<String> - (list of string) - List of user or group names that the policy applies to. Required on create and optional on update
- updated
At Number - (integer) - Time at which the policy was last modified, in epoch milliseconds. Output only
- updated
By String - (string) - Username of the user who last modified the policy. Output only
- column
Mask Property Map - (ColumnMaskOptions) - Options for column mask policies. Valid only if
policy_type
isPOLICY_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
- except
Principals List<String> - (list of string) - Optional list of user or group names that should be excluded from the policy
- match
Columns List<Property Map> - (list of MatchColumn) - Optional list of condition expressions used to match table columns.
Only valid when
for_securable_type
istable
. 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 - on
Securable StringFullname - Required. The fully qualified name of securable to list policies for
- on
Securable StringType - Required. The type of the securable to list policies for
- row
Filter Property Map - (RowFilterOptions) - Options for row filter policies. Valid only if
policy_type
isPOLICY_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 String - (string) - Optional condition when the policy should take effect
GetPolicyInfosPolicyColumnMask
- Function
Name 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
- On
Column 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<Get
Policy Infos Policy Column Mask Using> - (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 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
- On
Column 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
[]Get
Policy Infos Policy Column Mask Using - (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 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
- on
Column 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<Get
Policy Infos Policy Column Mask Using> - (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 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
- on
Column 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
Get
Policy Infos Policy Column Mask Using[] - (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[Get
Policy Infos Policy Column Mask Using] - (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 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
- on
Column 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
GetPolicyInfosPolicyMatchColumn
GetPolicyInfosPolicyRowFilter
- Function
Name 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<Get
Policy Infos Policy Row Filter Using> - (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 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
[]Get
Policy Infos Policy Row Filter Using - (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 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<Get
Policy Infos Policy Row Filter Using> - (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 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
Get
Policy Infos Policy Row Filter Using[] - (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[Get
Policy Infos Policy Row Filter Using] - (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 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
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricks
Terraform Provider.