endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.digital_twins.endpoints

Fields

vw_endpoints

Name	Datatype	Description
id	text	The resource identifier.
name	text	Extension resource name.
authentication_type	text	field from the properties object
created_time	text	field from the properties object
dead_letter_secret	text	field from the properties object
dead_letter_uri	text	field from the properties object
endpointName	text	field from the properties object
endpoint_type	text	field from the properties object
identity	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 resource type.

endpoints

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name.
properties	object	Properties related to Digital Twins Endpoint
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	endpointName, resourceGroupName, resourceName, subscriptionId	Get DigitalTwinsInstances Endpoint.
list	SELECT	resourceGroupName, resourceName, subscriptionId	Get DigitalTwinsInstance Endpoints.
create_or_update	INSERT	endpointName, resourceGroupName, resourceName, subscriptionId, data__properties	Create or update DigitalTwinsInstance endpoint.
delete	DELETE	endpointName, resourceGroupName, resourceName, subscriptionId	Delete a DigitalTwinsInstance endpoint.

SELECT examples

Get DigitalTwinsInstance Endpoints.

vw_endpoints

SELECT
id,
name,
authentication_type,
created_time,
dead_letter_secret,
dead_letter_uri,
endpointName,
endpoint_type,
identity,
provisioning_state,
resourceGroupName,
resourceName,
subscriptionId,
system_data,
type
FROM azure.digital_twins.vw_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

endpoints

SELECT
id,
name,
properties,
systemData,
type
FROM azure.digital_twins.endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.digital_twins.endpoints (
endpointName,
resourceGroupName,
resourceName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ endpointName }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - 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
    - name: properties
      value:
        - name: endpointType
          value: string
        - name: provisioningState
          value: string
        - name: createdTime
          value: string
        - name: authenticationType
          value: string
        - name: deadLetterSecret
          value: string
        - name: deadLetterUri
          value: string
        - name: identity
          value:
            - name: type
              value: string
            - name: userAssignedIdentity
              value: string

DELETE example

Deletes the specified endpoints resource.

/*+ delete */
DELETE FROM azure.digital_twins.endpoints
WHERE endpointName = '{{ endpointName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';