Skip to main content

private_endpoint_connections

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

Overview

Nameprivate_endpoint_connections
TypeResource
Idazure.iot_central.private_endpoint_connections

Fields

NameDatatypeDescription
idtextFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
nametextThe name of the resource
group_idstextfield from the properties object
privateEndpointConnectionNametextfield from the properties object
private_endpointtextfield from the properties object
private_link_service_connection_statetextfield from the properties object
provisioning_statetextfield from the properties object
resourceGroupNametextfield from the properties object
resourceNametextfield from the properties object
subscriptionIdtextfield from the properties object
system_datatextfield from the properties object
typetextThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

NameAccessible byRequired ParamsDescription
getSELECTprivateEndpointConnectionName, resourceGroupName, resourceName, subscriptionIdGet the metadata of a private endpoint connection for the IoT Central Application.
listSELECTresourceGroupName, resourceName, subscriptionIdGet all private endpoint connections of a IoT Central Application.
createINSERTprivateEndpointConnectionName, resourceGroupName, resourceName, subscriptionIdUpdate a private endpoint connection.
deleteDELETEprivateEndpointConnectionName, resourceGroupName, resourceName, subscriptionIdDeletes a private endpoint connection from the IoT Central Application.

SELECT examples

Get all private endpoint connections of a IoT Central Application.

SELECT
id,
name,
group_ids,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
resourceName,
subscriptionId,
system_data,
type
FROM azure.iot_central.vw_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new private_endpoint_connections resource.

/*+ create */
INSERT INTO azure.iot_central.private_endpoint_connections (
privateEndpointConnectionName,
resourceGroupName,
resourceName,
subscriptionId,
properties
)
SELECT
'{{ privateEndpointConnectionName }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

DELETE example

Deletes the specified private_endpoint_connections resource.

/*+ delete */
DELETE FROM azure.iot_central.private_endpoint_connections
WHERE privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';