Package com.databricks.sdk.service.settings

Interface Summary

Interface	Description
AccountIpAccessListsService	The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console.
AccountSettingsService	Accounts Settings API allows users to manage settings at the account level.
AibiDashboardEmbeddingAccessPolicyService	Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled at the workspace level.
AibiDashboardEmbeddingApprovedDomainsService	Controls the list of domains approved to host the embedded AI/BI dashboards.
AutomaticClusterUpdateService	Controls whether automatic cluster update is enabled for the current workspace.
ComplianceSecurityProfileService	Controls whether to enable the compliance security profile for the current workspace.
CredentialsManagerService	Credentials manager interacts with with Identity Providers to to perform token exchanges using stored credentials and refresh tokens.
CspEnablementAccountService	The compliance security profile settings at the account level control whether to enable it for new workspaces.
DashboardEmailSubscriptionsService	Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can send subscription emails containing PDFs and/or images of the dashboard.
DefaultNamespaceService	The default namespace setting API allows users to configure the default namespace for a Databricks workspace.
DisableLegacyAccessService	'Disabling legacy access' has the following impacts:
DisableLegacyDbfsService	Disabling legacy DBFS has the following implications:
DisableLegacyFeaturesService	Disable legacy features for new Databricks workspaces.
EnableExportNotebookService	Controls whether users can export notebooks and files from the Workspace UI.
EnableIpAccessListsService	Controls the enforcement of IP access lists for accessing the account console.
EnableNotebookTableClipboardService	Controls whether users can copy tabular data to the clipboard via the UI.
EnableResultsDownloadingService	Controls whether users can download notebook results.
EnhancedSecurityMonitoringService	Controls whether enhanced security monitoring is enabled for the current workspace.
EsmEnablementAccountService	The enhanced security monitoring setting at the account level controls whether to enable the feature on new workspaces.
IpAccessListsService	IP Access List enables admins to configure IP access lists.
LlmProxyPartnerPoweredAccountService	Determines if partner powered models are enabled or not for a specific account
LlmProxyPartnerPoweredEnforceService	Determines if the account-level partner-powered setting value is enforced upon the workspace-level partner-powered setting
LlmProxyPartnerPoweredWorkspaceService	Determines if partner powered models are enabled or not for a specific workspace
NetworkConnectivityService	These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources.
NetworkPoliciesService	These APIs manage network policies for this account.
NotificationDestinationsService	The notification destinations API lets you programmatically manage a workspace's notification destinations.
PersonalComputeService	The Personal Compute enablement setting lets you control which users can use the Personal Compute default policy to create compute resources.
RestrictWorkspaceAdminsService	The Restrict Workspace Admins setting lets you control the capabilities of workspace admins.
SettingsService	Workspace Settings API allows users to manage settings at the workspace level.
SqlResultsDownloadService	Controls whether users within the workspace are allowed to download results from the SQL Editor and AI/BI Dashboards UIs.
TokenManagementService	Enables administrators to get all tokens and delete tokens for other users.
TokensService	The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.
WorkspaceConfService	This API allows updating known workspace settings for advanced users.
WorkspaceNetworkConfigurationService	These APIs allow configuration of network settings for Databricks workspaces by selecting which network policy to associate with the workspace.

Class Summary

Class	Description
AccountIpAccessEnable
AccountIpAccessListsAPI	The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console.
AccountNetworkPolicy
AccountSettingsAPI	Accounts Settings API allows users to manage settings at the account level.
AibiDashboardEmbeddingAccessPolicy
AibiDashboardEmbeddingAccessPolicyAPI	Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled at the workspace level.
AibiDashboardEmbeddingAccessPolicySetting
AibiDashboardEmbeddingApprovedDomains
AibiDashboardEmbeddingApprovedDomainsAPI	Controls the list of domains approved to host the embedded AI/BI dashboards.
AibiDashboardEmbeddingApprovedDomainsSetting
AutomaticClusterUpdateAPI	Controls whether automatic cluster update is enabled for the current workspace.
AutomaticClusterUpdateSetting
BooleanMessage
ClusterAutoRestartMessage
ClusterAutoRestartMessageEnablementDetails	Contains an information about the enablement status judging (e.g.
ClusterAutoRestartMessageMaintenanceWindow
ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule
ClusterAutoRestartMessageMaintenanceWindowWindowStartTime
ComplianceSecurityProfile	SHIELD feature: CSP
ComplianceSecurityProfileAPI	Controls whether to enable the compliance security profile for the current workspace.
ComplianceSecurityProfileSetting
Config
CreateIpAccessList	Details required to configure a block list or allow list.
CreateIpAccessListResponse	An IP access list was successfully created.
CreateNetworkConnectivityConfigRequest	Create a network connectivity configuration
CreateNetworkConnectivityConfiguration	Properties of the new network connectivity configuration.
CreateNetworkPolicyRequest	Create a network policy
CreateNotificationDestinationRequest
CreateOboTokenRequest	Configuration details for creating on-behalf tokens.
CreateOboTokenResponse	An on-behalf token was successfully created for the service principal.
CreatePrivateEndpointRule	Properties of the new private endpoint rule.
CreatePrivateEndpointRuleRequest	Create a private endpoint rule
CreateTokenRequest
CreateTokenResponse
CredentialsManagerAPI	Credentials manager interacts with with Identity Providers to to perform token exchanges using stored credentials and refresh tokens.
CspEnablementAccount	Account level policy for CSP
CspEnablementAccountAPI	The compliance security profile settings at the account level control whether to enable it for new workspaces.
CspEnablementAccountSetting
DashboardEmailSubscriptions
DashboardEmailSubscriptionsAPI	Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can send subscription emails containing PDFs and/or images of the dashboard.
DefaultNamespaceAPI	The default namespace setting API allows users to configure the default namespace for a Databricks workspace.
DefaultNamespaceSetting	This represents the setting configuration for the default namespace in the Databricks workspace.
DeleteAccountIpAccessEnableRequest	Delete the account IP access toggle setting
DeleteAccountIpAccessEnableResponse	The etag is returned.
DeleteAccountIpAccessListRequest	Delete access list
DeleteAibiDashboardEmbeddingAccessPolicySettingRequest	Delete the AI/BI dashboard embedding access policy
DeleteAibiDashboardEmbeddingAccessPolicySettingResponse	The etag is returned.
DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest	Delete AI/BI dashboard embedding approved domains
DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse	The etag is returned.
DeleteDashboardEmailSubscriptionsRequest	Delete the Dashboard Email Subscriptions setting
DeleteDashboardEmailSubscriptionsResponse	The etag is returned.
DeleteDefaultNamespaceSettingRequest	Delete the default namespace setting
DeleteDefaultNamespaceSettingResponse	The etag is returned.
DeleteDisableLegacyAccessRequest	Delete Legacy Access Disablement Status
DeleteDisableLegacyAccessResponse	The etag is returned.
DeleteDisableLegacyDbfsRequest	Delete the disable legacy DBFS setting
DeleteDisableLegacyDbfsResponse	The etag is returned.
DeleteDisableLegacyFeaturesRequest	Delete the disable legacy features setting
DeleteDisableLegacyFeaturesResponse	The etag is returned.
DeleteIpAccessListRequest	Delete access list
DeleteLlmProxyPartnerPoweredWorkspaceRequest	Delete the enable partner powered AI features workspace setting
DeleteLlmProxyPartnerPoweredWorkspaceResponse	The etag is returned.
DeleteNetworkConnectivityConfigurationRequest	Delete a network connectivity configuration
DeleteNetworkConnectivityConfigurationResponse
DeleteNetworkPolicyRequest	Delete a network policy
DeleteNetworkPolicyRpcResponse
DeleteNotificationDestinationRequest	Delete a notification destination
DeletePersonalComputeSettingRequest	Delete Personal Compute setting
DeletePersonalComputeSettingResponse	The etag is returned.
DeletePrivateEndpointRuleRequest	Delete a private endpoint rule
DeleteResponse
DeleteRestrictWorkspaceAdminsSettingRequest	Delete the restrict workspace admins setting
DeleteRestrictWorkspaceAdminsSettingResponse	The etag is returned.
DeleteSqlResultsDownloadRequest	Delete the SQL Results Download setting
DeleteSqlResultsDownloadResponse	The etag is returned.
DeleteTokenManagementRequest	Delete a token
DisableLegacyAccess
DisableLegacyAccessAPI	'Disabling legacy access' has the following impacts:
DisableLegacyDbfs
DisableLegacyDbfsAPI	Disabling legacy DBFS has the following implications:
DisableLegacyFeatures
DisableLegacyFeaturesAPI	Disable legacy features for new Databricks workspaces.
EgressNetworkPolicy	The network policies applying for egress traffic.
EgressNetworkPolicyInternetAccessPolicy
EgressNetworkPolicyInternetAccessPolicyInternetDestination	Users can specify accessible internet destinations when outbound access is restricted.
EgressNetworkPolicyInternetAccessPolicyLogOnlyMode
EgressNetworkPolicyInternetAccessPolicyStorageDestination	Users can specify accessible storage destinations.
EgressNetworkPolicyNetworkAccessPolicy
EgressNetworkPolicyNetworkAccessPolicyInternetDestination	Users can specify accessible internet destinations when outbound access is restricted.
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement
EgressNetworkPolicyNetworkAccessPolicyStorageDestination	Users can specify accessible storage destinations.
EmailConfig
Empty
EnableExportNotebook
EnableExportNotebookAPI	Controls whether users can export notebooks and files from the Workspace UI.
EnableIpAccessListsAPI	Controls the enforcement of IP access lists for accessing the account console.
EnableNotebookTableClipboard
EnableNotebookTableClipboardAPI	Controls whether users can copy tabular data to the clipboard via the UI.
EnableResultsDownloading
EnableResultsDownloadingAPI	Controls whether users can download notebook results.
EnhancedSecurityMonitoring	SHIELD feature: ESM
EnhancedSecurityMonitoringAPI	Controls whether enhanced security monitoring is enabled for the current workspace.
EnhancedSecurityMonitoringSetting
EsmEnablementAccount	Account level policy for ESM
EsmEnablementAccountAPI	The enhanced security monitoring setting at the account level controls whether to enable the feature on new workspaces.
EsmEnablementAccountSetting
ExchangeToken	The exchange token is the result of the token exchange with the IdP
ExchangeTokenRequest	Exchange a token with the IdP
ExchangeTokenResponse	Exhanged tokens were successfully returned.
FetchIpAccessListResponse	An IP access list was successfully returned.
GenericWebhookConfig
GetAccountIpAccessEnableRequest	Get the account IP access toggle setting
GetAccountIpAccessListRequest	Get IP access list
GetAibiDashboardEmbeddingAccessPolicySettingRequest	Retrieve the AI/BI dashboard embedding access policy
GetAibiDashboardEmbeddingApprovedDomainsSettingRequest	Retrieve the list of domains approved to host embedded AI/BI dashboards
GetAutomaticClusterUpdateSettingRequest	Get the automatic cluster update setting
GetComplianceSecurityProfileSettingRequest	Get the compliance security profile setting
GetCspEnablementAccountSettingRequest	Get the compliance security profile setting for new workspaces
GetDashboardEmailSubscriptionsRequest	Get the Dashboard Email Subscriptions setting
GetDefaultNamespaceSettingRequest	Get the default namespace setting
GetDisableLegacyAccessRequest	Retrieve Legacy Access Disablement Status
GetDisableLegacyDbfsRequest	Get the disable legacy DBFS setting
GetDisableLegacyFeaturesRequest	Get the disable legacy features setting
GetEnhancedSecurityMonitoringSettingRequest	Get the enhanced security monitoring setting
GetEsmEnablementAccountSettingRequest	Get the enhanced security monitoring setting for new workspaces
GetIpAccessListRequest	Get access list
GetIpAccessListResponse
GetIpAccessListsResponse	IP access lists were successfully returned.
GetLlmProxyPartnerPoweredAccountRequest	Get the enable partner powered AI features account setting
GetLlmProxyPartnerPoweredEnforceRequest	Get the enforcement status of partner powered AI features account setting
GetLlmProxyPartnerPoweredWorkspaceRequest	Get the enable partner powered AI features workspace setting
GetNetworkConnectivityConfigurationRequest	Get a network connectivity configuration
GetNetworkPolicyRequest	Get a network policy
GetNotificationDestinationRequest	Get a notification destination
GetPersonalComputeSettingRequest	Get Personal Compute setting
GetPrivateEndpointRuleRequest	Gets a private endpoint rule
GetRestrictWorkspaceAdminsSettingRequest	Get the restrict workspace admins setting
GetSqlResultsDownloadRequest	Get the SQL Results Download setting
GetStatusRequest	Check configuration status
GetTokenManagementRequest	Get token info
GetTokenPermissionLevelsResponse
GetTokenResponse	Token with specified Token ID was successfully returned.
GetWorkspaceNetworkOptionRequest	Get workspace network option
IpAccessListInfo	Definition of an IP Access list
IpAccessListsAPI	IP Access List enables admins to configure IP access lists.
ListIpAccessListResponse	IP access lists were successfully returned.
ListNccAzurePrivateEndpointRulesResponse	The private endpoint rule list was successfully retrieved.
ListNetworkConnectivityConfigurationsRequest	List network connectivity configurations
ListNetworkConnectivityConfigurationsResponse	The network connectivity configuration list was successfully retrieved.
ListNetworkPoliciesRequest	List network policies
ListNetworkPoliciesResponse
ListNotificationDestinationsRequest	List notification destinations
ListNotificationDestinationsResponse
ListNotificationDestinationsResult
ListPrivateEndpointRulesRequest	List private endpoint rules
ListPublicTokensResponse
ListTokenManagementRequest	List all tokens
ListTokensResponse	Tokens were successfully returned.
LlmProxyPartnerPoweredAccount
LlmProxyPartnerPoweredAccountAPI	Determines if partner powered models are enabled or not for a specific account
LlmProxyPartnerPoweredEnforce
LlmProxyPartnerPoweredEnforceAPI	Determines if the account-level partner-powered setting value is enforced upon the workspace-level partner-powered setting
LlmProxyPartnerPoweredWorkspace
LlmProxyPartnerPoweredWorkspaceAPI	Determines if partner powered models are enabled or not for a specific workspace
MicrosoftTeamsConfig
NccAwsStableIpRule	The stable AWS IP CIDR blocks.
NccAzurePrivateEndpointRule	Properties of the new private endpoint rule.
NccAzureServiceEndpointRule	The stable Azure service endpoints.
NccEgressConfig
NccEgressDefaultRules	Default rules don't have specific targets.
NccEgressTargetRules	Target rule controls the egress rules that are dedicated to specific resources.
NetworkConnectivityAPI	These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources.
NetworkConnectivityConfiguration	Properties of the new network connectivity configuration.
NetworkPoliciesAPI	These APIs manage network policies for this account.
NetworkPolicyEgress	The network policies applying for egress traffic.
NotificationDestination
NotificationDestinationsAPI	The notification destinations API lets you programmatically manage a workspace's notification destinations.
PagerdutyConfig
PartitionId	Partition by workspace or account
PersonalComputeAPI	The Personal Compute enablement setting lets you control which users can use the Personal Compute default policy to create compute resources.
PersonalComputeMessage
PersonalComputeSetting
PublicTokenInfo
ReplaceIpAccessList	Details required to replace an IP access list.
ReplaceResponse
RestrictWorkspaceAdminsAPI	The Restrict Workspace Admins setting lets you control the capabilities of workspace admins.
RestrictWorkspaceAdminsMessage
RestrictWorkspaceAdminsSetting
RevokeTokenRequest
RevokeTokenResponse
SetStatusResponse
SettingsAPI	Workspace Settings API allows users to manage settings at the workspace level.
SlackConfig
SqlResultsDownload
SqlResultsDownloadAPI	Controls whether users within the workspace are allowed to download results from the SQL Editor and AI/BI Dashboards UIs.
StringMessage
TokenAccessControlRequest
TokenAccessControlResponse
TokenInfo
TokenManagementAPI	Enables administrators to get all tokens and delete tokens for other users.
TokenPermission
TokenPermissions
TokenPermissionsDescription
TokenPermissionsRequest
TokensAPI	The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.
UpdateAccountIpAccessEnableRequest	Details required to update a setting.
UpdateAibiDashboardEmbeddingAccessPolicySettingRequest	Details required to update a setting.
UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest	Details required to update a setting.
UpdateAutomaticClusterUpdateSettingRequest	Details required to update a setting.
UpdateComplianceSecurityProfileSettingRequest	Details required to update a setting.
UpdateCspEnablementAccountSettingRequest	Details required to update a setting.
UpdateDashboardEmailSubscriptionsRequest	Details required to update a setting.
UpdateDefaultNamespaceSettingRequest	Details required to update a setting.
UpdateDisableLegacyAccessRequest	Details required to update a setting.
UpdateDisableLegacyDbfsRequest	Details required to update a setting.
UpdateDisableLegacyFeaturesRequest	Details required to update a setting.
UpdateEnableExportNotebookRequest	Details required to update a setting.
UpdateEnableNotebookTableClipboardRequest	Details required to update a setting.
UpdateEnableResultsDownloadingRequest	Details required to update a setting.
UpdateEnhancedSecurityMonitoringSettingRequest	Details required to update a setting.
UpdateEsmEnablementAccountSettingRequest	Details required to update a setting.
UpdateIpAccessList	Details required to update an IP access list.
UpdateLlmProxyPartnerPoweredAccountRequest	Details required to update a setting.
UpdateLlmProxyPartnerPoweredEnforceRequest	Details required to update a setting.
UpdateLlmProxyPartnerPoweredWorkspaceRequest	Details required to update a setting.
UpdateNccAzurePrivateEndpointRulePublicRequest	Update a private endpoint rule
UpdateNetworkPolicyRequest	Update a network policy
UpdateNotificationDestinationRequest
UpdatePersonalComputeSettingRequest	Details required to update a setting.
UpdatePrivateEndpointRule	Properties of the new private endpoint rule.
UpdateResponse
UpdateRestrictWorkspaceAdminsSettingRequest	Details required to update a setting.
UpdateSqlResultsDownloadRequest	Details required to update a setting.
UpdateWorkspaceNetworkOptionRequest	Update workspace network option
WorkspaceConfAPI	This API allows updating known workspace settings for advanced users.
WorkspaceNetworkConfigurationAPI	These APIs allow configuration of network settings for Databricks workspaces by selecting which network policy to associate with the workspace.
WorkspaceNetworkOption

Enum Summary

Enum	Description
AibiDashboardEmbeddingAccessPolicyAccessPolicyType
ClusterAutoRestartMessageMaintenanceWindowDayOfWeek
ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency
ComplianceStandard	Compliance stardard for SHIELD customers
DestinationType
EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol	The filtering protocol used by the DP.
EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType
EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType
EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType	The values should match the list of workloads used in networkconfig.proto
EgressNetworkPolicyInternetAccessPolicyRestrictionMode	At which level can Databricks and Databricks managed compute access Internet.
EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType
EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter	The values should match the list of workloads used in networkconfig.proto
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode
EgressNetworkPolicyNetworkAccessPolicyRestrictionMode	At which level can Databricks and Databricks managed compute access Internet.
EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType
EgressResourceType	The target resources that are supported by Network Connectivity Config.
ListType	Type of IP access list.
NccAzurePrivateEndpointRuleConnectionState
PersonalComputeMessageEnum	ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing all users to create single-machine compute resources.
RestrictWorkspaceAdminsMessageStatus
TokenPermissionLevel	Permission level
TokenType	The type of token request.