endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.digital_twins.endpoints

Fields

The following fields are returned by SELECT queries:

get

The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name. (pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$)
properties	object	DigitalTwinsInstance endpoint resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

list

The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name. (pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$)
properties	object	DigitalTwinsInstance endpoint resource properties.
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	subscriptionId, resourceGroupName, resourceName, endpointName	api-version	Get DigitalTwinsInstances Endpoint.
list	select	subscriptionId, resourceGroupName, resourceName	api-version	Get DigitalTwinsInstance Endpoints.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, endpointName, data__properties	api-version	Create or update DigitalTwinsInstance endpoint.
delete	delete	subscriptionId, resourceGroupName, resourceName, endpointName	api-version	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
endpointName	string	Name of Endpoint Resource.
resourceGroupName	string	The name of the resource group that contains the DigitalTwinsInstance.
resourceName	string	The name of the DigitalTwinsInstance.
subscriptionId	string	The subscription identifier.
api-version	string	Version of the DigitalTwinsInstance Management API.

SELECT examples

get

Get DigitalTwinsInstances Endpoint.

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

list

Get DigitalTwinsInstance Endpoints.

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

INSERT examples

create_or_update

Create or update DigitalTwinsInstance endpoint.

INSERT INTO azure.digital_twins.endpoints (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
endpointName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ endpointName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the endpoints resource.
    - name: resourceName
      value: string
      description: Required parameter for the endpoints resource.
    - name: endpointName
      value: string
      description: Required parameter for the endpoints resource.
    - name: properties
      value: object
      description: |
        DigitalTwinsInstance endpoint resource properties.
    - name: api-version
      value: string
      description: Version of the DigitalTwinsInstance Management API.

DELETE examples

delete

Delete a DigitalTwinsInstance endpoint.

DELETE FROM azure.digital_twins.endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND endpointName = '{{ endpointName }}' --required
AND api-version = '{{ api-version }}'
;