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.healthcare.workspace_private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_workspace

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the workspace.
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		Lists all private endpoint connections for a workspace.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, privateEndpointConnectionName		Update the state of the specified private endpoint connection associated with the workspace.
delete	delete	subscriptionId, resourceGroupName, workspaceName, privateEndpointConnectionName		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
privateEndpointConnectionName	string	The name of the private endpoint connection associated with the Azure resource
resourceGroupName	string	The name of the resource group that contains the service instance.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of workspace resource.

SELECT examples

get

Gets the specified private endpoint connection associated with the workspace.

SELECT
properties,
systemData
FROM azure_extras.healthcare.workspace_private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_workspace

Lists all private endpoint connections for a workspace.

SELECT
properties,
systemData
FROM azure_extras.healthcare.workspace_private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.healthcare.workspace_private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: workspace_private_endpoint_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_private_endpoint_connections resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspace_private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the workspace_private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a private endpoint connection.

DELETE FROM azure_extras.healthcare.workspace_private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;