private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.iot_hub.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

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.
privateEndpoint	object	The private endpoint property of a private endpoint connection.
privateLinkServiceConnectionState	object	The current state of a private endpoint connection. Required.
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

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.
privateEndpoint	object	The private endpoint property of a private endpoint connection.
privateLinkServiceConnectionState	object	The current state of a private endpoint connection. Required.
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	resource_group_name, resource_name, private_endpoint_connection_name, subscription_id		Get private endpoint connection. Get private endpoint connection properties.
list	select	resource_group_name, resource_name, subscription_id		List private endpoint connections. List private endpoint connection properties.
update	update	resource_group_name, resource_name, private_endpoint_connection_name, subscription_id, properties		Update private endpoint connection. Update the status of a private endpoint connection with the specified name.
delete	delete	resource_group_name, resource_name, private_endpoint_connection_name, subscription_id		Delete private endpoint connection. Delete private endpoint connection with the specified name.

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
private_endpoint_connection_name	string	The name of the private endpoint connection. 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 private endpoint connection. Get private endpoint connection properties.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
systemData,
type
FROM azure.iot_hub.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List private endpoint connections. List private endpoint connection properties.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
systemData,
type
FROM azure.iot_hub.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Update private endpoint connection. Update the status of a private endpoint connection with the specified name.

UPDATE azure.iot_hub.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete private endpoint connection. Delete private endpoint connection with the specified name.

DELETE FROM azure.iot_hub.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;