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
- vw_private_endpoint_connections
- private_endpoint_connections
Name | Datatype | Description |
---|---|---|
id | text | The resource identifier. |
name | text | The resource name. |
privateEndpointConnectionName | text | field from the properties object |
private_endpoint | text | field from the properties object |
private_link_service_connection_state | text | field from the properties object |
resourceGroupName | text | field from the properties object |
resourceName | text | field from the properties object |
subscriptionId | text | field from the properties object |
type | text | The resource type. |
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
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | privateEndpointConnectionName, resourceGroupName, resourceName, subscriptionId | Get private endpoint connection properties |
list | SELECT | resourceGroupName, resourceName, subscriptionId | List private endpoint connection properties |
delete | DELETE | privateEndpointConnectionName, resourceGroupName, resourceName, subscriptionId | Delete private endpoint connection with the specified name |
update | REPLACE | privateEndpointConnectionName, resourceGroupName, resourceName, subscriptionId, data__properties | Update the status of a private endpoint connection with the specified name |
SELECT
examples
List private endpoint connection properties
- vw_private_endpoint_connections
- private_endpoint_connections
SELECT
id,
name,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
resourceGroupName,
resourceName,
subscriptionId,
type
FROM azure.iot_hub.vw_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
id,
name,
properties,
type
FROM azure.iot_hub.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';
REPLACE
example
Replaces all fields in the specified private_endpoint_connections
resource.
/*+ update */
REPLACE azure.iot_hub.private_endpoint_connections
SET
properties = '{{ properties }}'
WHERE
privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND data__properties = '{{ data__properties }}';
DELETE
example
Deletes the specified private_endpoint_connections
resource.
/*+ delete */
DELETE FROM azure.iot_hub.private_endpoint_connections
WHERE privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';