Databricks SDK for JavaScript
    Preparing search index...

    Interface Workspace

    interface Workspace {
        accountId?: string;
        awsRegion?: string;
        azureWorkspaceInfo?: AzureWorkspaceInfo;
        cloud?: string;
        cloudResourceContainer?: CloudResourceContainer;
        computeMode?: ComputeMode;
        creationTime?: bigint;
        credentialsId?: string;
        customTags?: Record<string, string>;
        deploymentName?: string;
        expectedWorkspaceStatus?: WorkspaceStatus;
        gkeConfig?: GkeConfig;
        location?: string;
        managedServicesCustomerManagedKeyId?: string;
        network?: WorkspaceNetwork;
        networkConfig?:
            | { $case: "networkId"; networkId: string }
            | {
                $case: "gcpManagedNetworkConfig";
                gcpManagedNetworkConfig: GcpManagedNetworkConfig;
            };
        networkConnectivityConfigId?: string;
        pricingTier?: PricingTier;
        privateAccessSettingsId?: string;
        storageConfigurationId?: string;
        storageCustomerManagedKeyId?: string;
        storageMode?: StorageMode;
        workspaceId?: bigint;
        workspaceName?: string;
        workspaceStatus?: WorkspaceStatus;
        workspaceStatusMessage?: string;
    }
    Index

    Properties

    accountId? awsRegion? azureWorkspaceInfo? cloud? cloudResourceContainer? computeMode? creationTime? credentialsId? customTags? deploymentName? expectedWorkspaceStatus? gkeConfig? location? managedServicesCustomerManagedKeyId? network? networkConfig? networkConnectivityConfigId? pricingTier? privateAccessSettingsId? storageConfigurationId? storageCustomerManagedKeyId? storageMode? workspaceId? workspaceName? workspaceStatus? workspaceStatusMessage?

    Properties

    accountId?: string

    account ID.

    awsRegion?: string
    azureWorkspaceInfo?: AzureWorkspaceInfo
    cloud?: string

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

    cloudResourceContainer?: CloudResourceContainer
    computeMode?: ComputeMode

    The compute mode of the workspace.

    creationTime?: bigint

    Time in epoch milliseconds when the workspace was created.

    credentialsId?: string

    ID of the workspace's credential configuration object.

    customTags?: Record<string, string>

    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.

    deploymentName?: string
    expectedWorkspaceStatus?: WorkspaceStatus

    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.

    gkeConfig?: GkeConfig
    location?: string

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

    managedServicesCustomerManagedKeyId?: string

    ID of the key configuration for encrypting managed services.

    network?: WorkspaceNetwork

    The network configuration for the workspace.

    DEPRECATED. Use network_id instead.

    networkConfig?:
        | { $case: "networkId"; networkId: string }
        | {
            $case: "gcpManagedNetworkConfig";
            gcpManagedNetworkConfig: GcpManagedNetworkConfig;
        }

    Type Declaration

    • { $case: "networkId"; networkId: string }
      • $case: "networkId"
      • networkId: 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.

    • {
          $case: "gcpManagedNetworkConfig";
          gcpManagedNetworkConfig: GcpManagedNetworkConfig;
      }
    networkConnectivityConfigId?: string

    The object ID of network connectivity config.

    pricingTier?: PricingTier
    privateAccessSettingsId?: 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 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 article about PrivateLink.",

    storageConfigurationId?: string

    ID of the workspace's storage configuration object.

    storageCustomerManagedKeyId?: string

    ID of the key configuration for encrypting workspace storage.

    storageMode?: StorageMode

    The storage mode of the workspace.

    workspaceId?: bigint

    A unique integer ID for the workspace

    workspaceName?: string

    The human-readable name of the workspace.

    workspaceStatus?: WorkspaceStatus

    The status of a workspace

    workspaceStatusMessage?: string

    Message describing the current workspace status.

    Settings

    Member Visibility

    On This Page

    Properties