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.
groupId	string	The private link resource group identifier.
requiredMembers	array	This translates to how many Private IPs should be created for each privately linkable resource.
requiredZoneNames	array	The required zone names for private link resource.
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.
groupId	string	The private link resource group identifier.
requiredMembers	array	This translates to how many Private IPs should be created for each privately linkable resource.
requiredZoneNames	array	The required zone names for private link resource.
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	resource_group_name, account_name, group_id, subscription_id		Gets a privately linkable resources for an account with given group identifier. Gets a privately linkable resources for an account with given group identifier.
list_by_account	select	resource_group_name, account_name, subscription_id		Gets a list of privately linkable resources for an account. 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
account_name	string	The name of the account. Required.
group_id	string	The group identifier. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string

SELECT examples

get_by_group_id

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

SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
type
FROM azure.purview.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND group_id = '{{ group_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

Gets a list of privately linkable resources for an account. Gets a list of privately linkable resources for an account.

SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
type
FROM azure.purview.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;