Databricks SDK for JavaScript
    Preparing search index...

    Interface PolicyInfo

    interface PolicyInfo {
        comment?: string;
        createdAt?: bigint;
        createdBy?: string;
        exceptPrincipals?: string[];
        forSecurableType?: SecurableType;
        id?: string;
        matchColumns?: MatchColumn[];
        name?: string;
        onSecurableFullname?: string;
        onSecurableType?: SecurableType;
        options?:
            | { $case: "rowFilter"; rowFilter: RowFilterOptions }
            | { $case: "columnMask"; columnMask: ColumnMaskOptions };
        policyType?: PolicyType;
        toPrincipals?: string[];
        updatedAt?: bigint;
        updatedBy?: string;
        whenCondition?: string;
    }
    Index

    Properties

    comment? createdAt? createdBy? exceptPrincipals? forSecurableType? id? matchColumns? name? onSecurableFullname? onSecurableType? options? policyType? toPrincipals? updatedAt? updatedBy? whenCondition?

    Properties

    comment?: string

    Optional description of the policy.

    createdAt?: bigint

    Time at which the policy was created, in epoch milliseconds. Output only.

    createdBy?: 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?: SecurableType

    Type of securables that the policy should take effect on. Only TABLE is supported at this moment. Required on create and optional on update.

    id?: string

    Unique identifier of the policy. This field is output only and is generated by the system.

    matchColumns?: 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

    Name of the policy. Required on create and optional on update. To rename the policy, set name to a different value on update.

    onSecurableFullname?: string

    Full name of the securable on which the policy is defined. Required on create.

    onSecurableType?: SecurableType

    Type of the securable on which the policy is defined. Only CATALOG, SCHEMA and TABLE are supported at this moment. Required on create.

    options?:
        | { $case: "rowFilter"; rowFilter: RowFilterOptions }
        | { $case: "columnMask"; columnMask: ColumnMaskOptions }

    (--[Create:REQ Update:OPT] Type-specific options for the Policy--) Type-specific options for the policy.

    Type Declaration

    • { $case: "rowFilter"; rowFilter: RowFilterOptions }
      • $case: "rowFilter"
      • rowFilter: 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.

    • { $case: "columnMask"; columnMask: ColumnMaskOptions }
      • $case: "columnMask"
      • columnMask: 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.

    policyType?: PolicyType

    Type of the policy. Required on create.

    toPrincipals?: string[]

    List of user or group names that the policy applies to. Required on create and optional on update.

    updatedAt?: bigint

    Time at which the policy was last modified, in epoch milliseconds. Output only.

    updatedBy?: string

    Username of the user who last modified the policy. Output only.

    whenCondition?: string

    Optional condition when the policy should take effect.

    Settings

    Member Visibility

    On This Page

    Properties