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

databricks.PolicyInfo

Explore with Pulumi AI

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

    Import

    As of Pulumi v1.5, resources can be imported through configuration.

    hcl

    import {

    id = on_securable_type,on_securable_fullname,name

    to = databricks_policy_info.this

    }

    If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:

    $ pulumi import databricks:index/policyInfo:PolicyInfo databricks_policy_info on_securable_type,on_securable_fullname,name
    

    Create PolicyInfo Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PolicyInfo(name: string, args: PolicyInfoArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyInfo(resource_name: str,
                   args: PolicyInfoArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyInfo(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   for_securable_type: Optional[str] = None,
                   policy_type: Optional[str] = None,
                   to_principals: Optional[Sequence[str]] = None,
                   column_mask: Optional[PolicyInfoColumnMaskArgs] = None,
                   comment: Optional[str] = None,
                   except_principals: Optional[Sequence[str]] = None,
                   match_columns: Optional[Sequence[PolicyInfoMatchColumnArgs]] = None,
                   name: Optional[str] = None,
                   on_securable_fullname: Optional[str] = None,
                   on_securable_type: Optional[str] = None,
                   row_filter: Optional[PolicyInfoRowFilterArgs] = None,
                   when_condition: Optional[str] = None)
    func NewPolicyInfo(ctx *Context, name string, args PolicyInfoArgs, opts ...ResourceOption) (*PolicyInfo, error)
    public PolicyInfo(string name, PolicyInfoArgs args, CustomResourceOptions? opts = null)
    public PolicyInfo(String name, PolicyInfoArgs args)
    public PolicyInfo(String name, PolicyInfoArgs args, CustomResourceOptions options)
    
    type: databricks:PolicyInfo
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PolicyInfoArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PolicyInfoArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PolicyInfoArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyInfoArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyInfoArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var policyInfoResource = new Databricks.PolicyInfo("policyInfoResource", new()
    {
        ForSecurableType = "string",
        PolicyType = "string",
        ToPrincipals = new[]
        {
            "string",
        },
        ColumnMask = new Databricks.Inputs.PolicyInfoColumnMaskArgs
        {
            FunctionName = "string",
            OnColumn = "string",
            Usings = new[]
            {
                new Databricks.Inputs.PolicyInfoColumnMaskUsingArgs
                {
                    Alias = "string",
                    Constant = "string",
                },
            },
        },
        Comment = "string",
        ExceptPrincipals = new[]
        {
            "string",
        },
        MatchColumns = new[]
        {
            new Databricks.Inputs.PolicyInfoMatchColumnArgs
            {
                Alias = "string",
                Condition = "string",
            },
        },
        Name = "string",
        OnSecurableFullname = "string",
        OnSecurableType = "string",
        RowFilter = new Databricks.Inputs.PolicyInfoRowFilterArgs
        {
            FunctionName = "string",
            Usings = new[]
            {
                new Databricks.Inputs.PolicyInfoRowFilterUsingArgs
                {
                    Alias = "string",
                    Constant = "string",
                },
            },
        },
        WhenCondition = "string",
    });
    
    example, err := databricks.NewPolicyInfo(ctx, "policyInfoResource", &databricks.PolicyInfoArgs{
    	ForSecurableType: pulumi.String("string"),
    	PolicyType:       pulumi.String("string"),
    	ToPrincipals: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ColumnMask: &databricks.PolicyInfoColumnMaskArgs{
    		FunctionName: pulumi.String("string"),
    		OnColumn:     pulumi.String("string"),
    		Usings: databricks.PolicyInfoColumnMaskUsingArray{
    			&databricks.PolicyInfoColumnMaskUsingArgs{
    				Alias:    pulumi.String("string"),
    				Constant: pulumi.String("string"),
    			},
    		},
    	},
    	Comment: pulumi.String("string"),
    	ExceptPrincipals: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	MatchColumns: databricks.PolicyInfoMatchColumnArray{
    		&databricks.PolicyInfoMatchColumnArgs{
    			Alias:     pulumi.String("string"),
    			Condition: pulumi.String("string"),
    		},
    	},
    	Name:                pulumi.String("string"),
    	OnSecurableFullname: pulumi.String("string"),
    	OnSecurableType:     pulumi.String("string"),
    	RowFilter: &databricks.PolicyInfoRowFilterArgs{
    		FunctionName: pulumi.String("string"),
    		Usings: databricks.PolicyInfoRowFilterUsingArray{
    			&databricks.PolicyInfoRowFilterUsingArgs{
    				Alias:    pulumi.String("string"),
    				Constant: pulumi.String("string"),
    			},
    		},
    	},
    	WhenCondition: pulumi.String("string"),
    })
    
    var policyInfoResource = new PolicyInfo("policyInfoResource", PolicyInfoArgs.builder()
        .forSecurableType("string")
        .policyType("string")
        .toPrincipals("string")
        .columnMask(PolicyInfoColumnMaskArgs.builder()
            .functionName("string")
            .onColumn("string")
            .usings(PolicyInfoColumnMaskUsingArgs.builder()
                .alias("string")
                .constant("string")
                .build())
            .build())
        .comment("string")
        .exceptPrincipals("string")
        .matchColumns(PolicyInfoMatchColumnArgs.builder()
            .alias("string")
            .condition("string")
            .build())
        .name("string")
        .onSecurableFullname("string")
        .onSecurableType("string")
        .rowFilter(PolicyInfoRowFilterArgs.builder()
            .functionName("string")
            .usings(PolicyInfoRowFilterUsingArgs.builder()
                .alias("string")
                .constant("string")
                .build())
            .build())
        .whenCondition("string")
        .build());
    
    policy_info_resource = databricks.PolicyInfo("policyInfoResource",
        for_securable_type="string",
        policy_type="string",
        to_principals=["string"],
        column_mask={
            "function_name": "string",
            "on_column": "string",
            "usings": [{
                "alias": "string",
                "constant": "string",
            }],
        },
        comment="string",
        except_principals=["string"],
        match_columns=[{
            "alias": "string",
            "condition": "string",
        }],
        name="string",
        on_securable_fullname="string",
        on_securable_type="string",
        row_filter={
            "function_name": "string",
            "usings": [{
                "alias": "string",
                "constant": "string",
            }],
        },
        when_condition="string")
    
    const policyInfoResource = new databricks.PolicyInfo("policyInfoResource", {
        forSecurableType: "string",
        policyType: "string",
        toPrincipals: ["string"],
        columnMask: {
            functionName: "string",
            onColumn: "string",
            usings: [{
                alias: "string",
                constant: "string",
            }],
        },
        comment: "string",
        exceptPrincipals: ["string"],
        matchColumns: [{
            alias: "string",
            condition: "string",
        }],
        name: "string",
        onSecurableFullname: "string",
        onSecurableType: "string",
        rowFilter: {
            functionName: "string",
            usings: [{
                alias: "string",
                constant: "string",
            }],
        },
        whenCondition: "string",
    });
    
    type: databricks:PolicyInfo
    properties:
        columnMask:
            functionName: string
            onColumn: string
            usings:
                - alias: string
                  constant: string
        comment: string
        exceptPrincipals:
            - string
        forSecurableType: string
        matchColumns:
            - alias: string
              condition: string
        name: string
        onSecurableFullname: string
        onSecurableType: string
        policyType: string
        rowFilter:
            functionName: string
            usings:
                - alias: string
                  constant: string
        toPrincipals:
            - string
        whenCondition: string
    

    PolicyInfo Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PolicyInfo resource accepts the following input properties:

    ForSecurableType 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
    PolicyType 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 user or group names that the policy applies to. Required on create and optional on update
    ColumnMask PolicyInfoColumnMask
    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
    Optional description of the policy
    ExceptPrincipals List<string>
    Optional list of user or group names that should be excluded from the policy
    MatchColumns List<PolicyInfoMatchColumn>
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    OnSecurableFullname string
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    OnSecurableType string
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    RowFilter PolicyInfoRowFilter
    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
    Optional condition when the policy should take effect
    ForSecurableType 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
    PolicyType 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 user or group names that the policy applies to. Required on create and optional on update
    ColumnMask PolicyInfoColumnMaskArgs
    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
    Optional description of the policy
    ExceptPrincipals []string
    Optional list of user or group names that should be excluded from the policy
    MatchColumns []PolicyInfoMatchColumnArgs
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    OnSecurableFullname string
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    OnSecurableType string
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    RowFilter PolicyInfoRowFilterArgs
    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
    Optional condition when the policy should take effect
    forSecurableType 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
    policyType 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 user or group names that the policy applies to. Required on create and optional on update
    columnMask PolicyInfoColumnMask
    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
    Optional description of the policy
    exceptPrincipals List<String>
    Optional list of user or group names that should be excluded from the policy
    matchColumns List<PolicyInfoMatchColumn>
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname String
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    onSecurableType String
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    rowFilter PolicyInfoRowFilter
    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
    Optional condition when the policy should take effect
    forSecurableType 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
    policyType 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 user or group names that the policy applies to. Required on create and optional on update
    columnMask PolicyInfoColumnMask
    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
    Optional description of the policy
    exceptPrincipals string[]
    Optional list of user or group names that should be excluded from the policy
    matchColumns PolicyInfoMatchColumn[]
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname string
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    onSecurableType string
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    rowFilter PolicyInfoRowFilter
    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
    Optional condition when the policy should take effect
    for_securable_type str
    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
    policy_type str
    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 user or group names that the policy applies to. Required on create and optional on update
    column_mask PolicyInfoColumnMaskArgs
    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
    Optional description of the policy
    except_principals Sequence[str]
    Optional list of user or group names that should be excluded from the policy
    match_columns Sequence[PolicyInfoMatchColumnArgs]
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    on_securable_fullname str
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    on_securable_type str
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    row_filter PolicyInfoRowFilterArgs
    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
    Optional condition when the policy should take effect
    forSecurableType 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
    policyType 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 user or group names that the policy applies to. Required on create and optional on update
    columnMask Property Map
    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
    Optional description of the policy
    exceptPrincipals List<String>
    Optional list of user or group names that should be excluded from the policy
    matchColumns List<Property Map>
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname String
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    onSecurableType String
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    rowFilter Property Map
    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
    Optional condition when the policy should take effect

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyInfo resource produces the following output properties:

    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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
    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
    id string
    The provider-assigned unique ID for this managed resource.
    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
    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
    id str
    The provider-assigned unique ID for this managed resource.
    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
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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

    Look up Existing PolicyInfo Resource

    Get an existing PolicyInfo resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PolicyInfoState, opts?: CustomResourceOptions): PolicyInfo
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            column_mask: Optional[PolicyInfoColumnMaskArgs] = None,
            comment: Optional[str] = None,
            created_at: Optional[int] = None,
            created_by: Optional[str] = None,
            except_principals: Optional[Sequence[str]] = None,
            for_securable_type: Optional[str] = None,
            match_columns: Optional[Sequence[PolicyInfoMatchColumnArgs]] = None,
            name: Optional[str] = None,
            on_securable_fullname: Optional[str] = None,
            on_securable_type: Optional[str] = None,
            policy_type: Optional[str] = None,
            row_filter: Optional[PolicyInfoRowFilterArgs] = None,
            to_principals: Optional[Sequence[str]] = None,
            updated_at: Optional[int] = None,
            updated_by: Optional[str] = None,
            when_condition: Optional[str] = None) -> PolicyInfo
    func GetPolicyInfo(ctx *Context, name string, id IDInput, state *PolicyInfoState, opts ...ResourceOption) (*PolicyInfo, error)
    public static PolicyInfo Get(string name, Input<string> id, PolicyInfoState? state, CustomResourceOptions? opts = null)
    public static PolicyInfo get(String name, Output<String> id, PolicyInfoState state, CustomResourceOptions options)
    resources:  _:    type: databricks:PolicyInfo    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ColumnMask PolicyInfoColumnMask
    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
    Optional description of the policy
    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
    ExceptPrincipals List<string>
    Optional list of user or group names that should be excluded from the policy
    ForSecurableType 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
    MatchColumns List<PolicyInfoMatchColumn>
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    OnSecurableFullname string
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    OnSecurableType string
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    PolicyType string
    Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    RowFilter PolicyInfoRowFilter
    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
    ToPrincipals List<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
    WhenCondition string
    Optional condition when the policy should take effect
    ColumnMask PolicyInfoColumnMaskArgs
    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
    Optional description of the policy
    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
    ExceptPrincipals []string
    Optional list of user or group names that should be excluded from the policy
    ForSecurableType 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
    MatchColumns []PolicyInfoMatchColumnArgs
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    OnSecurableFullname string
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    OnSecurableType string
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    PolicyType string
    Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    RowFilter PolicyInfoRowFilterArgs
    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
    ToPrincipals []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
    WhenCondition string
    Optional condition when the policy should take effect
    columnMask PolicyInfoColumnMask
    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
    Optional description of the policy
    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
    exceptPrincipals List<String>
    Optional list of user or group names that should be excluded from the policy
    forSecurableType 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
    matchColumns List<PolicyInfoMatchColumn>
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname String
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    onSecurableType String
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    policyType String
    Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    rowFilter PolicyInfoRowFilter
    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
    toPrincipals List<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
    whenCondition String
    Optional condition when the policy should take effect
    columnMask PolicyInfoColumnMask
    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
    Optional description of the policy
    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
    exceptPrincipals string[]
    Optional list of user or group names that should be excluded from the policy
    forSecurableType 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
    matchColumns PolicyInfoMatchColumn[]
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname string
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    onSecurableType string
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    policyType string
    Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    rowFilter PolicyInfoRowFilter
    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
    toPrincipals 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
    whenCondition string
    Optional condition when the policy should take effect
    column_mask PolicyInfoColumnMaskArgs
    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
    Optional description of the policy
    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
    except_principals Sequence[str]
    Optional list of user or group names that should be excluded from the policy
    for_securable_type str
    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
    match_columns Sequence[PolicyInfoMatchColumnArgs]
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    on_securable_fullname str
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    on_securable_type str
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    policy_type str
    Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    row_filter PolicyInfoRowFilterArgs
    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
    to_principals Sequence[str]
    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
    when_condition str
    Optional condition when the policy should take effect
    columnMask Property Map
    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
    Optional description of the policy
    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
    exceptPrincipals List<String>
    Optional list of user or group names that should be excluded from the policy
    forSecurableType 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
    matchColumns List<Property Map>
    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
    Name of the policy. Required on create and ignored on update. To update the name, use the new_name field
    onSecurableFullname String
    Full name of the securable on which the policy is defined. Required on create and ignored on update
    onSecurableType String
    Type of the securable on which the policy is defined. Only catalog, schema and table are supported at this moment. Required on create and ignored 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
    policyType String
    Type of the policy. Required on create and ignored on update. Possible values are: POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER
    rowFilter Property Map
    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
    toPrincipals List<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
    whenCondition String
    Optional condition when the policy should take effect

    Supporting Types

    PolicyInfoColumnMask, PolicyInfoColumnMaskArgs

    FunctionName string
    OnColumn 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<PolicyInfoColumnMaskUsing>
    FunctionName string
    OnColumn 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 []PolicyInfoColumnMaskUsing
    functionName String
    onColumn 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<PolicyInfoColumnMaskUsing>
    functionName string
    onColumn 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 PolicyInfoColumnMaskUsing[]
    function_name str
    on_column str
    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[PolicyInfoColumnMaskUsing]
    functionName String
    onColumn 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>

    PolicyInfoColumnMaskUsing, PolicyInfoColumnMaskUsingArgs

    Alias string
    Constant string
    A constant literal
    Alias string
    Constant string
    A constant literal
    alias String
    constant String
    A constant literal
    alias string
    constant string
    A constant literal
    alias str
    constant str
    A constant literal
    alias String
    constant String
    A constant literal

    PolicyInfoMatchColumn, PolicyInfoMatchColumnArgs

    Alias string
    Condition string
    The condition expression used to match a table column
    Alias string
    Condition string
    The condition expression used to match a table column
    alias String
    condition String
    The condition expression used to match a table column
    alias string
    condition string
    The condition expression used to match a table column
    alias str
    condition str
    The condition expression used to match a table column
    alias String
    condition String
    The condition expression used to match a table column

    PolicyInfoRowFilter, PolicyInfoRowFilterArgs

    PolicyInfoRowFilterUsing, PolicyInfoRowFilterUsingArgs

    Alias string
    Constant string
    A constant literal
    Alias string
    Constant string
    A constant literal
    alias String
    constant String
    A constant literal
    alias string
    constant string
    A constant literal
    alias str
    constant str
    A constant literal
    alias String
    constant 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