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

The body contains the specified of private link resource

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The properties for a group information object
type	string	The resource type.

list

The body contains the list of private link resources

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The properties for a group information object
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, groupId	api-version	Get the specified private link resource for the given IotHub
list	select	subscriptionId, resourceGroupName, resourceName	api-version	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
groupId	string	The name of the private link resource
resourceGroupName	string	The name of the resource group that contains the IoT hub.
resourceName	string	The name of the IoT hub.
subscriptionId	string	The subscription identifier.
api-version	string	The version of the API.

SELECT examples

get

Get the specified private link resource for the given IotHub

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

list

List private link resources for the given IotHub

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