digital_twins_endpoint

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

Overview

Name	digital_twins_endpoint
Type	Resource
Id	azure.digital_twins.digital_twins_endpoint

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name.
authenticationType	string	Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. Known values are: "KeyBased" and "IdentityBased".
createdTime	string (date-time)	Time when the Endpoint was added to DigitalTwinsInstance.
deadLetterSecret	string	Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri	string	Dead letter storage URL for identity-based authentication.
endpointType	string	The type of Digital Twins endpoint. Required. Known values are: "EventHub", "EventGrid", and "ServiceBus".
identity	object	Managed identity properties for the endpoint.
provisioningState	string	The provisioning state. Known values are: "Provisioning", "Deleting", "Updating", "Succeeded", "Failed", "Canceled", "Deleted", "Warning", "Suspending", "Restoring", "Moving", and "Disabled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

list

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name.
authenticationType	string	Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. Known values are: "KeyBased" and "IdentityBased".
createdTime	string (date-time)	Time when the Endpoint was added to DigitalTwinsInstance.
deadLetterSecret	string	Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri	string	Dead letter storage URL for identity-based authentication.
endpointType	string	The type of Digital Twins endpoint. Required. Known values are: "EventHub", "EventGrid", and "ServiceBus".
identity	object	Managed identity properties for the endpoint.
provisioningState	string	The provisioning state. Known values are: "Provisioning", "Deleting", "Updating", "Succeeded", "Failed", "Canceled", "Deleted", "Warning", "Suspending", "Restoring", "Moving", and "Disabled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, endpoint_name, subscription_id		Get DigitalTwinsInstances Endpoint.
list	select	resource_group_name, resource_name, subscription_id		Get DigitalTwinsInstance Endpoints.
create_or_update	insert	resource_group_name, resource_name, endpoint_name, subscription_id, properties		Create or update DigitalTwinsInstance endpoint.
create_or_update	replace	resource_group_name, resource_name, endpoint_name, subscription_id, properties		Create or update DigitalTwinsInstance endpoint.
delete	delete	resource_group_name, resource_name, endpoint_name, subscription_id		Delete a DigitalTwinsInstance endpoint.

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
endpoint_name	string	Name of Endpoint Resource. Required.
resource_group_name	string	The name of the resource group that contains the DigitalTwinsInstance. Required.
resource_name	string	The name of the DigitalTwinsInstance. Required.
subscription_id	string

SELECT examples

get

Get DigitalTwinsInstances Endpoint.

SELECT
id,
name,
authenticationType,
createdTime,
deadLetterSecret,
deadLetterUri,
endpointType,
identity,
provisioningState,
systemData,
type
FROM azure.digital_twins.digital_twins_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get DigitalTwinsInstance Endpoints.

SELECT
id,
name,
authenticationType,
createdTime,
deadLetterSecret,
deadLetterUri,
endpointType,
identity,
provisioningState,
systemData,
type
FROM azure.digital_twins.digital_twins_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update DigitalTwinsInstance endpoint.

INSERT INTO azure.digital_twins.digital_twins_endpoint (
properties,
resource_group_name,
resource_name,
endpoint_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: digital_twins_endpoint
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the digital_twins_endpoint resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the digital_twins_endpoint resource.
  - name: endpoint_name
    value: "{{ endpoint_name }}"
    description: Required parameter for the digital_twins_endpoint resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the digital_twins_endpoint resource.
  - name: properties
    description: |
      DigitalTwinsInstance endpoint resource properties. Required.
    value:
      endpointType: "{{ endpointType }}"
      provisioningState: "{{ provisioningState }}"
      createdTime: "{{ createdTime }}"
      authenticationType: "{{ authenticationType }}"
      deadLetterSecret: "{{ deadLetterSecret }}"
      deadLetterUri: "{{ deadLetterUri }}"
      identity:
        type: "{{ type }}"
        userAssignedIdentity: "{{ userAssignedIdentity }}"

REPLACE examples

create_or_update

Create or update DigitalTwinsInstance endpoint.

REPLACE azure.digital_twins.digital_twins_endpoint
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a DigitalTwinsInstance endpoint.

DELETE FROM azure.digital_twins.digital_twins_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;