private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.machine_learning_services.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ResourceId of the private endpoint connection.
name	string	Friendly name of the private endpoint connection.
privateEndpoint	object	The resource of private end point.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
type	string	Resource type of private endpoint connection.

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.
delete	delete	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Deletes the specified private endpoint connection associated with the workspace.
put	exec	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Update the state of specified private endpoint connection associated with the workspace.

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 workspace. Required.
resource_group_name	string	Name of the resource group in which workspace is located. Required.
subscription_id	string
workspace_name	string	Name of Azure Machine Learning workspace. Required.

SELECT examples

get

Gets the specified private endpoint connection associated with the workspace.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure.machine_learning_services.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
;

DELETE examples

delete

Deletes the specified private endpoint connection associated with the workspace.

DELETE FROM azure.machine_learning_services.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
;

Lifecycle Methods

put

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

EXEC azure.machine_learning_services.private_endpoint_connections.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;