a.network_connectivity: Network Connectivity

class databricks.sdk.service.settings.NetworkConnectivityAPI

These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources.

create_network_connectivity_configuration(name: str, region: str) → NetworkConnectivityConfiguration

Create a network connectivity configuration.

Parameters:

  • 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.

Returns:

NetworkConnectivityConfiguration

create_private_endpoint_rule(network_connectivity_config_id: str, resource_id: str, group_id: CreatePrivateEndpointRuleRequestGroupId) → NccAzurePrivateEndpointRule

Create a private endpoint rule.

Create a private endpoint rule for the specified network connectivity config object. Once the object is created, Databricks asynchronously provisions a new Azure private endpoint to your specified Azure resource.

IMPORTANT: You must use Azure portal or other Azure tools to approve the private endpoint to complete the connection. To get the information of the private endpoint created, make a GET request on the new private endpoint rule. See [serverless private link].

[serverless private link]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link

Parameters:

  • network_connectivity_config_id – str Your Network Connectvity Configuration ID.

  • resource_id – str The Azure resource ID of the target resource.

  • group_id – CreatePrivateEndpointRuleRequestGroupId 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.

Returns:

NccAzurePrivateEndpointRule

delete_network_connectivity_configuration(network_connectivity_config_id: str)

Delete a network connectivity configuration.

Deletes a network connectivity configuration.

Parameters:

network_connectivity_config_id – str Your Network Connectvity Configuration ID.

delete_private_endpoint_rule(network_connectivity_config_id: str, private_endpoint_rule_id: str) → NccAzurePrivateEndpointRule

Delete a private endpoint rule.

Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED, the private endpoint is immediately deleted. Otherwise, the private endpoint is deactivated and will be deleted after seven days of deactivation. When a private endpoint is deactivated, the deactivated field is set to true and the private endpoint is not available to your serverless compute resources.

Parameters:

  • network_connectivity_config_id – str Your Network Connectvity Configuration ID.

  • private_endpoint_rule_id – str Your private endpoint rule ID.

Returns:

NccAzurePrivateEndpointRule

get_network_connectivity_configuration(network_connectivity_config_id: str) → NetworkConnectivityConfiguration

Get a network connectivity configuration.

Gets a network connectivity configuration.

Parameters:

network_connectivity_config_id – str Your Network Connectvity Configuration ID.

Returns:

NetworkConnectivityConfiguration

get_private_endpoint_rule(network_connectivity_config_id: str, private_endpoint_rule_id: str) → NccAzurePrivateEndpointRule

Get a private endpoint rule.

Gets the private endpoint rule.

Parameters:

  • network_connectivity_config_id – str Your Network Connectvity Configuration ID.

  • private_endpoint_rule_id – str Your private endpoint rule ID.

Returns:

NccAzurePrivateEndpointRule

list_network_connectivity_configurations([, page_token: Optional[str]]) → Iterator[NetworkConnectivityConfiguration]

List network connectivity configurations.

Gets an array of network connectivity configurations.

Parameters:

page_token – str (optional) Pagination token to go to next page based on previous query.

Returns:

Iterator over NetworkConnectivityConfiguration

list_private_endpoint_rules(network_connectivity_config_id: str [, page_token: Optional[str]]) → Iterator[NccAzurePrivateEndpointRule]

List private endpoint rules.

Gets an array of private endpoint rules.

Parameters:

  • network_connectivity_config_id – str Your Network Connectvity Configuration ID.

  • page_token – str (optional) Pagination token to go to next page based on previous query.

Returns:

Iterator over NccAzurePrivateEndpointRule