Settings

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.settings module.

class databricks.sdk.service.settings.AutomaticClusterUpdateSetting

automatic_cluster_update_workspace: ClusterAutoRestartMessage

etag: str | None = None

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

setting_name: str | None = None

Name of the corresponding setting. This field is populated in the response, but it will not be respected even if it’s set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be ‘default’ if the setting only has one instance per workspace.

as_dict() → dict

Serializes the AutomaticClusterUpdateSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AutomaticClusterUpdateSetting

Deserializes the AutomaticClusterUpdateSetting from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessage

can_toggle: bool | None = None

enabled: bool | None = None

enablement_details: ClusterAutoRestartMessageEnablementDetails | None = None

Contains an information about the enablement status judging (e.g. whether the enterprise tier is enabled) This is only additional information that MUST NOT be used to decide whether the setting is enabled or not. This is intended to use only for purposes like showing an error message to the customer with the additional details. For example, using these details we can check why exactly the feature is disabled for this customer.

maintenance_window: ClusterAutoRestartMessageMaintenanceWindow | None = None

restart_even_if_no_updates_available: bool | None = None

as_dict() → dict

Serializes the ClusterAutoRestartMessage into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ClusterAutoRestartMessage

Deserializes the ClusterAutoRestartMessage from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessageEnablementDetails

Contains an information about the enablement status judging (e.g. whether the enterprise tier is enabled) This is only additional information that MUST NOT be used to decide whether the setting is enabled or not. This is intended to use only for purposes like showing an error message to the customer with the additional details. For example, using these details we can check why exactly the feature is disabled for this customer.

forced_for_compliance_mode: bool | None = None

The feature is force enabled if compliance mode is active

unavailable_for_disabled_entitlement: bool | None = None

The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)

unavailable_for_non_enterprise_tier: bool | None = None

The feature is unavailable if the customer doesn’t have enterprise tier

as_dict() → dict

Serializes the ClusterAutoRestartMessageEnablementDetails into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ClusterAutoRestartMessageEnablementDetails

Deserializes the ClusterAutoRestartMessageEnablementDetails from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindow

week_day_based_schedule: ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule | None = None

as_dict() → dict

Serializes the ClusterAutoRestartMessageMaintenanceWindow into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ClusterAutoRestartMessageMaintenanceWindow

Deserializes the ClusterAutoRestartMessageMaintenanceWindow from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek

DAY_OF_WEEK_UNSPECIFIED = "DAY_OF_WEEK_UNSPECIFIED"

FRIDAY = "FRIDAY"

MONDAY = "MONDAY"

SATURDAY = "SATURDAY"

SUNDAY = "SUNDAY"

THURSDAY = "THURSDAY"

TUESDAY = "TUESDAY"

WEDNESDAY = "WEDNESDAY"

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule

day_of_week: ClusterAutoRestartMessageMaintenanceWindowDayOfWeek | None = None

frequency: ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency | None = None

window_start_time: ClusterAutoRestartMessageMaintenanceWindowWindowStartTime | None = None

as_dict() → dict

Serializes the ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule

Deserializes the ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency

EVERY_WEEK = "EVERY_WEEK"

FIRST_AND_THIRD_OF_MONTH = "FIRST_AND_THIRD_OF_MONTH"

FIRST_OF_MONTH = "FIRST_OF_MONTH"

FOURTH_OF_MONTH = "FOURTH_OF_MONTH"

SECOND_AND_FOURTH_OF_MONTH = "SECOND_AND_FOURTH_OF_MONTH"

SECOND_OF_MONTH = "SECOND_OF_MONTH"

THIRD_OF_MONTH = "THIRD_OF_MONTH"

WEEK_DAY_FREQUENCY_UNSPECIFIED = "WEEK_DAY_FREQUENCY_UNSPECIFIED"

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime

hours: int | None = None

minutes: int | None = None

as_dict() → dict

Serializes the ClusterAutoRestartMessageMaintenanceWindowWindowStartTime into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ClusterAutoRestartMessageMaintenanceWindowWindowStartTime

Deserializes the ClusterAutoRestartMessageMaintenanceWindowWindowStartTime from a dictionary.

class databricks.sdk.service.settings.ComplianceSecurityProfile

SHIELD feature: CSP

compliance_standards: List[ComplianceStandard] | None = None

Set by customers when they request Compliance Security Profile (CSP)

is_enabled: bool | None = None

as_dict() → dict

Serializes the ComplianceSecurityProfile into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ComplianceSecurityProfile

Deserializes the ComplianceSecurityProfile from a dictionary.

class databricks.sdk.service.settings.ComplianceSecurityProfileSetting

compliance_security_profile_workspace: ComplianceSecurityProfile

SHIELD feature: CSP

etag: str | None = None

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

setting_name: str | None = None

Name of the corresponding setting. This field is populated in the response, but it will not be respected even if it’s set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be ‘default’ if the setting only has one instance per workspace.

as_dict() → dict

Serializes the ComplianceSecurityProfileSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ComplianceSecurityProfileSetting

Deserializes the ComplianceSecurityProfileSetting from a dictionary.

class databricks.sdk.service.settings.ComplianceStandard

Compliance stardard for SHIELD customers

COMPLIANCE_STANDARD_UNSPECIFIED = "COMPLIANCE_STANDARD_UNSPECIFIED"

FEDRAMP_HIGH = "FEDRAMP_HIGH"

FEDRAMP_IL5 = "FEDRAMP_IL5"

FEDRAMP_MODERATE = "FEDRAMP_MODERATE"

HIPAA = "HIPAA"

IRAP_PROTECTED = "IRAP_PROTECTED"

ITAR_EAR = "ITAR_EAR"

NONE = "NONE"

PCI_DSS = "PCI_DSS"

class databricks.sdk.service.settings.CreateIpAccessList

Details required to configure a block list or allow list.

label: str

Label for the IP access list. This cannot be empty.

list_type: ListType

Type of IP access list. Valid values are as follows and are case-sensitive:

• ALLOW: An allow list. Include this IP or range. * BLOCK: A block list. Exclude this IP or

range. IP addresses in the block list are excluded even if they are included in an allow list.

ip_addresses: List[str] | None = None

as_dict() → dict

Serializes the CreateIpAccessList into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateIpAccessList

Deserializes the CreateIpAccessList from a dictionary.

class databricks.sdk.service.settings.CreateIpAccessListResponse

An IP access list was successfully created.

ip_access_list: IpAccessListInfo | None = None

Definition of an IP Access list

as_dict() → dict

Serializes the CreateIpAccessListResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateIpAccessListResponse

Deserializes the CreateIpAccessListResponse from a dictionary.

class databricks.sdk.service.settings.CreateNetworkConnectivityConfigRequest

name: str

The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular expression ^[0-9a-zA-Z-_]{3,30}$.

region: str

The region for the network connectivity configuration. Only workspaces in the same region can be attached to the network connectivity configuration.

as_dict() → dict

Serializes the CreateNetworkConnectivityConfigRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateNetworkConnectivityConfigRequest

Deserializes the CreateNetworkConnectivityConfigRequest from a dictionary.

class databricks.sdk.service.settings.CreateOboTokenRequest

Configuration details for creating on-behalf tokens.

application_id: str

Application ID of the service principal.

comment: str | None = None

Comment that describes the purpose of the token.

lifetime_seconds: int | None = None

The number of seconds before the token expires.

as_dict() → dict

Serializes the CreateOboTokenRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateOboTokenRequest

Deserializes the CreateOboTokenRequest from a dictionary.

class databricks.sdk.service.settings.CreateOboTokenResponse

An on-behalf token was successfully created for the service principal.

token_info: TokenInfo | None = None

token_value: str | None = None

Value of the token.

as_dict() → dict

Serializes the CreateOboTokenResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateOboTokenResponse

Deserializes the CreateOboTokenResponse from a dictionary.

class databricks.sdk.service.settings.CreatePrivateEndpointRuleRequest

resource_id: str

The Azure resource ID of the target resource.

group_id: CreatePrivateEndpointRuleRequestGroupId

The sub-resource type (group ID) of the target resource. Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.

network_connectivity_config_id: str | None = None

Your Network Connectvity Configuration ID.

as_dict() → dict

Serializes the CreatePrivateEndpointRuleRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreatePrivateEndpointRuleRequest

Deserializes the CreatePrivateEndpointRuleRequest from a dictionary.

class databricks.sdk.service.settings.CreatePrivateEndpointRuleRequestGroupId

The sub-resource type (group ID) of the target resource. Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.

BLOB = "BLOB"

DFS = "DFS"

MYSQL_SERVER = "MYSQL_SERVER"

SQL_SERVER = "SQL_SERVER"

class databricks.sdk.service.settings.CreateTokenRequest

comment: str | None = None

Optional description to attach to the token.

lifetime_seconds: int | None = None

The lifetime of the token, in seconds.

If the lifetime is not specified, this token remains valid indefinitely.

as_dict() → dict

Serializes the CreateTokenRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateTokenRequest

Deserializes the CreateTokenRequest from a dictionary.

class databricks.sdk.service.settings.CreateTokenResponse

token_info: PublicTokenInfo | None = None

The information for the new token.

token_value: str | None = None

The value of the new token.

as_dict() → dict

Serializes the CreateTokenResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateTokenResponse

Deserializes the CreateTokenResponse from a dictionary.

class databricks.sdk.service.settings.CspEnablementAccount

Account level policy for CSP

compliance_standards: List[ComplianceStandard] | None = None

Set by customers when they request Compliance Security Profile (CSP) Invariants are enforced in Settings policy.

is_enforced: bool | None = None

Enforced = it cannot be overriden at workspace level.

as_dict() → dict

Serializes the CspEnablementAccount into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CspEnablementAccount

Deserializes the CspEnablementAccount from a dictionary.

class databricks.sdk.service.settings.CspEnablementAccountSetting

csp_enablement_account: CspEnablementAccount

Account level policy for CSP

etag: str | None = None

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

setting_name: str | None = None

Name of the corresponding setting. This field is populated in the response, but it will not be respected even if it’s set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be ‘default’ if the setting only has one instance per workspace.

as_dict() → dict

Serializes the CspEnablementAccountSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CspEnablementAccountSetting

Deserializes the CspEnablementAccountSetting from a dictionary.

class databricks.sdk.service.settings.DefaultNamespaceSetting

This represents the setting configuration for the default namespace in the Databricks workspace. Setting the default catalog for the workspace determines the catalog that is used when queries do not reference a fully qualified 3 level name. For example, if the default catalog is set to ‘retail_prod’ then a query ‘SELECT * FROM myTable’ would reference the object ‘retail_prod.default.myTable’ (the schema ‘default’ is always assumed). This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.

namespace: StringMessage

etag: str | None = None

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

setting_name: str | None = None

Name of the corresponding setting. This field is populated in the response, but it will not be respected even if it’s set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be ‘default’ if the setting only has one instance per workspace.

as_dict() → dict

Serializes the DefaultNamespaceSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DefaultNamespaceSetting

Deserializes the DefaultNamespaceSetting from a dictionary.

class databricks.sdk.service.settings.DeleteDefaultNamespaceSettingResponse

The etag is returned.

etag: str

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the DELETE request to identify the rule set version you are deleting.

as_dict() → dict

Serializes the DeleteDefaultNamespaceSettingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteDefaultNamespaceSettingResponse

Deserializes the DeleteDefaultNamespaceSettingResponse from a dictionary.

class databricks.sdk.service.settings.DeleteNetworkConnectivityConfigurationResponse

as_dict() → dict

Serializes the DeleteNetworkConnectivityConfigurationResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteNetworkConnectivityConfigurationResponse

Deserializes the DeleteNetworkConnectivityConfigurationResponse from a dictionary.

class databricks.sdk.service.settings.DeletePersonalComputeSettingResponse

The etag is returned.

etag: str

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the DELETE request to identify the rule set version you are deleting.

as_dict() → dict

Serializes the DeletePersonalComputeSettingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeletePersonalComputeSettingResponse

Deserializes the DeletePersonalComputeSettingResponse from a dictionary.

class databricks.sdk.service.settings.DeleteResponse

as_dict() → dict

Serializes the DeleteResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteResponse

Deserializes the DeleteResponse from a dictionary.

class databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingResponse

The etag is returned.

etag: str

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the DELETE request to identify the rule set version you are deleting.

as_dict() → dict

Serializes the DeleteRestrictWorkspaceAdminsSettingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteRestrictWorkspaceAdminsSettingResponse

Deserializes the DeleteRestrictWorkspaceAdminsSettingResponse from a dictionary.

class databricks.sdk.service.settings.EnhancedSecurityMonitoring

SHIELD feature: ESM

is_enabled: bool | None = None

as_dict() → dict

Serializes the EnhancedSecurityMonitoring into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EnhancedSecurityMonitoring

Deserializes the EnhancedSecurityMonitoring from a dictionary.

class databricks.sdk.service.settings.EnhancedSecurityMonitoringSetting

enhanced_security_monitoring_workspace: EnhancedSecurityMonitoring

SHIELD feature: ESM

etag: str | None = None

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

setting_name: str | None = None

Name of the corresponding setting. This field is populated in the response, but it will not be respected even if it’s set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be ‘default’ if the setting only has one instance per workspace.

as_dict() → dict

Serializes the EnhancedSecurityMonitoringSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EnhancedSecurityMonitoringSetting

Deserializes the EnhancedSecurityMonitoringSetting from a dictionary.

class databricks.sdk.service.settings.EsmEnablementAccount

Account level policy for ESM

is_enforced: bool | None = None

as_dict() → dict

Serializes the EsmEnablementAccount into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EsmEnablementAccount

Deserializes the EsmEnablementAccount from a dictionary.

class databricks.sdk.service.settings.EsmEnablementAccountSetting

esm_enablement_account: EsmEnablementAccount

Account level policy for ESM

etag: str | None = None

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

setting_name: str | None = None

Name of the corresponding setting. This field is populated in the response, but it will not be respected even if it’s set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be ‘default’ if the setting only has one instance per workspace.

as_dict() → dict

Serializes the EsmEnablementAccountSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EsmEnablementAccountSetting

Deserializes the EsmEnablementAccountSetting from a dictionary.

class databricks.sdk.service.settings.ExchangeToken

The exchange token is the result of the token exchange with the IdP

credential: str | None = None

The requested token.

credential_eol_time: int | None = None

The end-of-life timestamp of the token. The value is in milliseconds since the Unix epoch.

owner_id: int | None = None

User ID of the user that owns this token.

scopes: List[str] | None = None

The scopes of access granted in the token.

token_type: TokenType | None = None

The type of this exchange token

as_dict() → dict

Serializes the ExchangeToken into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExchangeToken

Deserializes the ExchangeToken from a dictionary.

class databricks.sdk.service.settings.ExchangeTokenRequest

Exchange a token with the IdP

partition_id: PartitionId

The partition of Credentials store

token_type: List[TokenType]

A list of token types being requested

scopes: List[str]

Array of scopes for the token request.

as_dict() → dict

Serializes the ExchangeTokenRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExchangeTokenRequest

Deserializes the ExchangeTokenRequest from a dictionary.

class databricks.sdk.service.settings.ExchangeTokenResponse

Exhanged tokens were successfully returned.

values: List[ExchangeToken] | None = None

as_dict() → dict

Serializes the ExchangeTokenResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExchangeTokenResponse

Deserializes the ExchangeTokenResponse from a dictionary.

class databricks.sdk.service.settings.FetchIpAccessListResponse

An IP access list was successfully returned.

ip_access_list: IpAccessListInfo | None = None

Definition of an IP Access list

as_dict() → dict

Serializes the FetchIpAccessListResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FetchIpAccessListResponse

Deserializes the FetchIpAccessListResponse from a dictionary.

class databricks.sdk.service.settings.GetIpAccessListResponse

ip_access_list: IpAccessListInfo | None = None

Definition of an IP Access list

as_dict() → dict

Serializes the GetIpAccessListResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetIpAccessListResponse

Deserializes the GetIpAccessListResponse from a dictionary.

class databricks.sdk.service.settings.GetIpAccessListsResponse

IP access lists were successfully returned.

ip_access_lists: List[IpAccessListInfo] | None = None

as_dict() → dict

Serializes the GetIpAccessListsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetIpAccessListsResponse

Deserializes the GetIpAccessListsResponse from a dictionary.

class databricks.sdk.service.settings.GetTokenPermissionLevelsResponse

permission_levels: List[TokenPermissionsDescription] | None = None

Specific permission levels

as_dict() → dict

Serializes the GetTokenPermissionLevelsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetTokenPermissionLevelsResponse

Deserializes the GetTokenPermissionLevelsResponse from a dictionary.

class databricks.sdk.service.settings.GetTokenResponse

Token with specified Token ID was successfully returned.

token_info: TokenInfo | None = None

as_dict() → dict

Serializes the GetTokenResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetTokenResponse

Deserializes the GetTokenResponse from a dictionary.

class databricks.sdk.service.settings.IpAccessListInfo

Definition of an IP Access list

address_count: int | None = None

Total number of IP or CIDR values.

created_at: int | None = None

Creation timestamp in milliseconds.

created_by: int | None = None

User ID of the user who created this list.

enabled: bool | None = None

Specifies whether this IP access list is enabled.

ip_addresses: List[str] | None = None

label: str | None = None

Label for the IP access list. This cannot be empty.

list_id: str | None = None

Universally unique identifier (UUID) of the IP access list.

list_type: ListType | None = None

Type of IP access list. Valid values are as follows and are case-sensitive:

• ALLOW: An allow list. Include this IP or range. * BLOCK: A block list. Exclude this IP or

range. IP addresses in the block list are excluded even if they are included in an allow list.

updated_at: int | None = None

Update timestamp in milliseconds.

updated_by: int | None = None

User ID of the user who updated this list.

as_dict() → dict

Serializes the IpAccessListInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → IpAccessListInfo

Deserializes the IpAccessListInfo from a dictionary.

class databricks.sdk.service.settings.ListIpAccessListResponse

IP access lists were successfully returned.

ip_access_lists: List[IpAccessListInfo] | None = None

as_dict() → dict

Serializes the ListIpAccessListResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListIpAccessListResponse

Deserializes the ListIpAccessListResponse from a dictionary.

class databricks.sdk.service.settings.ListNccAzurePrivateEndpointRulesResponse

items: List[NccAzurePrivateEndpointRule] | None = None

next_page_token: str | None = None

A token that can be used to get the next page of results. If null, there are no more results to show.

as_dict() → dict

Serializes the ListNccAzurePrivateEndpointRulesResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListNccAzurePrivateEndpointRulesResponse

Deserializes the ListNccAzurePrivateEndpointRulesResponse from a dictionary.

class databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsResponse

items: List[NetworkConnectivityConfiguration] | None = None

next_page_token: str | None = None

A token that can be used to get the next page of results. If null, there are no more results to show.

as_dict() → dict

Serializes the ListNetworkConnectivityConfigurationsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListNetworkConnectivityConfigurationsResponse

Deserializes the ListNetworkConnectivityConfigurationsResponse from a dictionary.

class databricks.sdk.service.settings.ListPublicTokensResponse

token_infos: List[PublicTokenInfo] | None = None

The information for each token.

as_dict() → dict

Serializes the ListPublicTokensResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListPublicTokensResponse

Deserializes the ListPublicTokensResponse from a dictionary.

class databricks.sdk.service.settings.ListTokensResponse

Tokens were successfully returned.

token_infos: List[TokenInfo] | None = None

Token metadata of each user-created token in the workspace

as_dict() → dict

Serializes the ListTokensResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListTokensResponse

Deserializes the ListTokensResponse from a dictionary.

class databricks.sdk.service.settings.ListType

Type of IP access list. Valid values are as follows and are case-sensitive: * ALLOW: An allow list. Include this IP or range. * BLOCK: A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list.

ALLOW = "ALLOW"

BLOCK = "BLOCK"

class databricks.sdk.service.settings.NccAwsStableIpRule

The stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to allow traffic from your Databricks workspace.

cidr_blocks: List[str] | None = None

The list of stable IP CIDR blocks from which Databricks network traffic originates when accessing your resources.

as_dict() → dict

Serializes the NccAwsStableIpRule into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → NccAwsStableIpRule

Deserializes the NccAwsStableIpRule from a dictionary.

class databricks.sdk.service.settings.NccAzurePrivateEndpointRule

connection_state: NccAzurePrivateEndpointRuleConnectionState | None = None

The current status of this private endpoint. The private endpoint rules are effective only if the connection state is ESTABLISHED. Remember that you must approve new endpoints on your resources in the Azure portal before they take effect.

The possible values are: - INIT: (deprecated) The endpoint has been created and pending approval. - PENDING: The endpoint has been created and pending approval. - ESTABLISHED: The endpoint has been approved and is ready to use in your serverless compute resources. - REJECTED: Connection was rejected by the private link resource owner. - DISCONNECTED: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.

creation_time: int | None = None

Time in epoch milliseconds when this object was created.

deactivated: bool | None = None

Whether this private endpoint is deactivated.

deactivated_at: int | None = None

Time in epoch milliseconds when this object was deactivated.

endpoint_name: str | None = None

The name of the Azure private endpoint resource.

group_id: NccAzurePrivateEndpointRuleGroupId | None = None

The sub-resource type (group ID) of the target resource. Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.

network_connectivity_config_id: str | None = None

The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.

resource_id: str | None = None

The Azure resource ID of the target resource.

rule_id: str | None = None

The ID of a private endpoint rule.

updated_time: int | None = None

Time in epoch milliseconds when this object was updated.

as_dict() → dict

Serializes the NccAzurePrivateEndpointRule into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → NccAzurePrivateEndpointRule

Deserializes the NccAzurePrivateEndpointRule from a dictionary.

class databricks.sdk.service.settings.NccAzurePrivateEndpointRuleConnectionState

The current status of this private endpoint. The private endpoint rules are effective only if the connection state is ESTABLISHED. Remember that you must approve new endpoints on your resources in the Azure portal before they take effect. The possible values are: - INIT: (deprecated) The endpoint has been created and pending approval. - PENDING: The endpoint has been created and pending approval. - ESTABLISHED: The endpoint has been approved and is ready to use in your serverless compute resources. - REJECTED: Connection was rejected by the private link resource owner. - DISCONNECTED: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.

DISCONNECTED = "DISCONNECTED"

ESTABLISHED = "ESTABLISHED"

INIT = "INIT"

PENDING = "PENDING"

REJECTED = "REJECTED"

class databricks.sdk.service.settings.NccAzurePrivateEndpointRuleGroupId

The sub-resource type (group ID) of the target resource. Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.

BLOB = "BLOB"

DFS = "DFS"

MYSQL_SERVER = "MYSQL_SERVER"

SQL_SERVER = "SQL_SERVER"

class databricks.sdk.service.settings.NccAzureServiceEndpointRule

The stable Azure service endpoints. You can configure the firewall of your Azure resources to allow traffic from your Databricks serverless compute resources.

subnets: List[str] | None = None

The list of subnets from which Databricks network traffic originates when accessing your Azure resources.

target_region: str | None = None

The Azure region in which this service endpoint rule applies.

target_services: List[str] | None = None

The Azure services to which this service endpoint rule applies to.

as_dict() → dict

Serializes the NccAzureServiceEndpointRule into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → NccAzureServiceEndpointRule

Deserializes the NccAzureServiceEndpointRule from a dictionary.

class databricks.sdk.service.settings.NccEgressConfig

The network connectivity rules that apply to network traffic from your serverless compute resources.

default_rules: NccEgressDefaultRules | None = None

The network connectivity rules that are applied by default without resource specific configurations. You can find the stable network information of your serverless compute resources here.

target_rules: NccEgressTargetRules | None = None

The network connectivity rules that configured for each destinations. These rules override default rules.

as_dict() → dict

Serializes the NccEgressConfig into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → NccEgressConfig

Deserializes the NccEgressConfig from a dictionary.

class databricks.sdk.service.settings.NccEgressDefaultRules

The network connectivity rules that are applied by default without resource specific configurations. You can find the stable network information of your serverless compute resources here.

aws_stable_ip_rule: NccAwsStableIpRule | None = None

The stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to allow traffic from your Databricks workspace.

azure_service_endpoint_rule: NccAzureServiceEndpointRule | None = None

The stable Azure service endpoints. You can configure the firewall of your Azure resources to allow traffic from your Databricks serverless compute resources.

as_dict() → dict

Serializes the NccEgressDefaultRules into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → NccEgressDefaultRules

Deserializes the NccEgressDefaultRules from a dictionary.

class databricks.sdk.service.settings.NccEgressTargetRules

The network connectivity rules that configured for each destinations. These rules override default rules.

azure_private_endpoint_rules: List[NccAzurePrivateEndpointRule] | None = None

as_dict() → dict

Serializes the NccEgressTargetRules into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → NccEgressTargetRules

Deserializes the NccEgressTargetRules from a dictionary.

class databricks.sdk.service.settings.NetworkConnectivityConfiguration

account_id: str | None = None

The Databricks account ID that hosts the credential.

creation_time: int | None = None

Time in epoch milliseconds when this object was created.

egress_config: NccEgressConfig | None = None

The network connectivity rules that apply to network traffic from your serverless compute resources.

name: str | None = None

The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular expression ^[0-9a-zA-Z-_]{3,30}$.

network_connectivity_config_id: str | None = None

Databricks network connectivity configuration ID.

region: str | None = None

The region for the network connectivity configuration. Only workspaces in the same region can be attached to the network connectivity configuration.

updated_time: int | None = None

Time in epoch milliseconds when this object was updated.

as_dict() → dict

Serializes the NetworkConnectivityConfiguration into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → NetworkConnectivityConfiguration

Deserializes the NetworkConnectivityConfiguration from a dictionary.

class databricks.sdk.service.settings.PartitionId

Partition by workspace or account

workspace_id: int | None = None

The ID of the workspace.

as_dict() → dict

Serializes the PartitionId into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PartitionId

Deserializes the PartitionId from a dictionary.

class databricks.sdk.service.settings.PersonalComputeMessage

value: PersonalComputeMessageEnum

ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing all users to create single-machine compute resources. DELEGATE: Moves access control for the Personal Compute default policy to individual workspaces and requires a workspace’s users or groups to be added to the ACLs of that workspace’s Personal Compute default policy before they will be able to create compute resources through that policy.

as_dict() → dict

Serializes the PersonalComputeMessage into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PersonalComputeMessage

Deserializes the PersonalComputeMessage from a dictionary.

class databricks.sdk.service.settings.PersonalComputeMessageEnum

ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing all users to create single-machine compute resources. DELEGATE: Moves access control for the Personal Compute default policy to individual workspaces and requires a workspace’s users or groups to be added to the ACLs of that workspace’s Personal Compute default policy before they will be able to create compute resources through that policy.

DELEGATE = "DELEGATE"

ON = "ON"

class databricks.sdk.service.settings.PersonalComputeSetting

personal_compute: PersonalComputeMessage

etag: str | None = None

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

setting_name: str | None = None

Name of the corresponding setting. This field is populated in the response, but it will not be respected even if it’s set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be ‘default’ if the setting only has one instance per workspace.

as_dict() → dict

Serializes the PersonalComputeSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PersonalComputeSetting

Deserializes the PersonalComputeSetting from a dictionary.

class databricks.sdk.service.settings.PublicTokenInfo

comment: str | None = None

Comment the token was created with, if applicable.

creation_time: int | None = None

Server time (in epoch milliseconds) when the token was created.

expiry_time: int | None = None

Server time (in epoch milliseconds) when the token will expire, or -1 if not applicable.

token_id: str | None = None

The ID of this token.

as_dict() → dict

Serializes the PublicTokenInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PublicTokenInfo

Deserializes the PublicTokenInfo from a dictionary.

class databricks.sdk.service.settings.ReplaceIpAccessList

Details required to replace an IP access list.

label: str

Label for the IP access list. This cannot be empty.

list_type: ListType

Type of IP access list. Valid values are as follows and are case-sensitive:

• ALLOW: An allow list. Include this IP or range. * BLOCK: A block list. Exclude this IP or

range. IP addresses in the block list are excluded even if they are included in an allow list.

enabled: bool

Specifies whether this IP access list is enabled.

ip_access_list_id: str | None = None

The ID for the corresponding IP access list

ip_addresses: List[str] | None = None

as_dict() → dict

Serializes the ReplaceIpAccessList into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ReplaceIpAccessList

Deserializes the ReplaceIpAccessList from a dictionary.

class databricks.sdk.service.settings.ReplaceResponse

as_dict() → dict

Serializes the ReplaceResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ReplaceResponse

Deserializes the ReplaceResponse from a dictionary.

class databricks.sdk.service.settings.RestrictWorkspaceAdminsMessage

status: RestrictWorkspaceAdminsMessageStatus

as_dict() → dict

Serializes the RestrictWorkspaceAdminsMessage into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RestrictWorkspaceAdminsMessage

Deserializes the RestrictWorkspaceAdminsMessage from a dictionary.

class databricks.sdk.service.settings.RestrictWorkspaceAdminsMessageStatus

ALLOW_ALL = "ALLOW_ALL"

RESTRICT_TOKENS_AND_JOB_RUN_AS = "RESTRICT_TOKENS_AND_JOB_RUN_AS"

STATUS_UNSPECIFIED = "STATUS_UNSPECIFIED"

class databricks.sdk.service.settings.RestrictWorkspaceAdminsSetting

restrict_workspace_admins: RestrictWorkspaceAdminsMessage

etag: str | None = None

etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

setting_name: str | None = None

Name of the corresponding setting. This field is populated in the response, but it will not be respected even if it’s set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be ‘default’ if the setting only has one instance per workspace.

as_dict() → dict

Serializes the RestrictWorkspaceAdminsSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RestrictWorkspaceAdminsSetting

Deserializes the RestrictWorkspaceAdminsSetting from a dictionary.

class databricks.sdk.service.settings.RevokeTokenRequest

token_id: str

The ID of the token to be revoked.

as_dict() → dict

Serializes the RevokeTokenRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RevokeTokenRequest

Deserializes the RevokeTokenRequest from a dictionary.

class databricks.sdk.service.settings.RevokeTokenResponse

as_dict() → dict

Serializes the RevokeTokenResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RevokeTokenResponse

Deserializes the RevokeTokenResponse from a dictionary.

class databricks.sdk.service.settings.SetStatusResponse

as_dict() → dict

Serializes the SetStatusResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetStatusResponse

Deserializes the SetStatusResponse from a dictionary.

class databricks.sdk.service.settings.StringMessage

value: str | None = None

Represents a generic string value.

as_dict() → dict

Serializes the StringMessage into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → StringMessage

Deserializes the StringMessage from a dictionary.

class databricks.sdk.service.settings.TokenAccessControlRequest

group_name: str | None = None

name of the group

permission_level: TokenPermissionLevel | None = None

Permission level

service_principal_name: str | None = None

application ID of a service principal

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the TokenAccessControlRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenAccessControlRequest

Deserializes the TokenAccessControlRequest from a dictionary.

class databricks.sdk.service.settings.TokenAccessControlResponse

all_permissions: List[TokenPermission] | None = None

All permissions.

display_name: str | None = None

Display name of the user or service principal.

group_name: str | None = None

name of the group

service_principal_name: str | None = None

Name of the service principal.

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the TokenAccessControlResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenAccessControlResponse

Deserializes the TokenAccessControlResponse from a dictionary.

class databricks.sdk.service.settings.TokenInfo

comment: str | None = None

Comment that describes the purpose of the token, specified by the token creator.

created_by_id: int | None = None

User ID of the user that created the token.

created_by_username: str | None = None

Username of the user that created the token.

creation_time: int | None = None

Timestamp when the token was created.

expiry_time: int | None = None

Timestamp when the token expires.

owner_id: int | None = None

User ID of the user that owns the token.

token_id: str | None = None

ID of the token.

as_dict() → dict

Serializes the TokenInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenInfo

Deserializes the TokenInfo from a dictionary.

class databricks.sdk.service.settings.TokenPermission

inherited: bool | None = None

inherited_from_object: List[str] | None = None

permission_level: TokenPermissionLevel | None = None

Permission level

as_dict() → dict

Serializes the TokenPermission into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenPermission

Deserializes the TokenPermission from a dictionary.

class databricks.sdk.service.settings.TokenPermissionLevel

Permission level

CAN_USE = "CAN_USE"

class databricks.sdk.service.settings.TokenPermissions

access_control_list: List[TokenAccessControlResponse] | None = None

object_id: str | None = None

object_type: str | None = None

as_dict() → dict

Serializes the TokenPermissions into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenPermissions

Deserializes the TokenPermissions from a dictionary.

class databricks.sdk.service.settings.TokenPermissionsDescription

description: str | None = None

permission_level: TokenPermissionLevel | None = None

Permission level

as_dict() → dict

Serializes the TokenPermissionsDescription into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenPermissionsDescription

Deserializes the TokenPermissionsDescription from a dictionary.

class databricks.sdk.service.settings.TokenPermissionsRequest

access_control_list: List[TokenAccessControlRequest] | None = None

as_dict() → dict

Serializes the TokenPermissionsRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenPermissionsRequest

Deserializes the TokenPermissionsRequest from a dictionary.

class databricks.sdk.service.settings.TokenType

The type of token request. As of now, only AZURE_ACTIVE_DIRECTORY_TOKEN is supported.

AZURE_ACTIVE_DIRECTORY_TOKEN = "AZURE_ACTIVE_DIRECTORY_TOKEN"

class databricks.sdk.service.settings.UpdateAutomaticClusterUpdateSettingRequest

Details required to update a setting.

allow_missing: bool

This should always be set to true for Settings API. Added for AIP compliance.

setting: AutomaticClusterUpdateSetting

field_mask: str

Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the setting payload will be updated. The field mask needs to be supplied as single string. To specify multiple fields in the field mask, use comma as the separator (no space).

as_dict() → dict

Serializes the UpdateAutomaticClusterUpdateSettingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateAutomaticClusterUpdateSettingRequest

Deserializes the UpdateAutomaticClusterUpdateSettingRequest from a dictionary.

class databricks.sdk.service.settings.UpdateComplianceSecurityProfileSettingRequest

Details required to update a setting.

allow_missing: bool

This should always be set to true for Settings API. Added for AIP compliance.

setting: ComplianceSecurityProfileSetting

field_mask: str

Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the setting payload will be updated. The field mask needs to be supplied as single string. To specify multiple fields in the field mask, use comma as the separator (no space).

as_dict() → dict

Serializes the UpdateComplianceSecurityProfileSettingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateComplianceSecurityProfileSettingRequest

Deserializes the UpdateComplianceSecurityProfileSettingRequest from a dictionary.

class databricks.sdk.service.settings.UpdateCspEnablementAccountSettingRequest

Details required to update a setting.

allow_missing: bool

This should always be set to true for Settings API. Added for AIP compliance.

setting: CspEnablementAccountSetting

field_mask: str

Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the setting payload will be updated. The field mask needs to be supplied as single string. To specify multiple fields in the field mask, use comma as the separator (no space).

as_dict() → dict

Serializes the UpdateCspEnablementAccountSettingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateCspEnablementAccountSettingRequest

Deserializes the UpdateCspEnablementAccountSettingRequest from a dictionary.

class databricks.sdk.service.settings.UpdateDefaultNamespaceSettingRequest

Details required to update a setting.

allow_missing: bool

This should always be set to true for Settings API. Added for AIP compliance.

setting: DefaultNamespaceSetting

This represents the setting configuration for the default namespace in the Databricks workspace. Setting the default catalog for the workspace determines the catalog that is used when queries do not reference a fully qualified 3 level name. For example, if the default catalog is set to ‘retail_prod’ then a query ‘SELECT * FROM myTable’ would reference the object ‘retail_prod.default.myTable’ (the schema ‘default’ is always assumed). This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.

field_mask: str

Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the setting payload will be updated. The field mask needs to be supplied as single string. To specify multiple fields in the field mask, use comma as the separator (no space).

as_dict() → dict

Serializes the UpdateDefaultNamespaceSettingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateDefaultNamespaceSettingRequest

Deserializes the UpdateDefaultNamespaceSettingRequest from a dictionary.

class databricks.sdk.service.settings.UpdateEnhancedSecurityMonitoringSettingRequest

Details required to update a setting.

allow_missing: bool

This should always be set to true for Settings API. Added for AIP compliance.

setting: EnhancedSecurityMonitoringSetting

field_mask: str

Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the setting payload will be updated. The field mask needs to be supplied as single string. To specify multiple fields in the field mask, use comma as the separator (no space).

as_dict() → dict

Serializes the UpdateEnhancedSecurityMonitoringSettingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateEnhancedSecurityMonitoringSettingRequest

Deserializes the UpdateEnhancedSecurityMonitoringSettingRequest from a dictionary.

class databricks.sdk.service.settings.UpdateEsmEnablementAccountSettingRequest

Details required to update a setting.

allow_missing: bool

This should always be set to true for Settings API. Added for AIP compliance.

setting: EsmEnablementAccountSetting

field_mask: str

Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the setting payload will be updated. The field mask needs to be supplied as single string. To specify multiple fields in the field mask, use comma as the separator (no space).

as_dict() → dict

Serializes the UpdateEsmEnablementAccountSettingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateEsmEnablementAccountSettingRequest

Deserializes the UpdateEsmEnablementAccountSettingRequest from a dictionary.

class databricks.sdk.service.settings.UpdateIpAccessList

Details required to update an IP access list.

enabled: bool | None = None

Specifies whether this IP access list is enabled.

ip_access_list_id: str | None = None

The ID for the corresponding IP access list

ip_addresses: List[str] | None = None

label: str | None = None

Label for the IP access list. This cannot be empty.

list_type: ListType | None = None

Type of IP access list. Valid values are as follows and are case-sensitive:

• ALLOW: An allow list. Include this IP or range. * BLOCK: A block list. Exclude this IP or

range. IP addresses in the block list are excluded even if they are included in an allow list.

as_dict() → dict

Serializes the UpdateIpAccessList into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateIpAccessList

Deserializes the UpdateIpAccessList from a dictionary.

class databricks.sdk.service.settings.UpdatePersonalComputeSettingRequest

Details required to update a setting.

allow_missing: bool

This should always be set to true for Settings API. Added for AIP compliance.

setting: PersonalComputeSetting

field_mask: str

Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the setting payload will be updated. The field mask needs to be supplied as single string. To specify multiple fields in the field mask, use comma as the separator (no space).

as_dict() → dict

Serializes the UpdatePersonalComputeSettingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdatePersonalComputeSettingRequest

Deserializes the UpdatePersonalComputeSettingRequest from a dictionary.

class databricks.sdk.service.settings.UpdateResponse

as_dict() → dict

Serializes the UpdateResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateResponse

Deserializes the UpdateResponse from a dictionary.

class databricks.sdk.service.settings.UpdateRestrictWorkspaceAdminsSettingRequest

Details required to update a setting.

allow_missing: bool

This should always be set to true for Settings API. Added for AIP compliance.

setting: RestrictWorkspaceAdminsSetting

field_mask: str

Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the setting payload will be updated. The field mask needs to be supplied as single string. To specify multiple fields in the field mask, use comma as the separator (no space).

as_dict() → dict

Serializes the UpdateRestrictWorkspaceAdminsSettingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateRestrictWorkspaceAdminsSettingRequest

Deserializes the UpdateRestrictWorkspaceAdminsSettingRequest from a dictionary.