private_link_resources

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

Overview

Name	private_link_resources
Type	Resource
Id	azure.synapse.private_link_resources

Fields

The following fields are returned by SELECT queries:

get

Private link resource details

Name	Datatype	Description
properties	object	The private link resource properties.

list

List of private link resources

Name	Datatype	Description
properties	object	The private link resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, privateLinkResourceName		Get private link resource in workspace
list	select	subscriptionId, resourceGroupName, workspaceName		Get all private link resources for a workspaces

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
privateLinkResourceName	string	The name of the private link resource
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get private link resource in workspace

SELECT
properties
FROM azure.synapse.private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND privateLinkResourceName = '{{ privateLinkResourceName }}' -- required
;

list

Get all private link resources for a workspaces

SELECT
properties
FROM azure.synapse.private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;