private_link_association

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

Overview

Name	private_link_association
Type	Resource
Id	azure.resource.private_link_association

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The plaResourceID.
name	string	The pla name.
privateLink	string	The rmpl Resource ID.
publicNetworkAccess	string	Known values are: "Enabled" and "Disabled".
scope	string	The scope of the private link association.
tenantID	string	The TenantID.
type	string	The operation type.

list

Name	Datatype	Description
value	array	private link association information.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	group_id, pla_id		Get a single private link association.
list	select	group_id		Get a private link association for a management group scope.
delete	delete	group_id, pla_id		Delete a PrivateLinkAssociation.
put	exec	group_id, pla_id		Create a PrivateLinkAssociation.

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
group_id	string	The management group ID. Required.
pla_id	string	The ID of the PLA. Required.

SELECT examples

get

Get a single private link association.

SELECT
id,
name,
privateLink,
publicNetworkAccess,
scope,
tenantID,
type
FROM azure.resource.private_link_association
WHERE group_id = '{{ group_id }}' -- required
AND pla_id = '{{ pla_id }}' -- required
;

list

Get a private link association for a management group scope.

SELECT
value
FROM azure.resource.private_link_association
WHERE group_id = '{{ group_id }}' -- required
;

DELETE examples

delete

Delete a PrivateLinkAssociation.

DELETE FROM azure.resource.private_link_association
WHERE group_id = '{{ group_id }}' --required
AND pla_id = '{{ pla_id }}' --required
;

Lifecycle Methods

put

Create a PrivateLinkAssociation.

EXEC azure.resource.private_link_association.put 
@group_id='{{ group_id }}' --required, 
@pla_id='{{ pla_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;