---
title: "GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints"
method: GET
path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints"
tags: ["Endpoints"]
---

# GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints

`GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints`

## Request

- Base URL: `https://management.azure.com`
- URL: `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints`
- Auth: OAuth 2
  - Implicit: `https://login.microsoftonline.com/common/oauth2/authorize`
  - Scopes: `user_impersonation`

Get DigitalTwinsInstance Endpoints.

## Path parameters

- `subscriptionId` string, required
- `resourceGroupName` string, required
- `resourceName` string, required

## Query parameters

- `api-version` string, required

## Response `200`

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

- DigitalTwinsEndpointResourceListResult: A list of DigitalTwinsInstance Endpoints with a next link.
  - `nextLink` string, nullable: The link used to get the next page of DigitalTwinsInstance Endpoints.
  - `value` DigitalTwinsEndpointResource[]: A list of DigitalTwinsInstance Endpoints.
    - `id` string: The resource identifier.
    - `name` string: Extension resource name.
    - `type` string: The resource type.
    - `systemData` SystemData: Metadata pertaining to creation and last modification of the resource.
      - `createdBy` string, nullable: The identity that created the resource.
      - `createdByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key', nullable: The type of identity that created the resource.
      - `createdAt` string, date-time, nullable: The timestamp of resource creation (UTC).
      - `lastModifiedBy` string, nullable: The identity that last modified the resource.
      - `lastModifiedByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key', nullable: The type of identity that last modified the resource.
      - `lastModifiedAt` string, date-time, nullable: The timestamp of resource last modification (UTC)
    - `properties` DigitalTwinsEndpointResourceProperties, required: Properties related to Digital Twins Endpoint
      - `endpointType` 'EventHub' | 'EventGrid' | 'ServiceBus', required: The type of Digital Twins endpoint
      - `provisioningState` 'Provisioning' | 'Deleting' | 'Updating' | 'Succeeded' | 'Failed' | 'Canceled' | 'Deleted' | 'Warning' | 'Suspending' | 'Restoring' | 'Moving' | 'Disabled', nullable: The provisioning state.
      - `createdTime` string, date-time, nullable: Time when the Endpoint was added to DigitalTwinsInstance.
      - `authenticationType` 'KeyBased' | 'IdentityBased': 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.
      - `deadLetterSecret` string, nullable: Dead letter storage secret for key-based authentication. Will be obfuscated during read.
      - `deadLetterUri` string, nullable: Dead letter storage URL for identity-based authentication.
      - `identity` ManagedIdentityReference: The properties of the Managed Identity.
        - `type` 'SystemAssigned' | 'UserAssigned': The type of managed identity used.
        - `userAssignedIdentity` string, nullable: The user identity ARM resource id if the managed identity type is 'UserAssigned'.

## Other responses

- `default`: Error response describing why the operation failed.

---

[API](https://skmtc.dev/azure/apis/digitaltwins-microsoft-digitaltwins-digitaltwins.md) - [All operations](https://skmtc.dev/azure/apis/digitaltwins-microsoft-digitaltwins-digitaltwins/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/digitaltwins-microsoft-digitaltwins-digitaltwins/revisions/0244c7a17143?raw)
