Provisioning

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

class databricks.sdk.service.provisioning.AwsCredentials(sts_role: 'Optional[StsRole]' = None)

sts_role: StsRole | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AwsCredentials from a dictionary.

class databricks.sdk.service.provisioning.AwsKeyInfo(key_arn: 'str', key_region: 'str', key_alias: 'Optional[str]' = None, reuse_key_for_cluster_volumes: 'Optional[bool]' = None)

key_arn: str

The AWS KMS key’s Amazon Resource Name (ARN).

key_region: str

The AWS KMS key region.

key_alias: str | None = None

The AWS KMS key alias.

reuse_key_for_cluster_volumes: bool | None = None

This field applies only if the use_cases property includes STORAGE. If this is set to true or omitted, the key is also used to encrypt cluster EBS volumes. If you do not want to use this key for encrypting EBS volumes, set to false.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AwsKeyInfo from a dictionary.

class databricks.sdk.service.provisioning.AzureKeyInfo(disk_encryption_set_id: 'Optional[str]' = None, key_access_configuration: 'Optional[KeyAccessConfiguration]' = None, key_name: 'Optional[str]' = None, key_vault_uri: 'Optional[str]' = None, tenant_id: 'Optional[str]' = None, version: 'Optional[str]' = None)

disk_encryption_set_id: str | None = None

The Disk Encryption Set id that is used to represent the key info used for Managed Disk BYOK use case

key_access_configuration: KeyAccessConfiguration | None = None

The structure to store key access credential This is set if the Managed Identity is being used to access the Azure Key Vault key.

key_name: str | None = None

The name of the key in KeyVault.

key_vault_uri: str | None = None

The base URI of the KeyVault.

tenant_id: str | None = None

The tenant id where the KeyVault lives.

version: str | None = None

The current key version.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureKeyInfo from a dictionary.

class databricks.sdk.service.provisioning.AzureWorkspaceInfo(resource_group: 'Optional[str]' = None, subscription_id: 'Optional[str]' = None)

resource_group: str | None = None

Azure Resource Group name

subscription_id: str | None = None

Azure Subscription ID

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureWorkspaceInfo from a dictionary.

class databricks.sdk.service.provisioning.CloudResourceContainer(gcp: 'Optional[CustomerFacingGcpCloudResourceContainer]' = None)

gcp: CustomerFacingGcpCloudResourceContainer | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CloudResourceContainer from a dictionary.

class databricks.sdk.service.provisioning.CreateAwsKeyInfo(key_arn: 'str', key_alias: 'Optional[str]' = None, key_region: 'Optional[str]' = None, reuse_key_for_cluster_volumes: 'Optional[bool]' = None)

key_arn: str

The AWS KMS key’s Amazon Resource Name (ARN).

key_alias: str | None = None

The AWS KMS key alias.

key_region: str | None = None

The AWS KMS key region.

reuse_key_for_cluster_volumes: bool | None = None

This field applies only if the use_cases property includes STORAGE. If this is set to true or omitted, the key is also used to encrypt cluster EBS volumes. If you do not want to use this key for encrypting EBS volumes, set to false.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateAwsKeyInfo from a dictionary.

class databricks.sdk.service.provisioning.CreateAzureKeyInfo(disk_encryption_set_id: 'Optional[str]' = None, key_access_configuration: 'Optional[KeyAccessConfiguration]' = None, key_name: 'Optional[str]' = None, key_vault_uri: 'Optional[str]' = None, tenant_id: 'Optional[str]' = None, version: 'Optional[str]' = None)

disk_encryption_set_id: str | None = None

The Disk Encryption Set id that is used to represent the key info used for Managed Disk BYOK use case

key_access_configuration: KeyAccessConfiguration | None = None

The structure to store key access credential This is set if the Managed Identity is being used to access the Azure Key Vault key.

key_name: str | None = None

The name of the key in KeyVault.

key_vault_uri: str | None = None

The base URI of the KeyVault.

tenant_id: str | None = None

The tenant id where the KeyVault lives.

version: str | None = None

The current key version.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateAzureKeyInfo from a dictionary.

class databricks.sdk.service.provisioning.CreateCredentialAwsCredentials(sts_role: 'Optional[CreateCredentialStsRole]' = None)

sts_role: CreateCredentialStsRole | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateCredentialAwsCredentials from a dictionary.

class databricks.sdk.service.provisioning.CreateCredentialStsRole(role_arn: 'Optional[str]' = None)

role_arn: str | None = None

The Amazon Resource Name (ARN) of the cross account IAM role.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateCredentialStsRole from a dictionary.

class databricks.sdk.service.provisioning.CreateGcpKeyInfo(kms_key_id: 'str', gcp_service_account: 'Optional[GcpServiceAccount]' = None, manual: 'Optional[bool]' = None)

kms_key_id: str

Globally unique kms key resource id of the form projects/testProjectId/locations/us-east4/keyRings/gcpCmkKeyRing/cryptoKeys/cmk-eastus4

gcp_service_account: GcpServiceAccount | None = None

Globally unique service account email that has access to the KMS key. The service account exists within the Databricks CP project.

manual: bool | None = None

When true, Databricks will not use OAuth to grant the service account access to the KMS key. The customer is responsible for granting access manually.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateGcpKeyInfo from a dictionary.

class databricks.sdk.service.provisioning.Credential(account_id: 'Optional[str]' = None, aws_credentials: 'Optional[AwsCredentials]' = None, creation_time: 'Optional[int]' = None, credentials_id: 'Optional[str]' = None, credentials_name: 'Optional[str]' = None)

account_id: str | None = None

The Databricks account ID that hosts the credential.

aws_credentials: AwsCredentials | None = None

creation_time: int | None = None

Time in epoch milliseconds when the credential was created.

credentials_id: str | None = None

Databricks credential configuration ID.

credentials_name: str | None = None

The human-readable name of the credential configuration object.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the Credential from a dictionary.

class databricks.sdk.service.provisioning.CustomerFacingComputeMode

Corresponds to compute mode defined here: https://src.dev.databricks.com/databricks/universe@9076536b18479afd639d1c1f9dd5a59f72215e69/-/blob/central/api/common.proto?L872

HYBRID = "HYBRID"

SERVERLESS = "SERVERLESS"

class databricks.sdk.service.provisioning.CustomerFacingGcpCloudResourceContainer(project_id: 'Optional[str]' = None)

project_id: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CustomerFacingGcpCloudResourceContainer from a dictionary.

class databricks.sdk.service.provisioning.CustomerFacingStorageMode

CUSTOMER_HOSTED = "CUSTOMER_HOSTED"

DEFAULT_STORAGE = "DEFAULT_STORAGE"

class databricks.sdk.service.provisioning.CustomerManagedKey(account_id: 'Optional[str]' = None, aws_key_info: 'Optional[AwsKeyInfo]' = None, azure_key_info: 'Optional[AzureKeyInfo]' = None, creation_time: 'Optional[int]' = None, customer_managed_key_id: 'Optional[str]' = None, gcp_key_info: 'Optional[GcpKeyInfo]' = None, use_cases: 'Optional[List[KeyUseCase]]' = None)

account_id: str | None = None

The Databricks account ID that holds the customer-managed key.

aws_key_info: AwsKeyInfo | None = None

azure_key_info: AzureKeyInfo | None = None

creation_time: int | None = None

Time in epoch milliseconds when the customer key was created.

customer_managed_key_id: str | None = None

ID of the encryption key configuration object.

gcp_key_info: GcpKeyInfo | None = None

use_cases: List[KeyUseCase] | None = None

The cases that the key can be used for.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CustomerManagedKey from a dictionary.

class databricks.sdk.service.provisioning.EndpointUseCase

DATAPLANE_RELAY_ACCESS = "DATAPLANE_RELAY_ACCESS"

GENERAL_ACCESS = "GENERAL_ACCESS"

WORKSPACE_ACCESS = "WORKSPACE_ACCESS"

class databricks.sdk.service.provisioning.ErrorType

ErrorType and WarningType are used to represent the type of error or warning by NetworkHealth and NetworkWarning defined in central/api/accounts/accounts.proto

CREDENTIALS = "CREDENTIALS"

NETWORK_ACL = "NETWORK_ACL"

SECURITY_GROUP = "SECURITY_GROUP"

SUBNET = "SUBNET"

VPC = "VPC"

class databricks.sdk.service.provisioning.GcpCommonNetworkConfig(gke_cluster_master_ip_range: str | None = None, gke_connectivity_type: GkeConfigConnectivityType | None = None)

The shared network config for GCP workspace. This object has common network configurations that are network attributions of a workspace. DEPRECATED. Use GkeConfig instead.

gke_cluster_master_ip_range: str | None = None

The IP range that will be used to allocate GKE cluster master resources from. This field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.

gke_connectivity_type: GkeConfigConnectivityType | None = None

The type of network connectivity of the GKE cluster.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GcpCommonNetworkConfig from a dictionary.

class databricks.sdk.service.provisioning.GcpKeyInfo(kms_key_id: 'str', gcp_service_account: 'Optional[GcpServiceAccount]' = None, manual: 'Optional[bool]' = None)

kms_key_id: str

Globally unique kms key resource id of the form projects/testProjectId/locations/us-east4/keyRings/gcpCmkKeyRing/cryptoKeys/cmk-eastus4

gcp_service_account: GcpServiceAccount | None = None

Globally unique service account email that has access to the KMS key. The service account exists within the Databricks CP project.

manual: bool | None = None

When true, Databricks will not use OAuth to grant the service account access to the KMS key. The customer is responsible for granting access manually.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GcpKeyInfo from a dictionary.

class databricks.sdk.service.provisioning.GcpManagedNetworkConfig(gke_cluster_pod_ip_range: str | None = None, gke_cluster_service_ip_range: str | None = None, subnet_cidr: str | None = None)

The network configuration for the workspace.

gke_cluster_pod_ip_range: str | None = None

The IP range that will be used to allocate GKE cluster Pods from.

gke_cluster_service_ip_range: str | None = None

The IP range that will be used to allocate GKE cluster Services from.

subnet_cidr: str | None = None

The IP range which will be used to allocate GKE cluster nodes from. Note: Pods, services and master IP range must be mutually exclusive.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GcpManagedNetworkConfig from a dictionary.

class databricks.sdk.service.provisioning.GcpNetworkInfo(network_project_id: 'str', vpc_id: 'str', subnet_id: 'str', subnet_region: 'str', pod_ip_range_name: 'str', service_ip_range_name: 'str')

network_project_id: str

The GCP project ID for network resources. This project is where the VPC and subnet resides.

vpc_id: str

The customer-provided VPC ID.

subnet_id: str

The customer-provided Subnet ID that will be available to Clusters in Workspaces using this Network.

subnet_region: str

pod_ip_range_name: str

Name of the secondary range within the subnet that will be used by GKE as Pod IP range. This is BYO VPC specific. DB VPC uses network.getGcpManagedNetworkConfig.getGkeClusterPodIpRange

service_ip_range_name: str

Name of the secondary range within the subnet that will be used by GKE as Service IP range.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GcpNetworkInfo from a dictionary.

class databricks.sdk.service.provisioning.GcpServiceAccount(service_account_email: 'Optional[str]' = None)

service_account_email: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GcpServiceAccount from a dictionary.

class databricks.sdk.service.provisioning.GcpVpcEndpointInfo(project_id: 'str', psc_endpoint_name: 'str', endpoint_region: 'str', psc_connection_id: 'Optional[str]' = None, service_attachment_id: 'Optional[str]' = None)

project_id: str

psc_endpoint_name: str

endpoint_region: str

psc_connection_id: str | None = None

service_attachment_id: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GcpVpcEndpointInfo from a dictionary.

class databricks.sdk.service.provisioning.GkeConfig(connectivity_type: GkeConfigConnectivityType | None = None, master_ip_range: str | None = None)

The configurations of the GKE cluster used by the GCP workspace.

connectivity_type: GkeConfigConnectivityType | None = None

The type of network connectivity of the GKE cluster.

master_ip_range: str | None = None

The IP range that will be used to allocate GKE cluster master resources from. This field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GkeConfig from a dictionary.

class databricks.sdk.service.provisioning.GkeConfigConnectivityType

Specifies the network connectivity types for the GKE nodes and the GKE master network. Set to PRIVATE_NODE_PUBLIC_MASTER for a private GKE cluster for the workspace. The GKE nodes will not have public IPs. Set to PUBLIC_NODE_PUBLIC_MASTER for a public GKE cluster. The nodes of a public GKE cluster have public IP addresses.

PRIVATE_NODE_PUBLIC_MASTER = "PRIVATE_NODE_PUBLIC_MASTER"

PUBLIC_NODE_PUBLIC_MASTER = "PUBLIC_NODE_PUBLIC_MASTER"

class databricks.sdk.service.provisioning.KeyAccessConfiguration(credential_id: str | None = None)

The credential ID that is used to access the key vault.

credential_id: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the KeyAccessConfiguration from a dictionary.

class databricks.sdk.service.provisioning.KeyUseCase

MANAGED_SERVICES = "MANAGED_SERVICES"

STORAGE = "STORAGE"

class databricks.sdk.service.provisioning.Network(account_id: 'Optional[str]' = None, creation_time: 'Optional[int]' = None, error_messages: 'Optional[List[NetworkHealth]]' = None, gcp_network_info: 'Optional[GcpNetworkInfo]' = None, network_id: 'Optional[str]' = None, network_name: 'Optional[str]' = None, security_group_ids: 'Optional[List[str]]' = None, subnet_ids: 'Optional[List[str]]' = None, vpc_endpoints: 'Optional[NetworkVpcEndpoints]' = None, vpc_id: 'Optional[str]' = None, vpc_status: 'Optional[VpcStatus]' = None, warning_messages: 'Optional[List[NetworkWarning]]' = None, workspace_id: 'Optional[int]' = None)

account_id: str | None = None

The Databricks account ID associated with this network configuration.

creation_time: int | None = None

Time in epoch milliseconds when the network was created.

error_messages: List[NetworkHealth] | None = None

Array of error messages about the network configuration.

gcp_network_info: GcpNetworkInfo | None = None

network_id: str | None = None

The Databricks network configuration ID.

network_name: str | None = None

The human-readable name of the network configuration.

security_group_ids: List[str] | None = None

IDs of one to five security groups associated with this network. Security group IDs cannot be used in multiple network configurations.

subnet_ids: List[str] | None = None

IDs of at least two subnets associated with this network. Subnet IDs cannot be used in multiple network configurations.

vpc_endpoints: NetworkVpcEndpoints | None = None

vpc_id: str | None = None

The ID of the VPC associated with this network configuration. VPC IDs can be used in multiple networks.

vpc_status: VpcStatus | None = None

warning_messages: List[NetworkWarning] | None = None

Array of warning messages about the network configuration.

workspace_id: int | None = None

Workspace ID associated with this network configuration.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the Network from a dictionary.

class databricks.sdk.service.provisioning.NetworkHealth(error_message: 'Optional[str]' = None, error_type: 'Optional[ErrorType]' = None)

error_message: str | None = None

Details of the error.

error_type: ErrorType | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the NetworkHealth from a dictionary.

class databricks.sdk.service.provisioning.NetworkVpcEndpoints(dataplane_relay: 'Optional[List[str]]' = None, rest_api: 'Optional[List[str]]' = None)

dataplane_relay: List[str] | None = None

The VPC endpoint ID used by this network to access the Databricks secure cluster connectivity relay.

rest_api: List[str] | None = None

The VPC endpoint ID used by this network to access the Databricks REST API.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the NetworkVpcEndpoints from a dictionary.

class databricks.sdk.service.provisioning.NetworkWarning(warning_message: 'Optional[str]' = None, warning_type: 'Optional[WarningType]' = None)

warning_message: str | None = None

Details of the warning.

warning_type: WarningType | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the NetworkWarning from a dictionary.

class databricks.sdk.service.provisioning.PricingTier

COMMUNITY_EDITION = "COMMUNITY_EDITION"

DEDICATED = "DEDICATED"

ENTERPRISE = "ENTERPRISE"

PREMIUM = "PREMIUM"

STANDARD = "STANDARD"

UNKNOWN = "UNKNOWN"

class databricks.sdk.service.provisioning.PrivateAccessLevel

ACCOUNT = "ACCOUNT"

ENDPOINT = "ENDPOINT"

class databricks.sdk.service.provisioning.PrivateAccessSettings(account_id: str | None = None, allowed_vpc_endpoint_ids: List[str] | None = None, private_access_level: PrivateAccessLevel | None = None, private_access_settings_id: str | None = None, private_access_settings_name: str | None = None, public_access_enabled: bool | None = None, region: str | None = None)

account_id: str | None = None

The Databricks account ID that hosts the private access settings.

allowed_vpc_endpoint_ids: List[str] | None = None

An array of Databricks VPC endpoint IDs. This is the Databricks ID that is returned when registering the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC endpoint in AWS. Only used when private_access_level is set to ENDPOINT. This is an allow list of VPC endpoints that in your account that can connect to your workspace over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see IP access lists.

private_access_level: PrivateAccessLevel | None = None

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (the default) allows only VPC endpoints that are registered in your Databricks account connect to your workspace. ENDPOINT level access allows only specified VPC endpoints connect to your workspace. For details, see allowed_vpc_endpoint_ids.

private_access_settings_id: str | None = None

Databricks private access settings ID.

private_access_settings_name: str | None = None

The human-readable name of the private access settings object.

public_access_enabled: bool | None = None

Determines if the workspace can be accessed over public internet. For fully private workspaces, you can optionally specify false, but only if you implement both the front-end and the back-end PrivateLink connections. Otherwise, specify true, which means that public access is enabled.

region: str | None = None

The AWS region for workspaces attached to this private access settings object.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the PrivateAccessSettings from a dictionary.

class databricks.sdk.service.provisioning.RootBucketInfo(bucket_name: 'Optional[str]' = None)

bucket_name: str | None = None

Name of the S3 bucket

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RootBucketInfo from a dictionary.

class databricks.sdk.service.provisioning.StorageConfiguration(account_id: 'Optional[str]' = None, creation_time: 'Optional[int]' = None, role_arn: 'Optional[str]' = None, root_bucket_info: 'Optional[RootBucketInfo]' = None, storage_configuration_id: 'Optional[str]' = None, storage_configuration_name: 'Optional[str]' = None)

account_id: str | None = None

The Databricks account ID associated with this storage configuration.

creation_time: int | None = None

Time in epoch milliseconds when the storage configuration was created.

role_arn: str | None = None

Optional IAM role that is used to access the workspace catalog which is created during workspace creation for UC by Default. If a storage configuration with this field populated is used to create a workspace, then a workspace catalog is created together with the workspace. The workspace catalog shares the root bucket with internal workspace storage (including DBFS root) but uses a dedicated bucket path prefix.

root_bucket_info: RootBucketInfo | None = None

The root bucket information for the storage configuration.

storage_configuration_id: str | None = None

Databricks storage configuration ID.

storage_configuration_name: str | None = None

The human-readable name of the storage configuration.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the StorageConfiguration from a dictionary.

class databricks.sdk.service.provisioning.StsRole(role_arn: 'Optional[str]' = None)

role_arn: str | None = None

The Amazon Resource Name (ARN) of the cross account IAM role.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the StsRole from a dictionary.

class databricks.sdk.service.provisioning.VpcEndpoint(account_id: str | None = None, aws_account_id: str | None = None, aws_endpoint_service_id: str | None = None, aws_vpc_endpoint_id: str | None = None, gcp_vpc_endpoint_info: GcpVpcEndpointInfo | None = None, region: str | None = None, state: str | None = None, use_case: EndpointUseCase | None = None, vpc_endpoint_id: str | None = None, vpc_endpoint_name: str | None = None)

account_id: str | None = None

The Databricks account ID that hosts the VPC endpoint configuration.

aws_account_id: str | None = None

The AWS Account in which the VPC endpoint object exists.

aws_endpoint_service_id: str | None = None

The ID of the Databricks [endpoint service] that this VPC endpoint is connected to. For a list of endpoint service IDs for each supported AWS region, see the [Databricks PrivateLink documentation].

[Databricks PrivateLink documentation]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html [endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-service.html

aws_vpc_endpoint_id: str | None = None

The ID of the VPC endpoint object in AWS.

gcp_vpc_endpoint_info: GcpVpcEndpointInfo | None = None

The cloud info of this vpc endpoint. Info for a GCP vpc endpoint.

region: str | None = None

The AWS region in which this VPC endpoint object exists.

state: str | None = None

The current state (such as available or rejected) of the VPC endpoint. Derived from AWS. For the full set of values, see [AWS DescribeVpcEndpoint documentation].

[AWS DescribeVpcEndpoint documentation]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html

use_case: EndpointUseCase | None = None

This enumeration represents the type of Databricks VPC endpoint service that was used when creating this VPC endpoint. If the VPC endpoint connects to the Databricks control plane for either the front-end connection or the back-end REST API connection, the value is GENERAL_ACCESS. If the VPC endpoint connects to the Databricks workspace for the back-end secure cluster connectivity relay, the value is DATAPLANE_RELAY_ACCESS.

vpc_endpoint_id: str | None = None

Databricks VPC endpoint ID. This is the Databricks-specific name of the VPC endpoint. Do not confuse this with the aws_vpc_endpoint_id, which is the ID within AWS of the VPC endpoint.

vpc_endpoint_name: str | None = None

The human-readable name of the storage configuration.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the VpcEndpoint from a dictionary.

class databricks.sdk.service.provisioning.VpcStatus

BROKEN = "BROKEN"

UNATTACHED = "UNATTACHED"

VALID = "VALID"

WARNED = "WARNED"

class databricks.sdk.service.provisioning.WarningType

SECURITY_GROUP = "SECURITY_GROUP"

SUBNET = "SUBNET"

class databricks.sdk.service.provisioning.Workspace(account_id: 'Optional[str]' = None, aws_region: 'Optional[str]' = None, azure_workspace_info: 'Optional[AzureWorkspaceInfo]' = None, cloud: 'Optional[str]' = None, cloud_resource_container: 'Optional[CloudResourceContainer]' = None, compute_mode: 'Optional[CustomerFacingComputeMode]' = None, creation_time: 'Optional[int]' = None, credentials_id: 'Optional[str]' = None, custom_tags: 'Optional[Dict[str, str]]' = None, deployment_name: 'Optional[str]' = None, expected_workspace_status: 'Optional[WorkspaceStatus]' = None, gcp_managed_network_config: 'Optional[GcpManagedNetworkConfig]' = None, gke_config: 'Optional[GkeConfig]' = None, location: 'Optional[str]' = None, managed_services_customer_managed_key_id: 'Optional[str]' = None, network: 'Optional[WorkspaceNetwork]' = None, network_connectivity_config_id: 'Optional[str]' = None, network_id: 'Optional[str]' = None, pricing_tier: 'Optional[PricingTier]' = None, private_access_settings_id: 'Optional[str]' = None, storage_configuration_id: 'Optional[str]' = None, storage_customer_managed_key_id: 'Optional[str]' = None, storage_mode: 'Optional[CustomerFacingStorageMode]' = None, workspace_id: 'Optional[int]' = None, workspace_name: 'Optional[str]' = None, workspace_status: 'Optional[WorkspaceStatus]' = None, workspace_status_message: 'Optional[str]' = None)

account_id: str | None = None

Databricks account ID.

aws_region: str | None = None

azure_workspace_info: AzureWorkspaceInfo | None = None

cloud: str | None = None

The cloud name. This field can have values like azure, gcp.

cloud_resource_container: CloudResourceContainer | None = None

compute_mode: CustomerFacingComputeMode | None = None

The compute mode of the workspace.

creation_time: int | None = None

Time in epoch milliseconds when the workspace was created.

credentials_id: str | None = None

ID of the workspace’s credential configuration object.

custom_tags: Dict[str, str] | None = None

The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The value can be an empty string, with maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.

deployment_name: str | None = None

expected_workspace_status: WorkspaceStatus | None = None

A client owned field used to indicate the workspace status that the client expects to be in. For now this is only used to unblock Temporal workflow for GCP least privileged workspace.

gcp_managed_network_config: GcpManagedNetworkConfig | None = None

gke_config: GkeConfig | None = None

location: str | None = None

The Google Cloud region of the workspace data plane in your Google account (for example, us-east4).

managed_services_customer_managed_key_id: str | None = None

ID of the key configuration for encrypting managed services.

network: WorkspaceNetwork | None = None

The network configuration for the workspace.

DEPRECATED. Use network_id instead.

network_connectivity_config_id: str | None = None

The object ID of network connectivity config.

network_id: str | None = None

If this workspace is BYO VPC, then the network_id will be populated. If this workspace is not BYO VPC, then the network_id will be empty.

pricing_tier: PricingTier | None = None

private_access_settings_id: str | None = None

ID of the workspace’s private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink] for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.

Before configuring PrivateLink, read the [Databricks article about PrivateLink].”,

[AWS PrivateLink]: https://aws.amazon.com/privatelink/ [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html

storage_configuration_id: str | None = None

ID of the workspace’s storage configuration object.

storage_customer_managed_key_id: str | None = None

ID of the key configuration for encrypting workspace storage.

storage_mode: CustomerFacingStorageMode | None = None

The storage mode of the workspace.

workspace_id: int | None = None

A unique integer ID for the workspace

workspace_name: str | None = None

The human-readable name of the workspace.

workspace_status: WorkspaceStatus | None = None

The status of a workspace

workspace_status_message: str | None = None

Message describing the current workspace status.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the Workspace from a dictionary.

class databricks.sdk.service.provisioning.WorkspaceNetwork(gcp_common_network_config: GcpCommonNetworkConfig | None = None, gcp_managed_network_config: GcpManagedNetworkConfig | None = None, network_id: str | None = None)

The network configuration for workspaces.

gcp_common_network_config: GcpCommonNetworkConfig | None = None

The shared network config for GCP workspace. This object has common network configurations that are network attributions of a workspace. This object is input-only.

gcp_managed_network_config: GcpManagedNetworkConfig | None = None

The mutually exclusive network deployment modes. The option decides which network mode the workspace will use. The network config for GCP workspace with Databricks managed network. This object is input-only and will not be provided when listing workspaces. See go/gcp-byovpc-alpha-design for interface decisions.

network_id: str | None = None

The ID of the network object, if the workspace is a BYOVPC workspace. This should apply to workspaces on all clouds in internal services. In accounts-rest-api, user will use workspace.network_id for input and output instead. Currently (2021-06-19) the network ID is only used by GCP.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the WorkspaceNetwork from a dictionary.

class databricks.sdk.service.provisioning.WorkspaceStatus

The different statuses of a workspace. The following represents the current set of valid transitions from status to status: NOT_PROVISIONED -> PROVISIONING -> CANCELLED PROVISIONING -> RUNNING -> FAILED -> CANCELLED (note that this transition is disallowed in the MultiWorkspace Project) RUNNING -> PROVISIONING -> BANNED -> CANCELLED FAILED -> PROVISIONING -> CANCELLED BANNED -> RUNNING -> CANCELLED Note that a transition from any state to itself is also valid. TODO(PLAT-5867): add a transition from CANCELLED to some other value (e.g. RECOVERING)

BANNED = "BANNED"

CANCELLING = "CANCELLING"

FAILED = "FAILED"

NOT_PROVISIONED = "NOT_PROVISIONED"

PROVISIONING = "PROVISIONING"

RUNNING = "RUNNING"