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

The body contains the private endpoint connection properties

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The properties of a private endpoint connection
type	string	The resource type.

list

The body contains the list of private endpoint connection properties

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The properties of a private endpoint connection
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, privateEndpointConnectionName	api-version	Get private endpoint connection properties
list	select	subscriptionId, resourceGroupName, resourceName	api-version	List private endpoint connection properties
update	replace	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName, data__properties	api-version	Update the status of a private endpoint connection with the specified name
delete	delete	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName	api-version	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
privateEndpointConnectionName	string	The name of the private endpoint connection
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 private endpoint connection properties

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

list

List private endpoint connection properties

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

REPLACE examples

update

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

REPLACE azure.iot_hub.private_endpoint_connections
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND data__properties = '{{ properties }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Delete private endpoint connection with the specified name

DELETE FROM azure.iot_hub.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND api-version = '{{ api-version }}'
;