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
- vw_private_endpoint_connections
- private_endpoint_connections
Name | Datatype | Description |
---|---|---|
id | text | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name | text | The name of the resource |
group_ids | text | field from the properties object |
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 |
provisioning_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 |
system_data | text | field from the properties object |
type | text | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
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 | Properties of the private endpoint connection. |
systemData | object | Metadata pertaining to creation and last modification of the resource. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | privateEndpointConnectionName, resourceGroupName, resourceName, subscriptionId | Get the metadata of a private endpoint connection for the IoT Central Application. |
list | SELECT | resourceGroupName, resourceName, subscriptionId | Get all private endpoint connections of a IoT Central Application. |
create | INSERT | privateEndpointConnectionName, resourceGroupName, resourceName, subscriptionId | Update a private endpoint connection. |
delete | DELETE | privateEndpointConnectionName, resourceGroupName, resourceName, subscriptionId | Deletes a private endpoint connection from the IoT Central Application. |
SELECT
examples
Get all private endpoint connections of a IoT Central Application.
- vw_private_endpoint_connections
- private_endpoint_connections
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 }}';
SELECT
id,
name,
properties,
systemData,
type
FROM azure.iot_central.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.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.iot_central.private_endpoint_connections (
privateEndpointConnectionName,
resourceGroupName,
resourceName,
subscriptionId,
properties
)
SELECT
'{{ privateEndpointConnectionName }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: groupIds
value:
- string
- name: privateEndpoint
value:
- name: id
value: string
- name: privateLinkServiceConnectionState
value:
- name: status
value: []
- name: description
value: string
- name: actionsRequired
value: string
- name: provisioningState
value: []
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: systemData
value:
- name: createdBy
value: string
- name: createdByType
value: string
- name: createdAt
value: string
- name: lastModifiedBy
value: string
- name: lastModifiedByType
value: string
- name: lastModifiedAt
value: string
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 }}';