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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupIds	array	GroupIds from the private link service resource.
privateEndpoint	object	Private endpoint.
privateLinkServiceConnectionState	object	Private endpoint connection state. Required.
provisioningState	string	Provisioning state of the private endpoint connection. Known values are: "Succeeded", "Creating", "Updating", "Deleting", and "Failed". (Succeeded, Creating, Updating, Deleting, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupIds	array	GroupIds from the private link service resource.
privateEndpoint	object	Private endpoint.
privateLinkServiceConnectionState	object	Private endpoint connection state. Required.
provisioningState	string	Provisioning state of the private endpoint connection. Known values are: "Succeeded", "Creating", "Updating", "Deleting", and "Failed". (Succeeded, Creating, Updating, Deleting, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Get private endpoint connection. Get a private endpoint connection properties for a workspace.
list	select	resource_group_name, workspace_name, subscription_id		List private endpoint connections. List private endpoint connections of the workspace.
create	insert	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id, properties		Update private endpoint connection status. Update the status of a private endpoint connection with the specified name.
delete	delete	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Remove private endpoint connection. 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
private_endpoint_connection_name	string	The name of the private endpoint connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get private endpoint connection. Get a private endpoint connection properties for a workspace.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure_isv.databricks.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List private endpoint connections. List private endpoint connections of the workspace.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure_isv.databricks.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure_isv.databricks.private_endpoint_connections (
properties,
resource_group_name,
workspace_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: private_endpoint_connection_name
    value: "{{ private_endpoint_connection_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: properties
    description: |
      The private endpoint connection properties. Required.
    value:
      privateEndpoint:
        id: "{{ id }}"
      groupIds:
        - "{{ groupIds }}"
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"
      provisioningState: "{{ provisioningState }}"

DELETE examples

delete

Remove private endpoint connection. Remove private endpoint connection with the specified name.

DELETE FROM azure_isv.databricks.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;