com.databricks.sdk.service.settings

Interface NetworkConnectivityService

@Generated
public interface NetworkConnectivityService

These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources. This API provides stable subnets for your workspace so that you can configure your firewalls on your Azure Storage accounts to allow access from Databricks. You can also use the API to provision private endpoints for Databricks to privately connect serverless compute resources to your Azure resources using Azure Private Link. See [configure serverless secure connectivity].

[configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
NetworkConnectivityConfiguration	createNetworkConnectivityConfiguration(CreateNetworkConnectivityConfigRequest createNetworkConnectivityConfigRequest) Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when accessing your Azure Storage accounts.
NccPrivateEndpointRule	createPrivateEndpointRule(CreatePrivateEndpointRuleRequest createPrivateEndpointRuleRequest) Create a private endpoint rule for the specified network connectivity config object.
void	deleteNetworkConnectivityConfiguration(DeleteNetworkConnectivityConfigurationRequest deleteNetworkConnectivityConfigurationRequest) Deletes a network connectivity configuration.
NccPrivateEndpointRule	deletePrivateEndpointRule(DeletePrivateEndpointRuleRequest deletePrivateEndpointRuleRequest) Initiates deleting a private endpoint rule.
NetworkConnectivityConfiguration	getNetworkConnectivityConfiguration(GetNetworkConnectivityConfigurationRequest getNetworkConnectivityConfigurationRequest) Gets a network connectivity configuration.
NccPrivateEndpointRule	getPrivateEndpointRule(GetPrivateEndpointRuleRequest getPrivateEndpointRuleRequest) Gets the private endpoint rule.
ListNetworkConnectivityConfigurationsResponse	listNetworkConnectivityConfigurations(ListNetworkConnectivityConfigurationsRequest listNetworkConnectivityConfigurationsRequest) Gets an array of network connectivity configurations.
ListPrivateEndpointRulesResponse	listPrivateEndpointRules(ListPrivateEndpointRulesRequest listPrivateEndpointRulesRequest) Gets an array of private endpoint rules.
NccPrivateEndpointRule	updatePrivateEndpointRule(UpdateNccPrivateEndpointRuleRequest updateNccPrivateEndpointRuleRequest) Updates a private endpoint rule.

Method Detail

createNetworkConnectivityConfiguration

NetworkConnectivityConfiguration createNetworkConnectivityConfiguration(CreateNetworkConnectivityConfigRequest createNetworkConnectivityConfigRequest)

Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when accessing your Azure Storage accounts. You can also use a network connectivity configuration to create Databricks managed private endpoints so that Databricks serverless compute resources privately access your resources.

**IMPORTANT**: After you create the network connectivity configuration, you must assign one or more workspaces to the new network connectivity configuration. You can share one network connectivity configuration with multiple workspaces from the same Azure region within the same Databricks account. See [configure serverless secure connectivity].

[configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security

createPrivateEndpointRule

NccPrivateEndpointRule createPrivateEndpointRule(CreatePrivateEndpointRuleRequest createPrivateEndpointRuleRequest)

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

deleteNetworkConnectivityConfiguration

void deleteNetworkConnectivityConfiguration(DeleteNetworkConnectivityConfigurationRequest deleteNetworkConnectivityConfigurationRequest)

Deletes a network connectivity configuration.

deletePrivateEndpointRule

NccPrivateEndpointRule deletePrivateEndpointRule(DeletePrivateEndpointRuleRequest deletePrivateEndpointRuleRequest)

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.

getNetworkConnectivityConfiguration

NetworkConnectivityConfiguration getNetworkConnectivityConfiguration(GetNetworkConnectivityConfigurationRequest getNetworkConnectivityConfigurationRequest)

Gets a network connectivity configuration.

getPrivateEndpointRule

NccPrivateEndpointRule getPrivateEndpointRule(GetPrivateEndpointRuleRequest getPrivateEndpointRuleRequest)

Gets the private endpoint rule.

listNetworkConnectivityConfigurations

ListNetworkConnectivityConfigurationsResponse listNetworkConnectivityConfigurations(ListNetworkConnectivityConfigurationsRequest listNetworkConnectivityConfigurationsRequest)

Gets an array of network connectivity configurations.

listPrivateEndpointRules

ListPrivateEndpointRulesResponse listPrivateEndpointRules(ListPrivateEndpointRulesRequest listPrivateEndpointRulesRequest)

Gets an array of private endpoint rules.

updatePrivateEndpointRule

NccPrivateEndpointRule updatePrivateEndpointRule(UpdateNccPrivateEndpointRuleRequest updateNccPrivateEndpointRuleRequest)

Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources is allowed to be updated.