private_link_resources

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

Overview

Name	private_link_resources
Type	Resource
Id	azure.purview.private_link_resources

Fields

The following fields are returned by SELECT queries:

get_by_group_id

Name	Datatype	Description
id	string	The private link resource identifier.
name	string	The private link resource name.
properties	object	The private link resource properties.
type	string	The private link resource type.

list_by_account

Name	Datatype	Description
id	string	The private link resource identifier.
name	string	The private link resource name.
properties	object	The private link resource properties.
type	string	The private link resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_group_id	select	subscriptionId, resourceGroupName, accountName, groupId	api-version	Gets a privately linkable resources for an account with given group identifier
list_by_account	select	subscriptionId, resourceGroupName, accountName	api-version	Gets a list of privately linkable resources for an account

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
accountName	string	The name of the account.
groupId	string	The group identifier.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier
api-version	string	The api version to use.

SELECT examples

get_by_group_id

Gets a privately linkable resources for an account with given group identifier

SELECT
id,
name,
properties,
type
FROM azure.purview.private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND groupId = '{{ groupId }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_account

Gets a list of privately linkable resources for an account

SELECT
id,
name,
properties,
type
FROM azure.purview.private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
;