resource_management_private_link

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

Overview

Name	resource_management_private_link
Type	Resource
Id	azure.resource.resource_management_private_link

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The rmplResourceID.
name	string	The rmpl Name.
location	string	the region of the rmpl.
privateEndpointConnections	array	The private endpoint connections.
type	string	The operation type.

list_by_resource_group

Name	Datatype	Description
id	string	The rmplResourceID.
name	string	The rmpl Name.
location	string	the region of the rmpl.
privateEndpointConnections	array	The private endpoint connections.
type	string	The operation type.

list

Name	Datatype	Description
id	string	The rmplResourceID.
name	string	The rmpl Name.
location	string	the region of the rmpl.
privateEndpointConnections	array	The private endpoint connections.
type	string	The operation type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, rmpl_name, subscription_id		Get a resource management private link(resource-level).
list_by_resource_group	select	resource_group_name, subscription_id		Get all the resource management private links in a resource group.
list	select	subscription_id		Get all the resource management private links in a subscription.
delete	delete	resource_group_name, rmpl_name, subscription_id		Delete a resource management private link.
put	exec	resource_group_name, rmpl_name, subscription_id		Create a resource management group private link.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rmpl_name	string	The name of the resource management private link. Required.
subscription_id	string

SELECT examples

get

Get a resource management private link(resource-level).

SELECT
id,
name,
location,
privateEndpointConnections,
type
FROM azure.resource.resource_management_private_link
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND rmpl_name = '{{ rmpl_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all the resource management private links in a resource group.

SELECT
id,
name,
location,
privateEndpointConnections,
type
FROM azure.resource.resource_management_private_link
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all the resource management private links in a subscription.

SELECT
id,
name,
location,
privateEndpointConnections,
type
FROM azure.resource.resource_management_private_link
WHERE subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Delete a resource management private link.

DELETE FROM azure.resource.resource_management_private_link
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND rmpl_name = '{{ rmpl_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

put

Create a resource management group private link.

EXEC azure.resource.resource_management_private_link.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@rmpl_name='{{ rmpl_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}"
}'
;