private_link_resources

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

Overview

Name	private_link_resources
Type	Resource
Id	azure.iot_hub.private_link_resources

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
groupId	string	The group id.
requiredMembers	array	The required members for a specific group id.
requiredZoneNames	array	The required DNS zones for a specific group id.
type	string	The resource type.

list

Name	Datatype	Description
value	array	The list of available private link resources for an IotHub.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, group_id, subscription_id		Get the specified private link resource. Get the specified private link resource for the given IotHub.
list	select	resource_group_name, resource_name, subscription_id		List private link resources. List private link resources for the given IotHub.

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

SELECT examples

get

Get the specified private link resource. Get the specified private link resource for the given IotHub.

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

list

List private link resources. List private link resources for the given IotHub.

SELECT
value
FROM azure.iot_hub.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;