private_links

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

Overview

Name	private_links
Type	Resource
Id	azure.iot_central.private_links

Fields

The following fields are returned by SELECT queries:

get

The private link resource for the IoT Central Application.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Resource properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the private links of the IoT Central Application.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Resource properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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 a private link resource of a IoT Central Application.
list	select	subscriptionId, resourceGroupName, resourceName	api-version	Get all private link resources of a IoT Central Application.

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 private link resource name.
resourceGroupName	string	The name of the resource group that contains the IoT Central application.
resourceName	string	The ARM resource name of the IoT Central application.
subscriptionId	string	The subscription identifier.
api-version	string	The version of the API.

SELECT examples

get

Get a private link resource of a IoT Central Application.

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

list

Get all private link resources of a IoT Central Application.

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