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.AccountIpAccessEnable(acct_ip_acl_enable: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

acct_ip_acl_enable: BooleanMessage

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 AccountIpAccessEnable into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AccountIpAccessEnable into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AccountIpAccessEnable

Deserializes the AccountIpAccessEnable from a dictionary.

class databricks.sdk.service.settings.AccountNetworkPolicy(account_id: 'Optional[str]' = None, egress: 'Optional[NetworkPolicyEgress]' = None, ingress: 'Optional[CustomerFacingIngressNetworkPolicy]' = None, ingress_dry_run: 'Optional[CustomerFacingIngressNetworkPolicy]' = None, network_policy_id: 'Optional[str]' = None)

account_id: str | None = None

The associated account ID for this Network Policy object.

egress: NetworkPolicyEgress | None = None

The network policies applying for egress traffic.

ingress: CustomerFacingIngressNetworkPolicy | None = None

The network policies applying for ingress traffic.

ingress_dry_run: CustomerFacingIngressNetworkPolicy | None = None

The ingress policy for dry run mode. Dry run will always run even if the request is allowed by the ingress policy. When this field is set, the policy will be evaluated and emit logs only without blocking requests.

network_policy_id: str | None = None

The unique identifier for the network policy.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the AccountNetworkPolicy into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AccountNetworkPolicy

Deserializes the AccountNetworkPolicy from a dictionary.

class databricks.sdk.service.settings.AibiDashboardEmbeddingAccessPolicy(access_policy_type: 'AibiDashboardEmbeddingAccessPolicyAccessPolicyType')

access_policy_type: AibiDashboardEmbeddingAccessPolicyAccessPolicyType

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the AibiDashboardEmbeddingAccessPolicy into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AibiDashboardEmbeddingAccessPolicy

Deserializes the AibiDashboardEmbeddingAccessPolicy from a dictionary.

class databricks.sdk.service.settings.AibiDashboardEmbeddingAccessPolicyAccessPolicyType

ALLOW_ALL_DOMAINS = "ALLOW_ALL_DOMAINS"

ALLOW_APPROVED_DOMAINS = "ALLOW_APPROVED_DOMAINS"

DENY_ALL_DOMAINS = "DENY_ALL_DOMAINS"

class databricks.sdk.service.settings.AibiDashboardEmbeddingAccessPolicySetting(aibi_dashboard_embedding_access_policy: 'AibiDashboardEmbeddingAccessPolicy', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

aibi_dashboard_embedding_access_policy: AibiDashboardEmbeddingAccessPolicy

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 AibiDashboardEmbeddingAccessPolicySetting into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AibiDashboardEmbeddingAccessPolicySetting into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AibiDashboardEmbeddingAccessPolicySetting

Deserializes the AibiDashboardEmbeddingAccessPolicySetting from a dictionary.

class databricks.sdk.service.settings.AibiDashboardEmbeddingApprovedDomains(approved_domains: 'Optional[List[str]]' = None)

approved_domains: List[str] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the AibiDashboardEmbeddingApprovedDomains into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AibiDashboardEmbeddingApprovedDomains

Deserializes the AibiDashboardEmbeddingApprovedDomains from a dictionary.

class databricks.sdk.service.settings.AibiDashboardEmbeddingApprovedDomainsSetting(aibi_dashboard_embedding_approved_domains: 'AibiDashboardEmbeddingApprovedDomains', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

aibi_dashboard_embedding_approved_domains: AibiDashboardEmbeddingApprovedDomains

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 AibiDashboardEmbeddingApprovedDomainsSetting into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AibiDashboardEmbeddingApprovedDomainsSetting into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AibiDashboardEmbeddingApprovedDomainsSetting

Deserializes the AibiDashboardEmbeddingApprovedDomainsSetting from a dictionary.

class databricks.sdk.service.settings.AutomaticClusterUpdateSetting(automatic_cluster_update_workspace: 'ClusterAutoRestartMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

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.

as_shallow_dict() → dict

Serializes the AutomaticClusterUpdateSetting into a shallow dictionary of its immediate attributes.

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

Deserializes the AutomaticClusterUpdateSetting from a dictionary.

class databricks.sdk.service.settings.BooleanMessage(value: 'Optional[bool]' = None)

value: bool | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the BooleanMessage into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → BooleanMessage

Deserializes the BooleanMessage from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessage(can_toggle: 'Optional[bool]' = None, enabled: 'Optional[bool]' = None, enablement_details: 'Optional[ClusterAutoRestartMessageEnablementDetails]' = None, maintenance_window: 'Optional[ClusterAutoRestartMessageMaintenanceWindow]' = None, restart_even_if_no_updates_available: 'Optional[bool]' = None)

can_toggle: bool | None = None

enabled: bool | None = None

enablement_details: ClusterAutoRestartMessageEnablementDetails | None = None

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.

as_shallow_dict() → dict

Serializes the ClusterAutoRestartMessage into a shallow dictionary of its immediate attributes.

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

Deserializes the ClusterAutoRestartMessage from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessageEnablementDetails(forced_for_compliance_mode: bool | None = None, unavailable_for_disabled_entitlement: bool | None = None, unavailable_for_non_enterprise_tier: bool | 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.

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.

as_shallow_dict() → dict

Serializes the ClusterAutoRestartMessageEnablementDetails into a shallow dictionary of its immediate attributes.

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

Deserializes the ClusterAutoRestartMessageEnablementDetails from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindow(week_day_based_schedule: 'Optional[ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule]' = None)

week_day_based_schedule: ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the ClusterAutoRestartMessageMaintenanceWindow into a shallow dictionary of its immediate attributes.

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

Deserializes the ClusterAutoRestartMessageMaintenanceWindow from a dictionary.

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek

FRIDAY = "FRIDAY"

MONDAY = "MONDAY"

SATURDAY = "SATURDAY"

SUNDAY = "SUNDAY"

THURSDAY = "THURSDAY"

TUESDAY = "TUESDAY"

WEDNESDAY = "WEDNESDAY"

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule(day_of_week: 'Optional[ClusterAutoRestartMessageMaintenanceWindowDayOfWeek]' = None, frequency: 'Optional[ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency]' = None, window_start_time: 'Optional[ClusterAutoRestartMessageMaintenanceWindowWindowStartTime]' = None)

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.

as_shallow_dict() → dict

Serializes the ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule into a shallow dictionary of its immediate attributes.

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"

class databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime(hours: 'Optional[int]' = None, minutes: 'Optional[int]' = None)

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.

as_shallow_dict() → dict

Serializes the ClusterAutoRestartMessageMaintenanceWindowWindowStartTime into a shallow dictionary of its immediate attributes.

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

Deserializes the ClusterAutoRestartMessageMaintenanceWindowWindowStartTime from a dictionary.

class databricks.sdk.service.settings.ComplianceSecurityProfile(compliance_standards: List[ComplianceStandard] | None = None, is_enabled: bool | None = None)

SHIELD feature: CSP Compliance Security Profile (CSP) enables enhanced compliance controls on the workspace.

compliance_standards: List[ComplianceStandard] | None = None

Compliance standards selected by the customer for this Compliance Security Profile.

is_enabled: bool | None = None

Whether Compliance Security Profile (CSP) is enabled on the workspace.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the ComplianceSecurityProfile into a shallow dictionary of its immediate attributes.

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', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

compliance_security_profile_workspace: ComplianceSecurityProfile

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.

as_shallow_dict() → dict

Serializes the ComplianceSecurityProfileSetting into a shallow dictionary of its immediate attributes.

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

Deserializes the ComplianceSecurityProfileSetting from a dictionary.

class databricks.sdk.service.settings.ComplianceStandard

Compliance standard for SHIELD customers. See README.md for how instructions of how to add new standards.

CANADA_PROTECTED_B = "CANADA_PROTECTED_B"

CYBER_ESSENTIAL_PLUS = "CYBER_ESSENTIAL_PLUS"

FEDRAMP_HIGH = "FEDRAMP_HIGH"

FEDRAMP_IL5 = "FEDRAMP_IL5"

FEDRAMP_MODERATE = "FEDRAMP_MODERATE"

GERMANY_C5 = "GERMANY_C5"

GERMANY_TISAX = "GERMANY_TISAX"

HIPAA = "HIPAA"

HITRUST = "HITRUST"

IRAP_PROTECTED = "IRAP_PROTECTED"

ISMAP = "ISMAP"

ITAR_EAR = "ITAR_EAR"

K_FSI = "K_FSI"

NONE = "NONE"

PCI_DSS = "PCI_DSS"

class databricks.sdk.service.settings.Config(email: 'Optional[EmailConfig]' = None, generic_webhook: 'Optional[GenericWebhookConfig]' = None, microsoft_teams: 'Optional[MicrosoftTeamsConfig]' = None, pagerduty: 'Optional[PagerdutyConfig]' = None, slack: 'Optional[SlackConfig]' = None)

email: EmailConfig | None = None

generic_webhook: GenericWebhookConfig | None = None

microsoft_teams: MicrosoftTeamsConfig | None = None

pagerduty: PagerdutyConfig | None = None

slack: SlackConfig | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the Config into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Config

Deserializes the Config from a dictionary.

class databricks.sdk.service.settings.CreateIpAccessListResponse(ip_access_list: IpAccessListInfo | None = None)

An IP access list was successfully created.

ip_access_list: IpAccessListInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CreateIpAccessListResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the CreateIpAccessListResponse from a dictionary.

class databricks.sdk.service.settings.CreateNetworkConnectivityConfiguration(name: str, region: str)

Properties of the new network connectivity configuration.

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 CreateNetworkConnectivityConfiguration into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CreateNetworkConnectivityConfiguration into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CreateNetworkConnectivityConfiguration

Deserializes the CreateNetworkConnectivityConfiguration from a dictionary.

class databricks.sdk.service.settings.CreateOboTokenResponse(token_info: TokenInfo | None = None, token_value: str | None = None)

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.

as_shallow_dict() → dict

Serializes the CreateOboTokenResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the CreateOboTokenResponse from a dictionary.

class databricks.sdk.service.settings.CreatePrivateEndpointRule(domain_names: List[str] | None = None, endpoint_service: str | None = None, error_message: str | None = None, gcp_endpoint: GcpEndpoint | None = None, group_id: str | None = None, resource_id: str | None = None, resource_names: List[str] | None = None)

Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

domain_names: List[str] | None = None

Only used by private endpoints to customer-managed private endpoint services.

Domain names of target private link service. When updating this field, the full list of target domain_names must be specified.

endpoint_service: str | None = None

The full target AWS endpoint service name that connects to the destination resources of the private endpoint.

error_message: str | None = None

gcp_endpoint: GcpEndpoint | None = None

group_id: str | None = None

Not used by customer-managed private endpoint services.

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.

resource_id: str | None = None

The Azure resource ID of the target resource.

resource_names: List[str] | None = None

Only used by private endpoints towards AWS S3 service.

The globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. When updating this field, we perform full update on this field. Please ensure a full list of desired resource_names is provided.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CreatePrivateEndpointRule into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CreatePrivateEndpointRule

Deserializes the CreatePrivateEndpointRule from a dictionary.

class databricks.sdk.service.settings.CreateTokenResponse(token_info: 'Optional[PublicTokenInfo]' = None, token_value: 'Optional[str]' = None)

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.

as_shallow_dict() → dict

Serializes the CreateTokenResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the CreateTokenResponse from a dictionary.

class databricks.sdk.service.settings.CspEnablementAccount(compliance_standards: List[ComplianceStandard] | None = None, is_enforced: bool | None = None)

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.

as_shallow_dict() → dict

Serializes the CspEnablementAccount into a shallow dictionary of its immediate attributes.

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

Deserializes the CspEnablementAccount from a dictionary.

class databricks.sdk.service.settings.CspEnablementAccountSetting(csp_enablement_account: 'CspEnablementAccount', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

csp_enablement_account: CspEnablementAccount

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.

as_shallow_dict() → dict

Serializes the CspEnablementAccountSetting into a shallow dictionary of its immediate attributes.

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

Deserializes the CspEnablementAccountSetting from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicy(cross_workspace_access: CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess | None = None, private_access: CustomerFacingIngressNetworkPolicyPrivateAccess | None = None, public_access: CustomerFacingIngressNetworkPolicyPublicAccess | None = None)

This proto is under development. The network policies applying for ingress traffic. Any changes here should also be synced to estore/namespaces/lakehousenetworkmanager/latest.proto.

cross_workspace_access: CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess | None = None

private_access: CustomerFacingIngressNetworkPolicyPrivateAccess | None = None

The network policy restrictions for private access to the workspace. Configures how registered private endpoints are allowed or denied access.

public_access: CustomerFacingIngressNetworkPolicyPublicAccess | None = None

The network policy restrictions for public access to the workspace. Configures how public internet traffic is allowed or denied access.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicy into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicy

Deserializes the CustomerFacingIngressNetworkPolicy from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyAccountApiDestination(scope_qualifier: 'Optional[CustomerFacingIngressNetworkPolicyApiScopeQualifier]' = None, scopes: 'Optional[List[str]]' = None)

scope_qualifier: CustomerFacingIngressNetworkPolicyApiScopeQualifier | None = None

Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier.

scopes: List[str] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyAccountApiDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyAccountApiDestination

Deserializes the CustomerFacingIngressNetworkPolicyAccountApiDestination from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination(all_destinations: 'Optional[bool]' = None)

all_destinations: bool | None = None

Must be set to true.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination

Deserializes the CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyAccountUiDestination(all_destinations: 'Optional[bool]' = None)

all_destinations: bool | None = None

Must be set to true.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyAccountUiDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyAccountUiDestination

Deserializes the CustomerFacingIngressNetworkPolicyAccountUiDestination from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyApiScopeQualifier

Qualifies the breadth of API access permitted by an ingress network policy rule. API_SCOPE_QUALIFIER_READ narrows matching to read-only variants of the listed scopes; API_SCOPE_QUALIFIER_ALL matches any scope. When unset, scopes match exactly as listed.

API_SCOPE_QUALIFIER_ALL = "API_SCOPE_QUALIFIER_ALL"

API_SCOPE_QUALIFIER_READ = "API_SCOPE_QUALIFIER_READ"

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyAppsRuntimeDestination(all_destinations: 'Optional[bool]' = None)

all_destinations: bool | None = None

Must be set to true.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyAppsRuntimeDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyAppsRuntimeDestination

Deserializes the CustomerFacingIngressNetworkPolicyAppsRuntimeDestination from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyAuthentication(identities: 'Optional[List[CustomerFacingIngressNetworkPolicyAuthenticationIdentity]]' = None, identity_type: 'Optional[CustomerFacingIngressNetworkPolicyAuthenticationIdentityType]' = None)

identities: List[CustomerFacingIngressNetworkPolicyAuthenticationIdentity] | None = None

Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES.

identity_type: CustomerFacingIngressNetworkPolicyAuthenticationIdentityType | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyAuthentication into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyAuthentication

Deserializes the CustomerFacingIngressNetworkPolicyAuthentication from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyAuthenticationIdentity(principal_id: 'Optional[int]' = None, principal_type: 'Optional[CustomerFacingIngressNetworkPolicyAuthenticationIdentityPrincipalType]' = None)

principal_id: int | None = None

principal_type: CustomerFacingIngressNetworkPolicyAuthenticationIdentityPrincipalType | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyAuthenticationIdentity into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyAuthenticationIdentity

Deserializes the CustomerFacingIngressNetworkPolicyAuthenticationIdentity from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyAuthenticationIdentityPrincipalType

PRINCIPAL_TYPE_SERVICE_PRINCIPAL = "PRINCIPAL_TYPE_SERVICE_PRINCIPAL"

PRINCIPAL_TYPE_USER = "PRINCIPAL_TYPE_USER"

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyAuthenticationIdentityType

IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS = "IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS"

IDENTITY_TYPE_ALL_USERS = "IDENTITY_TYPE_ALL_USERS"

IDENTITY_TYPE_SELECTED_IDENTITIES = "IDENTITY_TYPE_SELECTED_IDENTITIES"

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess(restriction_mode: 'CustomerFacingIngressNetworkPolicyCrossWorkspaceAccessRestrictionMode', allow_rules: 'Optional[List[CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule]]' = None, deny_rules: 'Optional[List[CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule]]' = None)

restriction_mode: CustomerFacingIngressNetworkPolicyCrossWorkspaceAccessRestrictionMode

allow_rules: List[CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule] | None = None

deny_rules: List[CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess

Deserializes the CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceAccessRestrictionMode

FULL_ACCESS = "FULL_ACCESS"

RESTRICTED_ACCESS = "RESTRICTED_ACCESS"

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule(authentication: 'Optional[CustomerFacingIngressNetworkPolicyAuthentication]' = None, destination: 'Optional[CustomerFacingIngressNetworkPolicyRequestDestination]' = None, label: 'Optional[str]' = None, origin: 'Optional[CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin]' = None)

authentication: CustomerFacingIngressNetworkPolicyAuthentication | None = None

destination: CustomerFacingIngressNetworkPolicyRequestDestination | None = None

label: str | None = None

The label for this ingress rule.

origin: CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule

Deserializes the CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin(all_source_workspaces: 'Optional[bool]' = None, selected_workspaces: 'Optional[CustomerFacingIngressNetworkPolicyWorkspaceIdList]' = None)

all_source_workspaces: bool | None = None

Matches all source workspaces.

selected_workspaces: CustomerFacingIngressNetworkPolicyWorkspaceIdList | None = None

Specific source workspace IDs to match.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin

Deserializes the CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyEndpoints(endpoint_ids: 'Optional[List[str]]' = None)

endpoint_ids: List[str] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyEndpoints into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyEndpoints

Deserializes the CustomerFacingIngressNetworkPolicyEndpoints from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyIpRanges(ip_ranges: 'Optional[List[str]]' = None)

ip_ranges: List[str] | None = None

We only support IPv4 and IPv4 CIDR notation for now.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyIpRanges into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyIpRanges

Deserializes the CustomerFacingIngressNetworkPolicyIpRanges from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination(all_destinations: 'Optional[bool]' = None)

all_destinations: bool | None = None

Must be set to true.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination

Deserializes the CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyPrivateAccess(restriction_mode: 'CustomerFacingIngressNetworkPolicyPrivateAccessRestrictionMode', allow_rules: 'Optional[List[CustomerFacingIngressNetworkPolicyPrivateIngressRule]]' = None, deny_rules: 'Optional[List[CustomerFacingIngressNetworkPolicyPrivateIngressRule]]' = None)

restriction_mode: CustomerFacingIngressNetworkPolicyPrivateAccessRestrictionMode

allow_rules: List[CustomerFacingIngressNetworkPolicyPrivateIngressRule] | None = None

deny_rules: List[CustomerFacingIngressNetworkPolicyPrivateIngressRule] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyPrivateAccess into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyPrivateAccess

Deserializes the CustomerFacingIngressNetworkPolicyPrivateAccess from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyPrivateAccessRestrictionMode

ALLOW_ALL_REGISTERED_ENDPOINTS = "ALLOW_ALL_REGISTERED_ENDPOINTS"

RESTRICTED_ACCESS = "RESTRICTED_ACCESS"

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyPrivateIngressRule(authentication: 'Optional[CustomerFacingIngressNetworkPolicyAuthentication]' = None, destination: 'Optional[CustomerFacingIngressNetworkPolicyRequestDestination]' = None, label: 'Optional[str]' = None, origin: 'Optional[CustomerFacingIngressNetworkPolicyPrivateRequestOrigin]' = None)

authentication: CustomerFacingIngressNetworkPolicyAuthentication | None = None

destination: CustomerFacingIngressNetworkPolicyRequestDestination | None = None

label: str | None = None

The label for this ingress rule.

origin: CustomerFacingIngressNetworkPolicyPrivateRequestOrigin | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyPrivateIngressRule into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyPrivateIngressRule

Deserializes the CustomerFacingIngressNetworkPolicyPrivateIngressRule from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyPrivateRequestOrigin(all_private_access: 'Optional[bool]' = None, all_registered_endpoints: 'Optional[bool]' = None, azure_workspace_private_link: 'Optional[bool]' = None, endpoints: 'Optional[CustomerFacingIngressNetworkPolicyEndpoints]' = None)

all_private_access: bool | None = None

all_registered_endpoints: bool | None = None

azure_workspace_private_link: bool | None = None

endpoints: CustomerFacingIngressNetworkPolicyEndpoints | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyPrivateRequestOrigin into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyPrivateRequestOrigin

Deserializes the CustomerFacingIngressNetworkPolicyPrivateRequestOrigin from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyPublicAccess(restriction_mode: 'CustomerFacingIngressNetworkPolicyPublicAccessRestrictionMode', allow_rules: 'Optional[List[CustomerFacingIngressNetworkPolicyPublicIngressRule]]' = None, deny_rules: 'Optional[List[CustomerFacingIngressNetworkPolicyPublicIngressRule]]' = None)

restriction_mode: CustomerFacingIngressNetworkPolicyPublicAccessRestrictionMode

allow_rules: List[CustomerFacingIngressNetworkPolicyPublicIngressRule] | None = None

deny_rules: List[CustomerFacingIngressNetworkPolicyPublicIngressRule] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyPublicAccess into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyPublicAccess

Deserializes the CustomerFacingIngressNetworkPolicyPublicAccess from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyPublicAccessRestrictionMode

FULL_ACCESS = "FULL_ACCESS"

RESTRICTED_ACCESS = "RESTRICTED_ACCESS"

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyPublicIngressRule(authentication: CustomerFacingIngressNetworkPolicyAuthentication | None = None, destination: CustomerFacingIngressNetworkPolicyRequestDestination | None = None, label: str | None = None, origin: CustomerFacingIngressNetworkPolicyPublicRequestOrigin | None = None)

An ingress rule is enforced when a request satisfies all specified attributes — including request origin, destination, and authentication.

authentication: CustomerFacingIngressNetworkPolicyAuthentication | None = None

destination: CustomerFacingIngressNetworkPolicyRequestDestination | None = None

label: str | None = None

The label for this ingress rule.

origin: CustomerFacingIngressNetworkPolicyPublicRequestOrigin | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyPublicIngressRule into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyPublicIngressRule

Deserializes the CustomerFacingIngressNetworkPolicyPublicIngressRule from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyPublicRequestOrigin(all_ip_ranges: 'Optional[bool]' = None, excluded_ip_ranges: 'Optional[CustomerFacingIngressNetworkPolicyIpRanges]' = None, included_ip_ranges: 'Optional[CustomerFacingIngressNetworkPolicyIpRanges]' = None)

all_ip_ranges: bool | None = None

Matches all IPv4 and IPv6 ranges (both public and private).

excluded_ip_ranges: CustomerFacingIngressNetworkPolicyIpRanges | None = None

Excluded means: all public IP ranges except this one.

included_ip_ranges: CustomerFacingIngressNetworkPolicyIpRanges | None = None

Will not allow IP ranges with private IPs.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyPublicRequestOrigin into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyPublicRequestOrigin

Deserializes the CustomerFacingIngressNetworkPolicyPublicRequestOrigin from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyRequestDestination(account_api: 'Optional[CustomerFacingIngressNetworkPolicyAccountApiDestination]' = None, account_databricks_one: 'Optional[CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination]' = None, account_ui: 'Optional[CustomerFacingIngressNetworkPolicyAccountUiDestination]' = None, all_destinations: 'Optional[bool]' = None, apps_runtime: 'Optional[CustomerFacingIngressNetworkPolicyAppsRuntimeDestination]' = None, lakebase_runtime: 'Optional[CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination]' = None, workspace_api: 'Optional[CustomerFacingIngressNetworkPolicyWorkspaceApiDestination]' = None, workspace_ui: 'Optional[CustomerFacingIngressNetworkPolicyWorkspaceUiDestination]' = None)

account_api: CustomerFacingIngressNetworkPolicyAccountApiDestination | None = None

account_databricks_one: CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination | None = None

Account DatabricksOne destination is not supported. DO NOT change the stage of this destination past PRIVATE_PREVIEW.

account_ui: CustomerFacingIngressNetworkPolicyAccountUiDestination | None = None

all_destinations: bool | None = None

When true, match all destinations, no other destination fields can be set. When not set or false, at least one specific destination must be provided.

apps_runtime: CustomerFacingIngressNetworkPolicyAppsRuntimeDestination | None = None

lakebase_runtime: CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination | None = None

workspace_api: CustomerFacingIngressNetworkPolicyWorkspaceApiDestination | None = None

workspace_ui: CustomerFacingIngressNetworkPolicyWorkspaceUiDestination | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyRequestDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyRequestDestination

Deserializes the CustomerFacingIngressNetworkPolicyRequestDestination from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyWorkspaceApiDestination(scope_qualifier: 'Optional[CustomerFacingIngressNetworkPolicyApiScopeQualifier]' = None, scopes: 'Optional[List[str]]' = None)

scope_qualifier: CustomerFacingIngressNetworkPolicyApiScopeQualifier | None = None

Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier.

scopes: List[str] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyWorkspaceApiDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyWorkspaceApiDestination

Deserializes the CustomerFacingIngressNetworkPolicyWorkspaceApiDestination from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyWorkspaceIdList(workspace_ids: 'Optional[List[int]]' = None)

workspace_ids: List[int] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyWorkspaceIdList into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyWorkspaceIdList

Deserializes the CustomerFacingIngressNetworkPolicyWorkspaceIdList from a dictionary.

class databricks.sdk.service.settings.CustomerFacingIngressNetworkPolicyWorkspaceUiDestination(all_destinations: 'Optional[bool]' = None)

all_destinations: bool | None = None

Must be set to true.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingIngressNetworkPolicyWorkspaceUiDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingIngressNetworkPolicyWorkspaceUiDestination

Deserializes the CustomerFacingIngressNetworkPolicyWorkspaceUiDestination from a dictionary.

class databricks.sdk.service.settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule(account_id: str | None = None, connection_state: CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState | None = None, creation_time: int | None = None, deactivated: bool | None = None, deactivated_at: int | None = None, domain_names: List[str] | None = None, enabled: bool | None = None, endpoint_service: str | None = None, error_message: str | None = None, network_connectivity_config_id: str | None = None, resource_names: List[str] | None = None, rule_id: str | None = None, updated_time: int | None = None, vpc_endpoint_id: str | None = None)

Properties of the new private endpoint rule. Note that for private endpoints towards a VPC endpoint service behind a customer-managed NLB, you must approve the endpoint in AWS console after initialization.

account_id: str | None = None

Databricks account ID. You can find your account ID from the Accounts Console.

connection_state: CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState | 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 AWS console before they take effect. The possible values are: - 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. - EXPIRED: If the endpoint is created but not approved in 14 days, it is EXPIRED.

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.

domain_names: List[str] | None = None

Only used by private endpoints towards a VPC endpoint service for customer-managed VPC endpoint service.

The target AWS resource FQDNs accessible via the VPC endpoint service. When updating this field, we perform full update on this field. Please ensure a full list of desired domain_names is provided.

enabled: bool | None = None

Only used by private endpoints towards an AWS S3 service.

Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources.

endpoint_service: str | None = None

The full target AWS endpoint service name that connects to the destination resources of the private endpoint.

error_message: str | None = None

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_names: List[str] | None = None

Only used by private endpoints towards AWS S3 service.

The globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. When updating this field, we perform full update on this field. Please ensure a full list of desired resource_names is provided.

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.

vpc_endpoint_id: str | None = None

The AWS VPC endpoint ID. You can use this ID to identify VPC endpoint created by Databricks.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule

Deserializes the CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule from a dictionary.

class databricks.sdk.service.settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState

CREATE_FAILED = "CREATE_FAILED"

CREATING = "CREATING"

DISCONNECTED = "DISCONNECTED"

ESTABLISHED = "ESTABLISHED"

EXPIRED = "EXPIRED"

PENDING = "PENDING"

REJECTED = "REJECTED"

class databricks.sdk.service.settings.DashboardEmailSubscriptions(boolean_val: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

boolean_val: BooleanMessage

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 DashboardEmailSubscriptions into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DashboardEmailSubscriptions into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DashboardEmailSubscriptions

Deserializes the DashboardEmailSubscriptions from a dictionary.

class databricks.sdk.service.settings.DefaultNamespaceSetting(namespace: StringMessage, etag: str | None = None, setting_name: str | None = None)

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.

as_shallow_dict() → dict

Serializes the DefaultNamespaceSetting into a shallow dictionary of its immediate attributes.

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

Deserializes the DefaultNamespaceSetting from a dictionary.

class databricks.sdk.service.settings.DefaultWarehouseId(string_val: 'StringMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

string_val: 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 DefaultWarehouseId into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DefaultWarehouseId into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DefaultWarehouseId

Deserializes the DefaultWarehouseId from a dictionary.

class databricks.sdk.service.settings.DeleteAccountIpAccessEnableResponse(etag: str)

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 DeleteAccountIpAccessEnableResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteAccountIpAccessEnableResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteAccountIpAccessEnableResponse

Deserializes the DeleteAccountIpAccessEnableResponse from a dictionary.

class databricks.sdk.service.settings.DeleteAibiDashboardEmbeddingAccessPolicySettingResponse(etag: str)

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 DeleteAibiDashboardEmbeddingAccessPolicySettingResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteAibiDashboardEmbeddingAccessPolicySettingResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteAibiDashboardEmbeddingAccessPolicySettingResponse

Deserializes the DeleteAibiDashboardEmbeddingAccessPolicySettingResponse from a dictionary.

class databricks.sdk.service.settings.DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse(etag: str)

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 DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse

Deserializes the DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse from a dictionary.

class databricks.sdk.service.settings.DeleteDashboardEmailSubscriptionsResponse(etag: str)

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 DeleteDashboardEmailSubscriptionsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteDashboardEmailSubscriptionsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteDashboardEmailSubscriptionsResponse

Deserializes the DeleteDashboardEmailSubscriptionsResponse from a dictionary.

class databricks.sdk.service.settings.DeleteDefaultNamespaceSettingResponse(etag: str)

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.

as_shallow_dict() → dict

Serializes the DeleteDefaultNamespaceSettingResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the DeleteDefaultNamespaceSettingResponse from a dictionary.

class databricks.sdk.service.settings.DeleteDefaultWarehouseIdResponse(etag: str)

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 DeleteDefaultWarehouseIdResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteDefaultWarehouseIdResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteDefaultWarehouseIdResponse

Deserializes the DeleteDefaultWarehouseIdResponse from a dictionary.

class databricks.sdk.service.settings.DeleteDisableLegacyAccessResponse(etag: str)

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 DeleteDisableLegacyAccessResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteDisableLegacyAccessResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteDisableLegacyAccessResponse

Deserializes the DeleteDisableLegacyAccessResponse from a dictionary.

class databricks.sdk.service.settings.DeleteDisableLegacyDbfsResponse(etag: str)

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 DeleteDisableLegacyDbfsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteDisableLegacyDbfsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteDisableLegacyDbfsResponse

Deserializes the DeleteDisableLegacyDbfsResponse from a dictionary.

class databricks.sdk.service.settings.DeleteDisableLegacyFeaturesResponse(etag: str)

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 DeleteDisableLegacyFeaturesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteDisableLegacyFeaturesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteDisableLegacyFeaturesResponse

Deserializes the DeleteDisableLegacyFeaturesResponse from a dictionary.

class databricks.sdk.service.settings.DeleteLlmProxyPartnerPoweredWorkspaceResponse(etag: str)

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 DeleteLlmProxyPartnerPoweredWorkspaceResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteLlmProxyPartnerPoweredWorkspaceResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteLlmProxyPartnerPoweredWorkspaceResponse

Deserializes the DeleteLlmProxyPartnerPoweredWorkspaceResponse from a dictionary.

class databricks.sdk.service.settings.DeletePersonalComputeSettingResponse(etag: str)

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.

as_shallow_dict() → dict

Serializes the DeletePersonalComputeSettingResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the DeletePersonalComputeSettingResponse from a dictionary.

class databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingResponse(etag: str)

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.

as_shallow_dict() → dict

Serializes the DeleteRestrictWorkspaceAdminsSettingResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the DeleteRestrictWorkspaceAdminsSettingResponse from a dictionary.

class databricks.sdk.service.settings.DeleteSqlResultsDownloadResponse(etag: str)

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 DeleteSqlResultsDownloadResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteSqlResultsDownloadResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteSqlResultsDownloadResponse

Deserializes the DeleteSqlResultsDownloadResponse from a dictionary.

class databricks.sdk.service.settings.DestinationType

EMAIL = "EMAIL"

MICROSOFT_TEAMS = "MICROSOFT_TEAMS"

PAGERDUTY = "PAGERDUTY"

SLACK = "SLACK"

WEBHOOK = "WEBHOOK"

class databricks.sdk.service.settings.DisableLegacyAccess(disable_legacy_access: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

disable_legacy_access: BooleanMessage

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 DisableLegacyAccess into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DisableLegacyAccess into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DisableLegacyAccess

Deserializes the DisableLegacyAccess from a dictionary.

class databricks.sdk.service.settings.DisableLegacyDbfs(disable_legacy_dbfs: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

disable_legacy_dbfs: BooleanMessage

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 DisableLegacyDbfs into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DisableLegacyDbfs into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DisableLegacyDbfs

Deserializes the DisableLegacyDbfs from a dictionary.

class databricks.sdk.service.settings.DisableLegacyFeatures(disable_legacy_features: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

disable_legacy_features: BooleanMessage

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 DisableLegacyFeatures into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DisableLegacyFeatures into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DisableLegacyFeatures

Deserializes the DisableLegacyFeatures from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicy(internet_access: EgressNetworkPolicyInternetAccessPolicy | None = None)

The network policies applying for egress traffic. This message is used by the UI/REST API. We translate this message to the format expected by the dataplane in Lakehouse Network Manager (for the format expected by the dataplane, see networkconfig.textproto).

internet_access: EgressNetworkPolicyInternetAccessPolicy | None = None

The access policy enforced for egress traffic to the internet.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicy into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicy

Deserializes the EgressNetworkPolicy from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicy(allowed_internet_destinations: 'Optional[List[EgressNetworkPolicyInternetAccessPolicyInternetDestination]]' = None, allowed_storage_destinations: 'Optional[List[EgressNetworkPolicyInternetAccessPolicyStorageDestination]]' = None, log_only_mode: 'Optional[EgressNetworkPolicyInternetAccessPolicyLogOnlyMode]' = None, restriction_mode: 'Optional[EgressNetworkPolicyInternetAccessPolicyRestrictionMode]' = None)

allowed_internet_destinations: List[EgressNetworkPolicyInternetAccessPolicyInternetDestination] | None = None

allowed_storage_destinations: List[EgressNetworkPolicyInternetAccessPolicyStorageDestination] | None = None

log_only_mode: EgressNetworkPolicyInternetAccessPolicyLogOnlyMode | None = None

Optional. If not specified, assume the policy is enforced for all workloads.

restriction_mode: EgressNetworkPolicyInternetAccessPolicyRestrictionMode | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicyInternetAccessPolicy into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicyInternetAccessPolicy

Deserializes the EgressNetworkPolicyInternetAccessPolicy from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyInternetDestination(destination: str | None = None, protocol: EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol | None = None, type: EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType | None = None)

Users can specify accessible internet destinations when outbound access is restricted. We only support domain name (FQDN) destinations for the time being, though going forwards we want to support host names and IP addresses.

destination: str | None = None

protocol: EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol | None = None

type: EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicyInternetAccessPolicyInternetDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicyInternetAccessPolicyInternetDestination

Deserializes the EgressNetworkPolicyInternetAccessPolicyInternetDestination from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol

The filtering protocol used by the DP. For private and public preview, SEG will only support TCP filtering (i.e. DNS based filtering, filtering by destination IP address), so protocol will be set to TCP by default and hidden from the user. In the future, users may be able to select HTTP filtering (i.e. SNI based filtering, filtering by FQDN).

TCP = "TCP"

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType

FQDN = "FQDN"

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyLogOnlyMode(log_only_mode_type: 'Optional[EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType]' = None, workloads: 'Optional[List[EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType]]' = None)

log_only_mode_type: EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType | None = None

workloads: List[EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicyInternetAccessPolicyLogOnlyMode into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicyInternetAccessPolicyLogOnlyMode

Deserializes the EgressNetworkPolicyInternetAccessPolicyLogOnlyMode from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType

ALL_SERVICES = "ALL_SERVICES"

SELECTED_SERVICES = "SELECTED_SERVICES"

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType

The values should match the list of workloads used in networkconfig.proto

DBSQL = "DBSQL"

ML_SERVING = "ML_SERVING"

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyRestrictionMode

At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS: Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can only access explicitly allowed internet and storage destinations, as well as UC connections and external locations. PRIVATE_ACCESS_ONLY (not used): Databricks can only access destinations via private link.

FULL_ACCESS = "FULL_ACCESS"

PRIVATE_ACCESS_ONLY = "PRIVATE_ACCESS_ONLY"

RESTRICTED_ACCESS = "RESTRICTED_ACCESS"

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyStorageDestination(allowed_paths: List[str] | None = None, azure_container: str | None = None, azure_dns_zone: str | None = None, azure_storage_account: str | None = None, azure_storage_service: str | None = None, bucket_name: str | None = None, region: str | None = None, type: EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType | None = None)

Users can specify accessible storage destinations.

allowed_paths: List[str] | None = None

azure_container: str | None = None

azure_dns_zone: str | None = None

azure_storage_account: str | None = None

azure_storage_service: str | None = None

bucket_name: str | None = None

region: str | None = None

type: EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicyInternetAccessPolicyStorageDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicyInternetAccessPolicyStorageDestination

Deserializes the EgressNetworkPolicyInternetAccessPolicyStorageDestination from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType

AWS_S3 = "AWS_S3"

AZURE_STORAGE = "AZURE_STORAGE"

CLOUDFLARE_R2 = "CLOUDFLARE_R2"

GOOGLE_CLOUD_STORAGE = "GOOGLE_CLOUD_STORAGE"

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicy(restriction_mode: 'EgressNetworkPolicyNetworkAccessPolicyRestrictionMode', allowed_internet_destinations: 'Optional[List[EgressNetworkPolicyNetworkAccessPolicyInternetDestination]]' = None, allowed_storage_destinations: 'Optional[List[EgressNetworkPolicyNetworkAccessPolicyStorageDestination]]' = None, blocked_internet_destinations: 'Optional[List[EgressNetworkPolicyNetworkAccessPolicyInternetDestination]]' = None, policy_enforcement: 'Optional[EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement]' = None)

restriction_mode: EgressNetworkPolicyNetworkAccessPolicyRestrictionMode

The restriction mode that controls how serverless workloads can access the internet.

allowed_internet_destinations: List[EgressNetworkPolicyNetworkAccessPolicyInternetDestination] | None = None

List of internet destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode.

allowed_storage_destinations: List[EgressNetworkPolicyNetworkAccessPolicyStorageDestination] | None = None

List of storage destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode.

blocked_internet_destinations: List[EgressNetworkPolicyNetworkAccessPolicyInternetDestination] | None = None

List of internet destinations that serverless workloads are blocked from accessing. These destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN. Currently supports DNS_NAME type only; IP_RANGE support is planned.

policy_enforcement: EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement | None = None

Optional. When policy_enforcement is not provided, we default to ENFORCE_MODE_ALL_SERVICES

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicyNetworkAccessPolicy into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicyNetworkAccessPolicy

Deserializes the EgressNetworkPolicyNetworkAccessPolicy from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicyInternetDestination(destination: str | None = None, internet_destination_type: EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType | None = None)

Users can specify accessible internet destinations when outbound access is restricted. We only support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend support to host names and IP addresses.

destination: str | None = None

The internet destination to which access will be allowed. Format dependent on the destination type.

internet_destination_type: EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType | None = None

The type of internet destination. Currently only DNS_NAME is supported.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicyNetworkAccessPolicyInternetDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicyNetworkAccessPolicyInternetDestination

Deserializes the EgressNetworkPolicyNetworkAccessPolicyInternetDestination from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType

DNS_NAME = "DNS_NAME"

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement(dry_run_mode_product_filter: 'Optional[List[EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter]]' = None, enforcement_mode: 'Optional[EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode]' = None)

dry_run_mode_product_filter: List[EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter] | None = None

When empty, it means dry run for all products. When non-empty, it means dry run for specific products and for the other products, they will run in enforced mode.

enforcement_mode: EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode | None = None

The mode of policy enforcement. ENFORCED blocks traffic that violates policy, while DRY_RUN only logs violations without blocking. When not specified, defaults to ENFORCED.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement

Deserializes the EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter

The values should match the list of workloads used in networkconfig.proto

DBSQL = "DBSQL"

ML_SERVING = "ML_SERVING"

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode

DRY_RUN = "DRY_RUN"

ENFORCED = "ENFORCED"

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicyRestrictionMode

At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS: Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can only access explicitly allowed internet and storage destinations, as well as UC connections and external locations.

FULL_ACCESS = "FULL_ACCESS"

RESTRICTED_ACCESS = "RESTRICTED_ACCESS"

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicyStorageDestination(azure_storage_account: str | None = None, azure_storage_service: str | None = None, bucket_name: str | None = None, region: str | None = None, storage_destination_type: EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType | None = None)

Users can specify accessible storage destinations.

azure_storage_account: str | None = None

The Azure storage account name.

azure_storage_service: str | None = None

The Azure storage service type (blob, dfs, etc.).

bucket_name: str | None = None

region: str | None = None

storage_destination_type: EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType | None = None

The type of storage destination.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EgressNetworkPolicyNetworkAccessPolicyStorageDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EgressNetworkPolicyNetworkAccessPolicyStorageDestination

Deserializes the EgressNetworkPolicyNetworkAccessPolicyStorageDestination from a dictionary.

class databricks.sdk.service.settings.EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType

AWS_S3 = "AWS_S3"

AZURE_STORAGE = "AZURE_STORAGE"

GOOGLE_CLOUD_STORAGE = "GOOGLE_CLOUD_STORAGE"

class databricks.sdk.service.settings.EgressResourceType

The target resources that are supported by Network Connectivity Config. Note: some egress types can support general types that are not defined in EgressResourceType. E.g.: Azure private endpoint supports private link enabled Azure services.

AZURE_BLOB_STORAGE = "AZURE_BLOB_STORAGE"

class databricks.sdk.service.settings.EmailConfig(addresses: 'Optional[List[str]]' = None)

addresses: List[str] | None = None

Email addresses to notify.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EmailConfig into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EmailConfig

Deserializes the EmailConfig from a dictionary.

class databricks.sdk.service.settings.Empty

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the Empty into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Empty

Deserializes the Empty from a dictionary.

class databricks.sdk.service.settings.EnableExportNotebook(boolean_val: 'Optional[BooleanMessage]' = None, setting_name: 'Optional[str]' = None)

boolean_val: BooleanMessage | None = None

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 EnableExportNotebook into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the EnableExportNotebook into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EnableExportNotebook

Deserializes the EnableExportNotebook from a dictionary.

class databricks.sdk.service.settings.EnableNotebookTableClipboard(boolean_val: 'Optional[BooleanMessage]' = None, setting_name: 'Optional[str]' = None)

boolean_val: BooleanMessage | None = None

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 EnableNotebookTableClipboard into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the EnableNotebookTableClipboard into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EnableNotebookTableClipboard

Deserializes the EnableNotebookTableClipboard from a dictionary.

class databricks.sdk.service.settings.EnableResultsDownloading(boolean_val: 'Optional[BooleanMessage]' = None, setting_name: 'Optional[str]' = None)

boolean_val: BooleanMessage | None = None

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 EnableResultsDownloading into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the EnableResultsDownloading into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EnableResultsDownloading

Deserializes the EnableResultsDownloading from a dictionary.

class databricks.sdk.service.settings.EnhancedSecurityMonitoring(is_enabled: bool | None = None)

SHIELD feature: ESM Enhanced Security Monitoring (ESM) enables additional security monitoring on the workspace.

is_enabled: bool | None = None

Whether Enhanced Security Monitoring (ESM) is enabled on the workspace.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the EnhancedSecurityMonitoring into a shallow dictionary of its immediate attributes.

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', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

enhanced_security_monitoring_workspace: EnhancedSecurityMonitoring

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.

as_shallow_dict() → dict

Serializes the EnhancedSecurityMonitoringSetting into a shallow dictionary of its immediate attributes.

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

Deserializes the EnhancedSecurityMonitoringSetting from a dictionary.

class databricks.sdk.service.settings.EsmEnablementAccount(is_enforced: bool | None = None)

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.

as_shallow_dict() → dict

Serializes the EsmEnablementAccount into a shallow dictionary of its immediate attributes.

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

Deserializes the EsmEnablementAccount from a dictionary.

class databricks.sdk.service.settings.EsmEnablementAccountSetting(esm_enablement_account: 'EsmEnablementAccount', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

esm_enablement_account: EsmEnablementAccount

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.

as_shallow_dict() → dict

Serializes the EsmEnablementAccountSetting into a shallow dictionary of its immediate attributes.

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

Deserializes the EsmEnablementAccountSetting from a dictionary.

class databricks.sdk.service.settings.ExchangeToken(credential: str | None = None, credential_eol_time: int | None = None, owner_id: int | None = None, scopes: List[str] | None = None, token_type: TokenType | None = None)

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.

as_shallow_dict() → dict

Serializes the ExchangeToken into a shallow dictionary of its immediate attributes.

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

Deserializes the ExchangeToken from a dictionary.

class databricks.sdk.service.settings.ExchangeTokenResponse(values: List[ExchangeToken] | None = None)

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.

as_shallow_dict() → dict

Serializes the ExchangeTokenResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the ExchangeTokenResponse from a dictionary.

class databricks.sdk.service.settings.FetchIpAccessListResponse(ip_access_list: IpAccessListInfo | None = None)

An IP access list was successfully returned.

ip_access_list: IpAccessListInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the FetchIpAccessListResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the FetchIpAccessListResponse from a dictionary.

class databricks.sdk.service.settings.GcpEndpoint(psc_endpoint_uri: 'Optional[str]' = None, service_attachment: 'Optional[str]' = None)

psc_endpoint_uri: str | None = None

Output only. The URI of the created PSC endpoint.

service_attachment: str | None = None

The full url of the target service attachment. Example: projects/my-gcp-project/regions/us-east4/serviceAttachments/my-service-attachment

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the GcpEndpoint into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GcpEndpoint

Deserializes the GcpEndpoint from a dictionary.

class databricks.sdk.service.settings.GenericWebhookConfig(password: 'Optional[str]' = None, password_set: 'Optional[bool]' = None, url: 'Optional[str]' = None, url_set: 'Optional[bool]' = None, username: 'Optional[str]' = None, username_set: 'Optional[bool]' = None)

password: str | None = None

[Input-Only][Optional] Password for webhook.

password_set: bool | None = None

[Output-Only] Whether password is set.

url: str | None = None

[Input-Only] URL for webhook.

url_set: bool | None = None

[Output-Only] Whether URL is set.

username: str | None = None

[Input-Only][Optional] Username for webhook.

username_set: bool | None = None

[Output-Only] Whether username is set.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the GenericWebhookConfig into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GenericWebhookConfig

Deserializes the GenericWebhookConfig from a dictionary.

class databricks.sdk.service.settings.GetIpAccessListResponse(ip_access_list: 'Optional[IpAccessListInfo]' = None)

ip_access_list: IpAccessListInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the GetIpAccessListResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the GetIpAccessListResponse from a dictionary.

class databricks.sdk.service.settings.GetIpAccessListsResponse(ip_access_lists: List[IpAccessListInfo] | None = None)

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.

as_shallow_dict() → dict

Serializes the GetIpAccessListsResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the GetIpAccessListsResponse from a dictionary.

class databricks.sdk.service.settings.GetTokenPermissionLevelsResponse(permission_levels: 'Optional[List[TokenPermissionsDescription]]' = None)

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.

as_shallow_dict() → dict

Serializes the GetTokenPermissionLevelsResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the GetTokenPermissionLevelsResponse from a dictionary.

class databricks.sdk.service.settings.GetTokenResponse(token_info: TokenInfo | None = None)

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.

as_shallow_dict() → dict

Serializes the GetTokenResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the GetTokenResponse from a dictionary.

class databricks.sdk.service.settings.IpAccessListInfo(address_count: int | None = None, created_at: int | None = None, created_by: int | None = None, enabled: bool | None = None, ip_addresses: List[str] | None = None, label: str | None = None, list_id: str | None = None, list_type: ListType | None = None, updated_at: int | None = None, updated_by: int | None = None)

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

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.

as_shallow_dict() → dict

Serializes the IpAccessListInfo into a shallow dictionary of its immediate attributes.

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

Deserializes the IpAccessListInfo from a dictionary.

class databricks.sdk.service.settings.ListIpAccessListResponse(ip_access_lists: List[IpAccessListInfo] | None = None)

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.

as_shallow_dict() → dict

Serializes the ListIpAccessListResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the ListIpAccessListResponse from a dictionary.

class databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsResponse(items: List[NetworkConnectivityConfiguration] | None = None, next_page_token: str | None = None)

The network connectivity configuration list was successfully retrieved.

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.

as_shallow_dict() → dict

Serializes the ListNetworkConnectivityConfigurationsResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the ListNetworkConnectivityConfigurationsResponse from a dictionary.

class databricks.sdk.service.settings.ListNetworkPoliciesResponse(items: 'Optional[List[AccountNetworkPolicy]]' = None, next_page_token: 'Optional[str]' = None)

items: List[AccountNetworkPolicy] | None = None

List of network policies.

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 ListNetworkPoliciesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListNetworkPoliciesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListNetworkPoliciesResponse

Deserializes the ListNetworkPoliciesResponse from a dictionary.

class databricks.sdk.service.settings.ListNotificationDestinationsResponse(next_page_token: 'Optional[str]' = None, results: 'Optional[List[ListNotificationDestinationsResult]]' = None)

next_page_token: str | None = None

Page token for next of results.

results: List[ListNotificationDestinationsResult] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the ListNotificationDestinationsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListNotificationDestinationsResponse

Deserializes the ListNotificationDestinationsResponse from a dictionary.

class databricks.sdk.service.settings.ListNotificationDestinationsResult(destination_type: 'Optional[DestinationType]' = None, display_name: 'Optional[str]' = None, id: 'Optional[str]' = None)

destination_type: DestinationType | None = None

[Output-only] The type of the notification destination. The type can not be changed once set.

display_name: str | None = None

The display name for the notification destination.

id: str | None = None

UUID identifying notification destination.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the ListNotificationDestinationsResult into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListNotificationDestinationsResult

Deserializes the ListNotificationDestinationsResult from a dictionary.

class databricks.sdk.service.settings.ListPrivateEndpointRulesResponse(items: List[NccPrivateEndpointRule] | None = None, next_page_token: str | None = None)

The private endpoint rule list was successfully retrieved.

items: List[NccPrivateEndpointRule] | 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 ListPrivateEndpointRulesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListPrivateEndpointRulesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListPrivateEndpointRulesResponse

Deserializes the ListPrivateEndpointRulesResponse from a dictionary.

class databricks.sdk.service.settings.ListPublicTokensResponse(token_infos: 'Optional[List[PublicTokenInfo]]' = None)

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.

as_shallow_dict() → dict

Serializes the ListPublicTokensResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the ListPublicTokensResponse from a dictionary.

class databricks.sdk.service.settings.ListTokensResponse(token_infos: List[TokenInfo] | None = None)

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.

as_shallow_dict() → dict

Serializes the ListTokensResponse into a shallow dictionary of its immediate attributes.

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.LlmProxyPartnerPoweredAccount(boolean_val: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

boolean_val: BooleanMessage

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 LlmProxyPartnerPoweredAccount into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the LlmProxyPartnerPoweredAccount into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → LlmProxyPartnerPoweredAccount

Deserializes the LlmProxyPartnerPoweredAccount from a dictionary.

class databricks.sdk.service.settings.LlmProxyPartnerPoweredEnforce(boolean_val: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

boolean_val: BooleanMessage

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 LlmProxyPartnerPoweredEnforce into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the LlmProxyPartnerPoweredEnforce into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → LlmProxyPartnerPoweredEnforce

Deserializes the LlmProxyPartnerPoweredEnforce from a dictionary.

class databricks.sdk.service.settings.LlmProxyPartnerPoweredWorkspace(boolean_val: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

boolean_val: BooleanMessage

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 LlmProxyPartnerPoweredWorkspace into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the LlmProxyPartnerPoweredWorkspace into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → LlmProxyPartnerPoweredWorkspace

Deserializes the LlmProxyPartnerPoweredWorkspace from a dictionary.

class databricks.sdk.service.settings.MicrosoftTeamsConfig(app_id: 'Optional[str]' = None, app_id_set: 'Optional[bool]' = None, auth_secret: 'Optional[str]' = None, auth_secret_set: 'Optional[bool]' = None, channel_url: 'Optional[str]' = None, channel_url_set: 'Optional[bool]' = None, tenant_id: 'Optional[str]' = None, tenant_id_set: 'Optional[bool]' = None, url: 'Optional[str]' = None, url_set: 'Optional[bool]' = None)

app_id: str | None = None

[Input-Only] App ID for Microsoft Teams App.

app_id_set: bool | None = None

[Output-Only] Whether App ID is set.

auth_secret: str | None = None

[Input-Only] Secret for Microsoft Teams App authentication.

auth_secret_set: bool | None = None

[Output-Only] Whether secret is set.

channel_url: str | None = None

[Input-Only] Channel URL for Microsoft Teams App.

channel_url_set: bool | None = None

[Output-Only] Whether Channel URL is set.

tenant_id: str | None = None

[Input-Only] Tenant ID for Microsoft Teams App.

tenant_id_set: bool | None = None

[Output-Only] Whether Tenant ID is set.

url: str | None = None

[Input-Only] URL for Microsoft Teams webhook.

url_set: bool | None = None

[Output-Only] Whether URL is set.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the MicrosoftTeamsConfig into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → MicrosoftTeamsConfig

Deserializes the MicrosoftTeamsConfig from a dictionary.

class databricks.sdk.service.settings.NccAwsStableIpRule(cidr_blocks: List[str] | 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.

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.

as_shallow_dict() → dict

Serializes the NccAwsStableIpRule into a shallow dictionary of its immediate attributes.

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, creation_time: int | None = None, deactivated: bool | None = None, deactivated_at: int | None = None, domain_names: List[str] | None = None, endpoint_name: str | None = None, error_message: str | None = None, group_id: str | None = None, network_connectivity_config_id: str | None = None, resource_id: str | None = None, rule_id: str | None = None, updated_time: int | None = None)

Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

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. - EXPIRED: If the endpoint was created but not approved in 14 days, it will be EXPIRED.

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.

domain_names: List[str] | None = None

Not used by customer-managed private endpoint services.

Domain names of target private link service. When updating this field, the full list of target domain_names must be specified.

endpoint_name: str | None = None

The name of the Azure private endpoint resource.

error_message: str | None = None

group_id: str | None = None

Only used by private endpoints to Azure first-party services.

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.

as_shallow_dict() → dict

Serializes the NccAzurePrivateEndpointRule into a shallow dictionary of its immediate attributes.

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

Deserializes the NccAzurePrivateEndpointRule from a dictionary.

class databricks.sdk.service.settings.NccAzurePrivateEndpointRuleConnectionState

CREATE_FAILED = "CREATE_FAILED"

CREATING = "CREATING"

DISCONNECTED = "DISCONNECTED"

ESTABLISHED = "ESTABLISHED"

EXPIRED = "EXPIRED"

INIT = "INIT"

PENDING = "PENDING"

REJECTED = "REJECTED"

class databricks.sdk.service.settings.NccAzureServiceEndpointRule(subnets: List[str] | None = None, target_region: str | None = None, target_services: List[EgressResourceType] | 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.

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[EgressResourceType] | 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.

as_shallow_dict() → dict

Serializes the NccAzureServiceEndpointRule into a shallow dictionary of its immediate attributes.

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

Deserializes the NccAzureServiceEndpointRule from a dictionary.

class databricks.sdk.service.settings.NccEgressConfig(default_rules: 'Optional[NccEgressDefaultRules]' = None, target_rules: 'Optional[NccEgressTargetRules]' = None)

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.

as_shallow_dict() → dict

Serializes the NccEgressConfig into a shallow dictionary of its immediate attributes.

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

Deserializes the NccEgressConfig from a dictionary.

class databricks.sdk.service.settings.NccEgressDefaultRules(aws_stable_ip_rule: NccAwsStableIpRule | None = None, azure_service_endpoint_rule: NccAzureServiceEndpointRule | None = None)

Default rules don’t have specific targets.

aws_stable_ip_rule: NccAwsStableIpRule | None = None

azure_service_endpoint_rule: NccAzureServiceEndpointRule | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the NccEgressDefaultRules into a shallow dictionary of its immediate attributes.

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

Deserializes the NccEgressDefaultRules from a dictionary.

class databricks.sdk.service.settings.NccEgressTargetRules(aws_private_endpoint_rules: List[CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule] | None = None, azure_private_endpoint_rules: List[NccAzurePrivateEndpointRule] | None = None)

Target rule controls the egress rules that are dedicated to specific resources.

aws_private_endpoint_rules: List[CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule] | None = None

AWS private endpoint rule controls the AWS private endpoint based egress 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.

as_shallow_dict() → dict

Serializes the NccEgressTargetRules into a shallow dictionary of its immediate attributes.

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

Deserializes the NccEgressTargetRules from a dictionary.

class databricks.sdk.service.settings.NccPrivateEndpointRule(account_id: str | None = None, connection_state: NccPrivateEndpointRulePrivateLinkConnectionState | None = None, creation_time: int | None = None, deactivated: bool | None = None, deactivated_at: int | None = None, domain_names: List[str] | None = None, enabled: bool | None = None, endpoint_name: str | None = None, endpoint_service: str | None = None, error_message: str | None = None, gcp_endpoint: GcpEndpoint | None = None, group_id: str | None = None, network_connectivity_config_id: str | None = None, resource_id: str | None = None, resource_names: List[str] | None = None, rule_id: str | None = None, updated_time: int | None = None, vpc_endpoint_id: str | None = None)

Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

account_id: str | None = None

Databricks account ID. You can find your account ID from the Accounts Console.

connection_state: NccPrivateEndpointRulePrivateLinkConnectionState | 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 Cloud console before they take effect. The possible values are: - 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. - EXPIRED: If the endpoint was created but not approved in 14 days, it will be EXPIRED. - CREATING: The endpoint creation is in progress. Once successfully created, the state will transition to PENDING. - CREATE_FAILED: The endpoint creation failed. You can check the error_message field for more details.

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.

domain_names: List[str] | None = None

Only used by private endpoints to customer-managed private endpoint services.

Domain names of target private link service. When updating this field, the full list of target domain_names must be specified.

enabled: bool | None = None

Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3).

endpoint_name: str | None = None

The name of the Azure private endpoint resource.

endpoint_service: str | None = None

The full target AWS endpoint service name that connects to the destination resources of the private endpoint.

error_message: str | None = None

gcp_endpoint: GcpEndpoint | None = None

group_id: str | None = None

Not used by customer-managed private endpoint services.

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.

resource_names: List[str] | None = None

Only used by private endpoints towards AWS S3 service.

The globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. When updating this field, we perform full update on this field. Please ensure a full list of desired resource_names is provided.

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.

vpc_endpoint_id: str | None = None

The AWS VPC endpoint ID. You can use this ID to identify the VPC endpoint created by Databricks.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the NccPrivateEndpointRule into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → NccPrivateEndpointRule

Deserializes the NccPrivateEndpointRule from a dictionary.

class databricks.sdk.service.settings.NccPrivateEndpointRulePrivateLinkConnectionState

CREATE_FAILED = "CREATE_FAILED"

CREATING = "CREATING"

DISCONNECTED = "DISCONNECTED"

ESTABLISHED = "ESTABLISHED"

EXPIRED = "EXPIRED"

PENDING = "PENDING"

REJECTED = "REJECTED"

class databricks.sdk.service.settings.NetworkConnectivityConfiguration(account_id: str | None = None, creation_time: int | None = None, egress_config: NccEgressConfig | None = None, name: str | None = None, network_connectivity_config_id: str | None = None, region: str | None = None, updated_time: int | None = None)

Properties of the new network connectivity configuration.

account_id: str | None = None

Your Databricks account ID. You can find your account ID in your Databricks accounts console.

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.

as_shallow_dict() → dict

Serializes the NetworkConnectivityConfiguration into a shallow dictionary of its immediate attributes.

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

Deserializes the NetworkConnectivityConfiguration from a dictionary.

class databricks.sdk.service.settings.NetworkPolicyEgress(network_access: EgressNetworkPolicyNetworkAccessPolicy | None = None)

The network policies applying for egress traffic. This message is used by the UI/REST API. We translate this message to the format expected by the dataplane in Lakehouse Network Manager (for the format expected by the dataplane, see networkconfig.textproto). This policy should be consistent with [[com.databricks.api.proto.settingspolicy.EgressNetworkPolicy]]. Details see API-design: https://docs.google.com/document/d/1DKWO_FpZMCY4cF2O62LpwII1lx8gsnDGG-qgE3t3TOA/

network_access: EgressNetworkPolicyNetworkAccessPolicy | None = None

The access policy enforced for egress traffic to the internet.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the NetworkPolicyEgress into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → NetworkPolicyEgress

Deserializes the NetworkPolicyEgress from a dictionary.

class databricks.sdk.service.settings.NotificationDestination(config: 'Optional[Config]' = None, destination_type: 'Optional[DestinationType]' = None, display_name: 'Optional[str]' = None, id: 'Optional[str]' = None)

config: Config | None = None

The configuration for the notification destination. Will be exactly one of the nested configs. Only returns for users with workspace admin permissions.

destination_type: DestinationType | None = None

[Output-only] The type of the notification destination. The type can not be changed once set.

display_name: str | None = None

The display name for the notification destination.

id: str | None = None

UUID identifying notification destination.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the NotificationDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → NotificationDestination

Deserializes the NotificationDestination from a dictionary.

class databricks.sdk.service.settings.PagerdutyConfig(integration_key: 'Optional[str]' = None, integration_key_set: 'Optional[bool]' = None)

integration_key: str | None = None

[Input-Only] Integration key for PagerDuty.

integration_key_set: bool | None = None

[Output-Only] Whether integration key is set.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the PagerdutyConfig into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → PagerdutyConfig

Deserializes the PagerdutyConfig from a dictionary.

class databricks.sdk.service.settings.PartitionId(workspace_id: int | None = None)

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.

as_shallow_dict() → dict

Serializes the PartitionId into a shallow dictionary of its immediate attributes.

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

Deserializes the PartitionId from a dictionary.

class databricks.sdk.service.settings.PersonalComputeMessage(value: 'PersonalComputeMessageEnum')

value: PersonalComputeMessageEnum

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the PersonalComputeMessage into a shallow dictionary of its immediate attributes.

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: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

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.

as_shallow_dict() → dict

Serializes the PersonalComputeSetting into a shallow dictionary of its immediate attributes.

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

Deserializes the PersonalComputeSetting from a dictionary.

class databricks.sdk.service.settings.PublicTokenInfo(autoscope_state: 'Optional[iam.AutoscopeState]' = None, backfill_scopes: 'Optional[List[str]]' = None, comment: 'Optional[str]' = None, creation_time: 'Optional[int]' = None, expiry_time: 'Optional[int]' = None, inferred_scopes: 'Optional[List[str]]' = None, scopes: 'Optional[List[str]]' = None, token_id: 'Optional[str]' = None)

autoscope_state: AutoscopeState | None = None

Output only. The autoscope state of this token.

backfill_scopes: List[str] | None = None

Output only. Scopes inferred from offline backfill processing.

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.

inferred_scopes: List[str] | None = None

Output only. Inferred API path scopes collected for this token when autoscope is enabled.

scopes: List[str] | None = None

Scope of the token was created with, if 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.

as_shallow_dict() → dict

Serializes the PublicTokenInfo into a shallow dictionary of its immediate attributes.

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

Deserializes the PublicTokenInfo from a dictionary.

class databricks.sdk.service.settings.RestrictWorkspaceAdminsMessage(status: 'RestrictWorkspaceAdminsMessageStatus', disable_gov_tag_creation: 'Optional[bool]' = None)

status: RestrictWorkspaceAdminsMessageStatus

disable_gov_tag_creation: bool | None = None

When true, workspace admins cannot create governance tags. ALLOW_ALL status does not override this; they are independent.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the RestrictWorkspaceAdminsMessage into a shallow dictionary of its immediate attributes.

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"

class databricks.sdk.service.settings.RestrictWorkspaceAdminsSetting(restrict_workspace_admins: 'RestrictWorkspaceAdminsMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

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.

as_shallow_dict() → dict

Serializes the RestrictWorkspaceAdminsSetting into a shallow dictionary of its immediate attributes.

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

Deserializes the RestrictWorkspaceAdminsSetting 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.

as_shallow_dict() → dict

Serializes the RevokeTokenResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the RevokeTokenResponse from a dictionary.

class databricks.sdk.service.settings.SlackConfig(channel_id: 'Optional[str]' = None, channel_id_set: 'Optional[bool]' = None, oauth_token: 'Optional[str]' = None, oauth_token_set: 'Optional[bool]' = None, url: 'Optional[str]' = None, url_set: 'Optional[bool]' = None)

channel_id: str | None = None

[Input-Only] Slack channel ID for notifications.

channel_id_set: bool | None = None

[Output-Only] Whether channel ID is set.

oauth_token: str | None = None

[Input-Only] OAuth token for Slack authentication.

oauth_token_set: bool | None = None

[Output-Only] Whether OAuth token is set.

url: str | None = None

[Input-Only] URL for Slack destination.

url_set: bool | None = None

[Output-Only] Whether URL is set.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the SlackConfig into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SlackConfig

Deserializes the SlackConfig from a dictionary.

class databricks.sdk.service.settings.SqlResultsDownload(boolean_val: 'BooleanMessage', etag: 'Optional[str]' = None, setting_name: 'Optional[str]' = None)

boolean_val: BooleanMessage

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 SqlResultsDownload into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SqlResultsDownload into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SqlResultsDownload

Deserializes the SqlResultsDownload from a dictionary.

class databricks.sdk.service.settings.StringMessage(value: 'Optional[str]' = None)

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.

as_shallow_dict() → dict

Serializes the StringMessage into a shallow dictionary of its immediate attributes.

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

Deserializes the StringMessage from a dictionary.

class databricks.sdk.service.settings.TokenAccessControlRequest(group_name: 'Optional[str]' = None, permission_level: 'Optional[TokenPermissionLevel]' = None, service_principal_name: 'Optional[str]' = None, user_name: 'Optional[str]' = None)

group_name: str | None = None

name of the group

permission_level: TokenPermissionLevel | None = None

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.

as_shallow_dict() → dict

Serializes the TokenAccessControlRequest into a shallow dictionary of its immediate attributes.

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

Deserializes the TokenAccessControlRequest from a dictionary.

class databricks.sdk.service.settings.TokenAccessControlResponse(all_permissions: 'Optional[List[TokenPermission]]' = None, display_name: 'Optional[str]' = None, group_name: 'Optional[str]' = None, service_principal_name: 'Optional[str]' = None, user_name: 'Optional[str]' = None)

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.

as_shallow_dict() → dict

Serializes the TokenAccessControlResponse into a shallow dictionary of its immediate attributes.

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

Deserializes the TokenAccessControlResponse from a dictionary.

class databricks.sdk.service.settings.TokenInfo(autoscope_state: 'Optional[iam.AutoscopeState]' = None, backfill_scopes: 'Optional[List[str]]' = None, comment: 'Optional[str]' = None, created_by_id: 'Optional[int]' = None, created_by_username: 'Optional[str]' = None, creation_time: 'Optional[int]' = None, expiry_time: 'Optional[int]' = None, inferred_scopes: 'Optional[List[str]]' = None, last_used_day: 'Optional[int]' = None, owner_id: 'Optional[int]' = None, scopes: 'Optional[List[str]]' = None, token_id: 'Optional[str]' = None, workspace_id: 'Optional[int]' = None)

autoscope_state: AutoscopeState | None = None

Output only. The autoscope state of this token.

backfill_scopes: List[str] | None = None

Output only. Scopes inferred from offline backfill processing.

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.

inferred_scopes: List[str] | None = None

Output only. Inferred API path scopes collected for this token when autoscope is enabled.

last_used_day: int | None = None

Approximate timestamp for the day the token was last used. Accurate up to 1 day.

owner_id: int | None = None

User ID of the user that owns the token.

scopes: List[str] | None = None

Scope of the token was created with, if applicable.

token_id: str | None = None

ID of the token.

workspace_id: int | None = None

If applicable, the ID of the workspace that the token was created in.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the TokenInfo into a shallow dictionary of its immediate attributes.

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

Deserializes the TokenInfo from a dictionary.

class databricks.sdk.service.settings.TokenPermission(inherited: 'Optional[bool]' = None, inherited_from_object: 'Optional[List[str]]' = None, permission_level: 'Optional[TokenPermissionLevel]' = None)

inherited: bool | None = None

inherited_from_object: List[str] | None = None

permission_level: TokenPermissionLevel | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the TokenPermission into a shallow dictionary of its immediate attributes.

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: 'Optional[List[TokenAccessControlResponse]]' = None, object_id: 'Optional[str]' = None, object_type: 'Optional[str]' = None)

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.

as_shallow_dict() → dict

Serializes the TokenPermissions into a shallow dictionary of its immediate attributes.

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

Deserializes the TokenPermissions from a dictionary.

class databricks.sdk.service.settings.TokenPermissionsDescription(description: 'Optional[str]' = None, permission_level: 'Optional[TokenPermissionLevel]' = None)

description: str | None = None

permission_level: TokenPermissionLevel | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the TokenPermissionsDescription into a shallow dictionary of its immediate attributes.

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

Deserializes the TokenPermissionsDescription from a dictionary.

class databricks.sdk.service.settings.TokenType

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

ARCLIGHT_AZURE_EXCHANGE_TOKEN = "ARCLIGHT_AZURE_EXCHANGE_TOKEN"

ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY = "ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY"

ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN = "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN"

ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY = "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY"

AZURE_ACTIVE_DIRECTORY_TOKEN = "AZURE_ACTIVE_DIRECTORY_TOKEN"

class databricks.sdk.service.settings.UpdatePrivateEndpointRule(domain_names: List[str] | None = None, enabled: bool | None = None, error_message: str | None = None, gcp_endpoint: GcpEndpoint | None = None, resource_names: List[str] | None = None)

Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

domain_names: List[str] | None = None

Only used by private endpoints to customer-managed private endpoint services.

Domain names of target private link service. When updating this field, the full list of target domain_names must be specified.

enabled: bool | None = None

Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3).

error_message: str | None = None

gcp_endpoint: GcpEndpoint | None = None

resource_names: List[str] | None = None

Only used by private endpoints towards AWS S3 service.

The globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. When updating this field, we perform full update on this field. Please ensure a full list of desired resource_names is provided.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the UpdatePrivateEndpointRule into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UpdatePrivateEndpointRule

Deserializes the UpdatePrivateEndpointRule from a dictionary.

class databricks.sdk.service.settings.UpdateTokenResponse

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the UpdateTokenResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UpdateTokenResponse

Deserializes the UpdateTokenResponse from a dictionary.

class databricks.sdk.service.settings.WorkspaceNetworkOption(network_policy_id: 'Optional[str]' = None, workspace_id: 'Optional[int]' = None)

network_policy_id: str | None = None

The network policy ID to apply to the workspace. This controls the network access rules for all serverless compute resources in the workspace. Each workspace can only be linked to one policy at a time. If no policy is explicitly assigned, the workspace will use ‘default-policy’.

workspace_id: int | None = None

The workspace ID.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the WorkspaceNetworkOption into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → WorkspaceNetworkOption

Deserializes the WorkspaceNetworkOption from a dictionary.