# The Workspace object

## Attributes

- `workspace_id` (int64)
  A unique integer ID for the workspace
- `workspace_name` (string)
  The human-readable name of the workspace.
  Constraints: `[ 1 .. 100 ] characters`
- `aws_region` (string)
  **AWS:** The AWS region of the workspace data plane (for example, `us-west-2`).
- `creation_time` (int64)
  Time in epoch milliseconds when the workspace was created.
- `deployment_name` (string)
  **AWS:** The deployment name defines part of the subdomain for the workspace. The workspace URL for web application and REST APIs is `<deployment-name>.cloud.databricks.com`.
  Constraints: `<= 64 characters`
- `workspace_status` (string)
  The status of a workspace
  Possible values: `NOT_PROVISIONED`, `PROVISIONING`, `RUNNING`, `FAILED`, `BANNED`, `CANCELLING`
- `account_id` (string)
  <Databricks> account ID.
- `credentials_id` (string)
  ID of the workspace's credential configuration object.
- `storage_configuration_id` (string)
  ID of the workspace's storage configuration object.
- `workspace_status_message` (string)
  Message describing the current workspace status.
- `network_id` (string)
  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.
- `gcp_managed_network_config` (object)
  **GCP:** The network config for GCP workspace with <Databricks> managed network.
  - `subnet_cidr` (string)
    The IP range which will be used to allocate GKE cluster nodes from.
     Note: Pods, services and master IP range must be mutually exclusive.
  - `gke_cluster_pod_ip_range` (string)
    The IP range that will be used to allocate GKE cluster Pods from.
  - `gke_cluster_service_ip_range` (string)
    The IP range that will be used to allocate GKE cluster Services from.
- `pricing_tier` (string)
  Possible values: `UNKNOWN`, `COMMUNITY_EDITION`, `STANDARD`, `PREMIUM`, `ENTERPRISE`, `DEDICATED`
- `private_access_settings_id` (string)
  ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/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](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).",
- `managed_services_customer_managed_key_id` (string)
  ID of the key configuration for encrypting managed services.
- `storage_customer_managed_key_id` (string)
  ID of the key configuration for encrypting workspace storage.
- `location` (string)
  The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`).
- `cloud` (string)
  The cloud name. This field can have values like `azure`, `gcp`.
- `network` (object)
  The network configuration for the workspace.
   
   DEPRECATED. Use `network_id` instead.
  **GCP:** The network configuration for the workspace.
  
  DEPRECATED. Use `network_id`,  and `gke_config`  instead.
  - `gcp_managed_network_config` (object)
    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.
    - `subnet_cidr` (string)
      The IP range which will be used to allocate GKE cluster nodes from.
       Note: Pods, services and master IP range must be mutually exclusive.
    - `gke_cluster_pod_ip_range` (string)
      The IP range that will be used to allocate GKE cluster Pods from.
    - `gke_cluster_service_ip_range` (string)
      The IP range that will be used to allocate GKE cluster Services from.
  - `network_id` (string)
    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.
  - `gcp_common_network_config` (object)
    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.
    - `gke_connectivity_type` (string)
      The type of network connectivity of the GKE cluster.
      Possible values: `PRIVATE_NODE_PUBLIC_MASTER`, `PUBLIC_NODE_PUBLIC_MASTER`
    - `gke_cluster_master_ip_range` (string)
      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.
- `azure_workspace_info` (object)
  - `resource_group` (string)
    Azure Resource Group name
  - `subscription_id` (string)
    Azure Subscription ID
- `gke_config` (object)
  **GCP:** The configurations of the GKE cluster used by the GCP workspace.
  - `connectivity_type` (string)
    The type of network connectivity of the GKE cluster.
    Possible values: `PRIVATE_NODE_PUBLIC_MASTER`, `PUBLIC_NODE_PUBLIC_MASTER`
  - `master_ip_range` (string)
    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.
- `cloud_resource_container` (object)
  - `gcp` (object)
    **GCP:** The GCP cloud entities in which GCP workspaces are.
    - `project_id` (string)
      **GCP:** The GCP project ID where the dataplane resources will be located in.
- `custom_tags` (object)
  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.
- `network_connectivity_config_id` (string)
  The object ID of network connectivity config.
- `storage_mode` (string)
  The storage mode of the workspace.
  Possible values: `CUSTOMER_HOSTED`, `DEFAULT_STORAGE`
- `compute_mode` (string)
  The compute mode of the workspace.
  Possible values: `HYBRID`, `SERVERLESS`

## Example

```json
{
  "workspace_id": 0,
  "workspace_name": "string",
  "aws_region": "string",
  "creation_time": 0,
  "deployment_name": "string",
  "workspace_status": "string",
  "account_id": "string",
  "credentials_id": "string",
  "storage_configuration_id": "string",
  "workspace_status_message": "string",
  "network_id": "string",
  "gcp_managed_network_config": {
    "subnet_cidr": "string",
    "gke_cluster_pod_ip_range": "string",
    "gke_cluster_service_ip_range": "string"
  },
  "pricing_tier": "string",
  "private_access_settings_id": "string",
  "managed_services_customer_managed_key_id": "string",
  "storage_customer_managed_key_id": "string",
  "location": "string",
  "cloud": "string",
  "network": {
    "gcp_managed_network_config": {},
    "network_id": "string",
    "gcp_common_network_config": {}
  },
  "azure_workspace_info": {
    "resource_group": "string",
    "subscription_id": "string"
  },
  "gke_config": {
    "connectivity_type": "string",
    "master_ip_range": "string"
  },
  "cloud_resource_container": {
    "gcp": {}
  },
  "custom_tags": {},
  "network_connectivity_config_id": "string",
  "storage_mode": "string",
  "compute_mode": "string"
}
```