private_endpoint_connections

Creates, updates, deletes, gets or lists a private_endpoint_connections resource.

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure_isv.databricks.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

OK - Returns the private endpoint connection properties of a workspace

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The private endpoint connection properties.
type	string	The resource type.

list

OK - Returns list of private endpoint connections for a workspace

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The private endpoint connection properties.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, workspaceName, subscriptionId, privateEndpointConnectionName		Get a private endpoint connection properties for a workspace
list	select	resourceGroupName, workspaceName, subscriptionId		List private endpoint connections of the workspace
create	insert	resourceGroupName, workspaceName, subscriptionId, privateEndpointConnectionName, data__properties		Update the status of a private endpoint connection with the specified name
delete	delete	resourceGroupName, workspaceName, subscriptionId, privateEndpointConnectionName		Remove private endpoint connection with the specified name

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
privateEndpointConnectionName	string	The name of the private endpoint connection
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get a private endpoint connection properties for a workspace

SELECT
id,
name,
properties,
type
FROM azure_isv.databricks.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list

List private endpoint connections of the workspace

SELECT
id,
name,
properties,
type
FROM azure_isv.databricks.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Update the status of a private endpoint connection with the specified name

INSERT INTO azure_isv.databricks.private_endpoint_connections (
data__properties,
resourceGroupName,
workspaceName,
subscriptionId,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ subscriptionId }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: workspaceName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        The private endpoint connection properties.

DELETE examples

delete

Remove private endpoint connection with the specified name

DELETE FROM azure_isv.databricks.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;