workspace_private_endpoint_connections

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

Overview

Name	workspace_private_endpoint_connections
Type	Resource
Id	azure_extras.health_data_services.workspace_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.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider. Required.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed". (Succeeded, Creating, 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_by_workspace

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.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider. Required.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed". (Succeeded, Creating, 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		Gets the specified private endpoint connection associated with the workspace.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Lists all private endpoint connections for a workspace.
create_or_update	insert	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Update the state of the specified private endpoint connection associated with the workspace.
create_or_update	replace	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Update the state of the specified private endpoint connection associated with the workspace.
delete	delete	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Deletes a private endpoint connection.

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 associated with the Azure resource. 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 workspace resource. Required.

SELECT examples

get

Gets the specified private endpoint connection associated with the workspace.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure_extras.health_data_services.workspace_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_by_workspace

Lists all private endpoint connections for a workspace.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure_extras.health_data_services.workspace_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_or_update

Update the state of the specified private endpoint connection associated with the workspace.

INSERT INTO azure_extras.health_data_services.workspace_private_endpoint_connections (
properties,
resource_group_name,
workspace_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ 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: workspace_private_endpoint_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_private_endpoint_connections resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_private_endpoint_connections resource.
  - name: private_endpoint_connection_name
    value: "{{ private_endpoint_connection_name }}"
    description: Required parameter for the workspace_private_endpoint_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_private_endpoint_connections resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      privateEndpoint:
        id: "{{ id }}"
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Update the state of the specified private endpoint connection associated with the workspace.

REPLACE azure_extras.health_data_services.workspace_private_endpoint_connections
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a private endpoint connection.

DELETE FROM azure_extras.health_data_services.workspace_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
;