Databricks SDK for JavaScript
    Preparing search index...
    interface Setting {
        effectiveValue?:
            | { $case: "effectiveBooleanVal"; effectiveBooleanVal: BooleanMessage }
            | { $case: "effectiveStringVal"; effectiveStringVal: StringMessage }
            | { $case: "effectiveIntegerVal"; effectiveIntegerVal: IntegerMessage }
            | {
                $case: "effectiveAutomaticClusterUpdateWorkspace";
                effectiveAutomaticClusterUpdateWorkspace: ClusterAutoRestartMessage;
            }
            | {
                $case: "effectiveAibiDashboardEmbeddingApprovedDomains";
                effectiveAibiDashboardEmbeddingApprovedDomains: AibiDashboardEmbeddingApprovedDomains;
            }
            | {
                $case: "effectiveAibiDashboardEmbeddingAccessPolicy";
                effectiveAibiDashboardEmbeddingAccessPolicy: AibiDashboardEmbeddingAccessPolicy;
            }
            | {
                $case: "effectiveRestrictWorkspaceAdmins";
                effectiveRestrictWorkspaceAdmins: RestrictWorkspaceAdminsMessage;
            }
            | {
                $case: "effectivePersonalCompute";
                effectivePersonalCompute: PersonalComputeMessage;
            }
            | {
                $case: "effectiveAllowedAppsUserApiScopes";
                effectiveAllowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage;
            }
            | {
                $case: "effectiveOperationalEmailCustomRecipient";
                effectiveOperationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage;
            }
            | {
                $case: "effectiveCollaborationPlatformConnectivity";
                effectiveCollaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage;
            };
        name?: string;
        value?: | { $case: "booleanVal"; booleanVal: BooleanMessage }
        | { $case: "stringVal"; stringVal: StringMessage }
        | { $case: "integerVal"; integerVal: IntegerMessage }
        | {
            $case: "automaticClusterUpdateWorkspace";
            automaticClusterUpdateWorkspace: ClusterAutoRestartMessage;
        }
        | {
            $case: "aibiDashboardEmbeddingApprovedDomains";
            aibiDashboardEmbeddingApprovedDomains: AibiDashboardEmbeddingApprovedDomains;
        }
        | {
            $case: "aibiDashboardEmbeddingAccessPolicy";
            aibiDashboardEmbeddingAccessPolicy: AibiDashboardEmbeddingAccessPolicy;
        }
        | {
            $case: "restrictWorkspaceAdmins";
            restrictWorkspaceAdmins: RestrictWorkspaceAdminsMessage;
        }
        | { $case: "personalCompute"; personalCompute: PersonalComputeMessage }
        | {
            $case: "allowedAppsUserApiScopes";
            allowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage;
        }
        | {
            $case: "operationalEmailCustomRecipient";
            operationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage;
        }
        | {
            $case: "collaborationPlatformConnectivity";
            collaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage;
        };
    }
    Index

    Properties

    effectiveValue?:
        | { $case: "effectiveBooleanVal"; effectiveBooleanVal: BooleanMessage }
        | { $case: "effectiveStringVal"; effectiveStringVal: StringMessage }
        | { $case: "effectiveIntegerVal"; effectiveIntegerVal: IntegerMessage }
        | {
            $case: "effectiveAutomaticClusterUpdateWorkspace";
            effectiveAutomaticClusterUpdateWorkspace: ClusterAutoRestartMessage;
        }
        | {
            $case: "effectiveAibiDashboardEmbeddingApprovedDomains";
            effectiveAibiDashboardEmbeddingApprovedDomains: AibiDashboardEmbeddingApprovedDomains;
        }
        | {
            $case: "effectiveAibiDashboardEmbeddingAccessPolicy";
            effectiveAibiDashboardEmbeddingAccessPolicy: AibiDashboardEmbeddingAccessPolicy;
        }
        | {
            $case: "effectiveRestrictWorkspaceAdmins";
            effectiveRestrictWorkspaceAdmins: RestrictWorkspaceAdminsMessage;
        }
        | {
            $case: "effectivePersonalCompute";
            effectivePersonalCompute: PersonalComputeMessage;
        }
        | {
            $case: "effectiveAllowedAppsUserApiScopes";
            effectiveAllowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage;
        }
        | {
            $case: "effectiveOperationalEmailCustomRecipient";
            effectiveOperationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage;
        }
        | {
            $case: "effectiveCollaborationPlatformConnectivity";
            effectiveCollaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage;
        }

    New fields should be added before the oneof below - unless it's a new Setting value message, in that case it needs to be defined in the oneof below. The final effective value from server as per the policy evaluation.

    Type Declaration

    • { $case: "effectiveBooleanVal"; effectiveBooleanVal: BooleanMessage }
      • $case: "effectiveBooleanVal"
      • effectiveBooleanVal: BooleanMessage

        Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val.

    • { $case: "effectiveStringVal"; effectiveStringVal: StringMessage }
      • $case: "effectiveStringVal"
      • effectiveStringVal: StringMessage

        Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val.

    • { $case: "effectiveIntegerVal"; effectiveIntegerVal: IntegerMessage }
      • $case: "effectiveIntegerVal"
      • effectiveIntegerVal: IntegerMessage

        Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val.

    • {
          $case: "effectiveAutomaticClusterUpdateWorkspace";
          effectiveAutomaticClusterUpdateWorkspace: ClusterAutoRestartMessage;
      }
      • $case: "effectiveAutomaticClusterUpdateWorkspace"
      • effectiveAutomaticClusterUpdateWorkspace: ClusterAutoRestartMessage

        Effective setting value for automatic_cluster_update_workspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace.

    • {
          $case: "effectiveAibiDashboardEmbeddingApprovedDomains";
          effectiveAibiDashboardEmbeddingApprovedDomains: AibiDashboardEmbeddingApprovedDomains;
      }
      • $case: "effectiveAibiDashboardEmbeddingApprovedDomains"
      • effectiveAibiDashboardEmbeddingApprovedDomains: AibiDashboardEmbeddingApprovedDomains

        Effective setting value for aibi_dashboard_embedding_approved_domains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains.

    • {
          $case: "effectiveAibiDashboardEmbeddingAccessPolicy";
          effectiveAibiDashboardEmbeddingAccessPolicy: AibiDashboardEmbeddingAccessPolicy;
      }
      • $case: "effectiveAibiDashboardEmbeddingAccessPolicy"
      • effectiveAibiDashboardEmbeddingAccessPolicy: AibiDashboardEmbeddingAccessPolicy

        Effective setting value for aibi_dashboard_embedding_access_policy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy.

    • {
          $case: "effectiveRestrictWorkspaceAdmins";
          effectiveRestrictWorkspaceAdmins: RestrictWorkspaceAdminsMessage;
      }
      • $case: "effectiveRestrictWorkspaceAdmins"
      • effectiveRestrictWorkspaceAdmins: RestrictWorkspaceAdminsMessage

        Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.

    • {
          $case: "effectivePersonalCompute";
          effectivePersonalCompute: PersonalComputeMessage;
      }
      • $case: "effectivePersonalCompute"
      • effectivePersonalCompute: PersonalComputeMessage

        Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.

    • {
          $case: "effectiveAllowedAppsUserApiScopes";
          effectiveAllowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage;
      }
      • $case: "effectiveAllowedAppsUserApiScopes"
      • effectiveAllowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage

        Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes.

    • {
          $case: "effectiveOperationalEmailCustomRecipient";
          effectiveOperationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage;
      }
      • $case: "effectiveOperationalEmailCustomRecipient"
      • effectiveOperationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage

        Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient.

    • {
          $case: "effectiveCollaborationPlatformConnectivity";
          effectiveCollaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage;
      }
      • $case: "effectiveCollaborationPlatformConnectivity"
      • effectiveCollaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage

        Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity.

    name?: string

    Name of the setting.

    value?:
        | { $case: "booleanVal"; booleanVal: BooleanMessage }
        | { $case: "stringVal"; stringVal: StringMessage }
        | { $case: "integerVal"; integerVal: IntegerMessage }
        | {
            $case: "automaticClusterUpdateWorkspace";
            automaticClusterUpdateWorkspace: ClusterAutoRestartMessage;
        }
        | {
            $case: "aibiDashboardEmbeddingApprovedDomains";
            aibiDashboardEmbeddingApprovedDomains: AibiDashboardEmbeddingApprovedDomains;
        }
        | {
            $case: "aibiDashboardEmbeddingAccessPolicy";
            aibiDashboardEmbeddingAccessPolicy: AibiDashboardEmbeddingAccessPolicy;
        }
        | {
            $case: "restrictWorkspaceAdmins";
            restrictWorkspaceAdmins: RestrictWorkspaceAdminsMessage;
        }
        | { $case: "personalCompute"; personalCompute: PersonalComputeMessage }
        | {
            $case: "allowedAppsUserApiScopes";
            allowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage;
        }
        | {
            $case: "operationalEmailCustomRecipient";
            operationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage;
        }
        | {
            $case: "collaborationPlatformConnectivity";
            collaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage;
        }

    New fields should be added before the oneof below - unless it's a new Setting value message, in that case it needs to be defined in the oneof below. The user-set value that goes into storage

    Type Declaration

    • { $case: "booleanVal"; booleanVal: BooleanMessage }
      • $case: "booleanVal"
      • booleanVal: BooleanMessage

        Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value.

    • { $case: "stringVal"; stringVal: StringMessage }
      • $case: "stringVal"
      • stringVal: StringMessage

        Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value.

    • { $case: "integerVal"; integerVal: IntegerMessage }
      • $case: "integerVal"
      • integerVal: IntegerMessage

        Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value.

    • {
          $case: "automaticClusterUpdateWorkspace";
          automaticClusterUpdateWorkspace: ClusterAutoRestartMessage;
      }
      • $case: "automaticClusterUpdateWorkspace"
      • automaticClusterUpdateWorkspace: ClusterAutoRestartMessage

        Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value.

    • {
          $case: "aibiDashboardEmbeddingApprovedDomains";
          aibiDashboardEmbeddingApprovedDomains: AibiDashboardEmbeddingApprovedDomains;
      }
      • $case: "aibiDashboardEmbeddingApprovedDomains"
      • aibiDashboardEmbeddingApprovedDomains: AibiDashboardEmbeddingApprovedDomains

        Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value.

    • {
          $case: "aibiDashboardEmbeddingAccessPolicy";
          aibiDashboardEmbeddingAccessPolicy: AibiDashboardEmbeddingAccessPolicy;
      }
      • $case: "aibiDashboardEmbeddingAccessPolicy"
      • aibiDashboardEmbeddingAccessPolicy: AibiDashboardEmbeddingAccessPolicy

        Setting value for aibi_dashboard_embedding_access_policy setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_access_policy for final setting value.

    • {
          $case: "restrictWorkspaceAdmins";
          restrictWorkspaceAdmins: RestrictWorkspaceAdminsMessage;
      }
      • $case: "restrictWorkspaceAdmins"
      • restrictWorkspaceAdmins: RestrictWorkspaceAdminsMessage

        Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value.

    • { $case: "personalCompute"; personalCompute: PersonalComputeMessage }
      • $case: "personalCompute"
      • personalCompute: PersonalComputeMessage

        Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value.

    • {
          $case: "allowedAppsUserApiScopes";
          allowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage;
      }
      • $case: "allowedAppsUserApiScopes"
      • allowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage

        Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value.

    • {
          $case: "operationalEmailCustomRecipient";
          operationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage;
      }
      • $case: "operationalEmailCustomRecipient"
      • operationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage

        Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value.

    • {
          $case: "collaborationPlatformConnectivity";
          collaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage;
      }
      • $case: "collaborationPlatformConnectivity"
      • collaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage

        Setting value for collaboration_platform_connectivity setting. This is the setting value set by consumers, check effective_collaboration_platform_connectivity for final setting value.