Databricks SDK for JavaScript
    Preparing search index...

    Interface WorkspaceNetwork

    The network configuration for workspaces.

    interface WorkspaceNetwork {
        gcpCommonNetworkConfig?: GcpCommonNetworkConfig;
        network?:
            | {
                $case: "gcpManagedNetworkConfig";
                gcpManagedNetworkConfig: GcpManagedNetworkConfig;
            }
            | { $case: "networkId"; networkId: string };
    }
    Index

    Properties

    gcpCommonNetworkConfig? network?

    Properties

    gcpCommonNetworkConfig?: GcpCommonNetworkConfig

    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.

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

    Type Declaration

    • {
          $case: "gcpManagedNetworkConfig";
          gcpManagedNetworkConfig: GcpManagedNetworkConfig;
      }
      • $case: "gcpManagedNetworkConfig"
      • gcpManagedNetworkConfig: GcpManagedNetworkConfig

        The mutually exclusive network deployment modes. The option decides which network mode the workspace will use. The network config for GCP workspace with managed network. This object is input-only and will not be provided when listing workspaces.

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

    Settings

    Member Visibility

    On This Page

    Properties