private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.iot_central.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

The private endpoint connection 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 endpoint connections 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, privateEndpointConnectionName	api-version	Get the metadata of a private endpoint connection for the IoT Central Application.
list	select	subscriptionId, resourceGroupName, resourceName	api-version	Get all private endpoint connections of a IoT Central Application.
create	insert	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName	api-version	Update a private endpoint connection.
delete	delete	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName	api-version	Deletes a private endpoint connection from the 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
privateEndpointConnectionName	string	The private endpoint connection 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 the metadata of a private endpoint connection for the IoT Central Application.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.iot_central.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

Get all private endpoint connections of a IoT Central Application.

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

INSERT examples

create

Update a private endpoint connection.

INSERT INTO azure.iot_central.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
privateEndpointConnectionName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ privateEndpointConnectionName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: api-version
      value: string
      description: The version of the API.

DELETE examples

delete

Deletes a private endpoint connection from the IoT Central Application.

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