com.databricks.sdk.service.settings

Class NetworkConnectivityAPI

java.lang.Object

com.databricks.sdk.service.settings.NetworkConnectivityAPI

@Generated
public class NetworkConnectivityAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
NetworkConnectivityAPI(ApiClient apiClient) Regular-use constructor
NetworkConnectivityAPI(NetworkConnectivityService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
NetworkConnectivityConfiguration	createNetworkConnectivityConfiguration(CreateNetworkConnectivityConfigRequest request) Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when accessing your Azure Storage accounts.
NccPrivateEndpointRule	createPrivateEndpointRule(CreatePrivateEndpointRuleRequest request) Create a private endpoint rule for the specified network connectivity config object.
void	deleteNetworkConnectivityConfiguration(DeleteNetworkConnectivityConfigurationRequest request) Deletes a network connectivity configuration.
void	deleteNetworkConnectivityConfiguration(String networkConnectivityConfigId)
NccPrivateEndpointRule	deletePrivateEndpointRule(DeletePrivateEndpointRuleRequest request) Initiates deleting a private endpoint rule.
NccPrivateEndpointRule	deletePrivateEndpointRule(String networkConnectivityConfigId, String privateEndpointRuleId)
NetworkConnectivityConfiguration	getNetworkConnectivityConfiguration(GetNetworkConnectivityConfigurationRequest request) Gets a network connectivity configuration.
NetworkConnectivityConfiguration	getNetworkConnectivityConfiguration(String networkConnectivityConfigId)
NccPrivateEndpointRule	getPrivateEndpointRule(GetPrivateEndpointRuleRequest request) Gets the private endpoint rule.
NccPrivateEndpointRule	getPrivateEndpointRule(String networkConnectivityConfigId, String privateEndpointRuleId)
NetworkConnectivityService	impl()
Iterable<NetworkConnectivityConfiguration>	listNetworkConnectivityConfigurations(ListNetworkConnectivityConfigurationsRequest request) Gets an array of network connectivity configurations.
Iterable<NccPrivateEndpointRule>	listPrivateEndpointRules(ListPrivateEndpointRulesRequest request) Gets an array of private endpoint rules.
Iterable<NccPrivateEndpointRule>	listPrivateEndpointRules(String networkConnectivityConfigId)
NccPrivateEndpointRule	updatePrivateEndpointRule(UpdateNccPrivateEndpointRuleRequest request) Updates a private endpoint rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkConnectivityAPI

public NetworkConnectivityAPI(ApiClient apiClient)

Regular-use constructor

NetworkConnectivityAPI

public NetworkConnectivityAPI(NetworkConnectivityService mock)

Constructor for mocks

Method Detail

createNetworkConnectivityConfiguration

public NetworkConnectivityConfiguration createNetworkConnectivityConfiguration(CreateNetworkConnectivityConfigRequest request)

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

public NccPrivateEndpointRule createPrivateEndpointRule(CreatePrivateEndpointRuleRequest request)

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

public void deleteNetworkConnectivityConfiguration(String networkConnectivityConfigId)

deleteNetworkConnectivityConfiguration

public void deleteNetworkConnectivityConfiguration(DeleteNetworkConnectivityConfigurationRequest request)

Deletes a network connectivity configuration.

deletePrivateEndpointRule

public NccPrivateEndpointRule deletePrivateEndpointRule(String networkConnectivityConfigId,
                                                        String privateEndpointRuleId)

deletePrivateEndpointRule

public NccPrivateEndpointRule deletePrivateEndpointRule(DeletePrivateEndpointRuleRequest request)

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

public NetworkConnectivityConfiguration getNetworkConnectivityConfiguration(String networkConnectivityConfigId)

getNetworkConnectivityConfiguration

public NetworkConnectivityConfiguration getNetworkConnectivityConfiguration(GetNetworkConnectivityConfigurationRequest request)

Gets a network connectivity configuration.

getPrivateEndpointRule

public NccPrivateEndpointRule getPrivateEndpointRule(String networkConnectivityConfigId,
                                                     String privateEndpointRuleId)

getPrivateEndpointRule

public NccPrivateEndpointRule getPrivateEndpointRule(GetPrivateEndpointRuleRequest request)

Gets the private endpoint rule.

listNetworkConnectivityConfigurations

public Iterable<NetworkConnectivityConfiguration> listNetworkConnectivityConfigurations(ListNetworkConnectivityConfigurationsRequest request)

Gets an array of network connectivity configurations.

listPrivateEndpointRules

public Iterable<NccPrivateEndpointRule> listPrivateEndpointRules(String networkConnectivityConfigId)

listPrivateEndpointRules

public Iterable<NccPrivateEndpointRule> listPrivateEndpointRules(ListPrivateEndpointRulesRequest request)

Gets an array of private endpoint rules.

updatePrivateEndpointRule

public NccPrivateEndpointRule updatePrivateEndpointRule(UpdateNccPrivateEndpointRuleRequest request)

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

impl

public NetworkConnectivityService impl()