Skip to content

Commit 72ac9fa

Browse files
committed
Freshness updates
1 parent 4b72776 commit 72ac9fa

File tree

6 files changed

+34
-34
lines changed

6 files changed

+34
-34
lines changed
48.9 KB
Loading

articles/digital-twins/resources-customer-data-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ titleSuffix: Azure Digital Twins
44
description: Learn about identifying, exporting, and deleting personal data from Azure Digital Twins.
55
author: baanders
66
ms.author: baanders
7-
ms.date: 6/20/2023
7+
ms.date: 6/17/2025
88
ms.topic: concept-article
99
ms.service: azure-digital-twins
1010
services: digital-twins
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
---
22
title: Migrate from preview control plane APIs
33
titleSuffix: Azure Digital Twins
4-
description: Migrate from preview API versions of the control plane to the stable GA version
4+
description: Migrate from preview API versions of the control plane to a stable GA version
55
author: baanders
66
ms.author: baanders
7-
ms.date: 05/02/2023
7+
ms.date: 06/17/2025
88
ms.topic: concept-article
99
ms.service: azure-digital-twins
1010
services: digital-twins
1111
---
1212

13-
# Migrate from Azure Digital Twins preview control plane APIs to the stable GA version
13+
# Migrate from Azure Digital Twins preview control plane APIs to a stable GA version
1414

15-
As of May 2, 2023, the following Azure Digital Twins preview control plane APIs have been retired and are no longer maintained:
15+
As of May 2, 2023, the following Azure Digital Twins preview control plane APIs are retired and are no longer maintained:
1616
* [2020-03-01-preview](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview)
1717
* [2021-06-30-preview](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2021-06-30-preview)
1818

19-
This article explains how to migrate from these versions to the latest stable GA version of the APIs, [2022-10-31](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2022-10-31). The GA version provides more capabilities, including time-series database connections and managed identity.
19+
This article explains how to migrate from these preview versions to the latest stable GA version of the API, [2023-01-31](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2023-01-31). The GA version provides more capabilities, including time-series database connections and managed identity.
2020

2121
## Migrate from 2020-03-01-preview control plane API
2222

23-
This section contains a list of changes to be aware of when you're preparing to migrate from the [2020-03-01-preview](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview) API version to the [2022-10-31](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2022-10-31) (GA) API version. The changes include altered item names or naming requirements, endpoint requirements, and changes to the instance and API responses.
23+
This section contains a list of changes to be aware of when you're preparing to migrate from the [2020-03-01-preview](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview) API version to the [2023-01-31](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2023-01-31) (GA) API version. The changes include altered item names or naming requirements, endpoint requirements, and changes to the instance and API responses.
2424

25-
The changes from the 2020-03-01-preview API version to the 2022-10-31 (GA) API version are as follows:
25+
The changes from the 2020-03-01-preview API version to the 2023-01-31 (GA) API version are as follows:
2626
* For Event Hubs endpoints, the values *connectionString-PrimaryKey* and *connectionString-SecondaryKey* have changed to *connectionStringPrimaryKey* and *connectionStringSecondaryKey*, respectively (the dashes are removed).
2727
* The Patch API response has changed from synchronous to asynchronous.
28-
* Because patch updates now complete asynchronously, the Patch API of Azure Digital Twins resources now returns [202 Accepted](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2022-10-31/examples/DigitalTwinsPatch_example.json) instead of [200 OK](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/examples/DigitalTwinsPatch_example.json)). Users can track the status of the update with a PUT request.
28+
* Because patch updates now complete asynchronously, the Patch API of Azure Digital Twins resources now returns [202 Accepted](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2023-01-31/examples/DigitalTwinsPatch_example.json) instead of [200 OK](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/examples/DigitalTwinsPatch_example.json). Users can track the status of the update with a PUT request.
2929
* Endpoint names must be at least two characters long (previously one character in the preview API), and can have a max length of 49 characters (previously 64)
3030
* Digital twins resource names must be at least three characters long (previously one), and can have a maximum length of 63 characters (previously 64)
3131
* For Service Bus, Event Hubs, and Event Grid endpoints, secondary secrets (like connection strings and access keys) are no longer required. Now they're optional.
@@ -40,14 +40,14 @@ If you're using an associated SDK of the 2020-03-01-preview API, it's recommende
4040

4141
## Migrate from 2021-06-30-preview control plane API
4242

43-
The target replacement API version ([2022-10-31 (GA) API version](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2022-10-31)) is backwards-compatible with the [2021-06-30-preview API version](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2021-06-30-preview). In addition to the 2021-06-30-preview API version's capabilities, the 2022-10-31 (GA) API version additionally introduces user-assigned managed identities.
43+
The target replacement API version ([2023-01-31 (GA) API version](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2023-01-31)) is backwards-compatible with the [2021-06-30-preview API version](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2021-06-30-preview). In addition to the 2021-06-30-preview API version's capabilities, the 2023-01-31 (GA) API version additionally introduces user-assigned managed identities.
4444

45-
There are no breaking changes for migrating to the target replacement API version ([2022-10-31 (GA) API version](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2022-10-31)). There's one minor change: Endpoints and TSDB connections now have an explicit *Updating* state defined in the API contract.
45+
There are no breaking changes for migrating to the target replacement API version ([2023-01-31 (GA) API version](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2023-01-31)). There's one minor change: Endpoints and TSDB connections now have an explicit *Updating* state defined in the API contract.
4646

4747
If you're using an associated SDK of the 2021-06-30-preview API, it's recommended to update to the latest version of the management SDK. Use the following links to know what additional changes are required to migrate to the new management SDK.
4848
* .NET: Migrate from the [Microsoft.Azure.Management.DigitalTwins 1.2.0-beta.1](https://www.nuget.org/packages/Microsoft.Azure.Management.DigitalTwins/1.2.0-beta.1) package to the [Azure.ResourceManager.DigitalTwins 1.1.0](https://www.nuget.org/packages/Azure.ResourceManager.DigitalTwins/1.1.0) package, by following the [.NET SDK migration guidance](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/resourcemanager/Azure.ResourceManager/docs/MigrationGuide.md).
49-
* Java: Migrate from the [azure-resourcemanager-digitaltwins:1.0.0-beta.2](https://search.maven.org/artifact/com.azure.resourcemanager/azure-resourcemanager-digitaltwins/1.0.0-beta.2/jar) package to the [Azure.ResourceManager.DigitalTwins 1.1.0](https://search.maven.org/artifact/com.azure.resourcemanager/azure-resourcemanager-digitaltwins/1.1.0/jar) package, or set the service version in the SDK client to call the 2022-10-31 (GA) API.
49+
* Java: Migrate from the [azure-resourcemanager-digitaltwins:1.0.0-beta.2](https://search.maven.org/artifact/com.azure.resourcemanager/azure-resourcemanager-digitaltwins/1.0.0-beta.2/jar) package to the [Azure.ResourceManager.DigitalTwins 1.1.0](https://search.maven.org/artifact/com.azure.resourcemanager/azure-resourcemanager-digitaltwins/1.1.0/jar) package, or set the service version in the SDK client to call the 2023-01-31 (GA) API.
5050

5151
## Next steps
5252

53-
View the latest stable GA API, [2022-10-31](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2022-10-31), in GitHub.
53+
View the latest stable GA API, [2023-01-31](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2023-01-31), in GitHub.

articles/digital-twins/troubleshoot-error-azure-digital-twins-explorer-authentication.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,37 @@ ms.service: azure-digital-twins
66
author: baanders
77
ms.author: baanders
88
ms.topic: troubleshooting
9-
ms.date: 03/29/2022
9+
ms.date: 06/17/2025
1010
---
1111

1212
# Troubleshoot Azure Digital Twins Explorer: Authentication errors
1313

14-
This article describes causes and resolution steps for receiving authentication errors while running [Azure Digital Twins Explorer](/samples/azure-samples/digital-twins-explorer/digital-twins-explorer/).
14+
This article describes causes and resolution steps for receiving authentication errors while running [Azure Digital Twins Explorer](concepts-azure-digital-twins-explorer.md).
1515

1616
## Symptoms
1717

18-
When running Azure Digital Twins Explorer, you encounter the following error message:
18+
While running Azure Digital Twins Explorer, you encounter the following error message:
1919

2020
:::image type="content" source="media/troubleshoot-error-azure-digital-twins-explorer-authentication/permission-error.png" alt-text="Screenshot of an error message in the Azure Digital Twins Explorer, entitled Make sure you have the right permissions.":::
2121

2222
## Causes
2323

2424
### Cause #1
2525

26-
This error will occur if your Azure account doesn't have the required Azure role-based access control (Azure RBAC) permissions set on your Azure Digital Twins instance. In order to access data in your instance, you must have the *Azure Digital Twins Data Reader* or *Azure Digital Twins Data Owner* role on the instance you are trying to read or manage, respectively.
26+
This error will occur if your Azure account doesn't have the required Azure role-based access control (Azure RBAC) permissions set on your Azure Digital Twins instance. In order to access data in your instance, you must have the **Azure Digital Twins Data Reader** or **Azure Digital Twins Data Owner** role on the instance you are trying to read or manage, respectively.
2727

2828
For more information about security and roles in Azure Digital Twins, see [Security for Azure Digital Twins solutions](concepts-security.md).
2929

3030
## Solutions
3131

3232
### Solution #1
3333

34-
Verify that your Azure user has the *Azure Digital Twins Data Reader* role on the Azure Digital Twins instance if you're just trying to read its data, or the *Azure Digital Twins Data Owner* role on the instance if you're trying to manage its data.
34+
Verify that your Azure user has the **Azure Digital Twins Data Reader** role on the Azure Digital Twins instance if you're just trying to read its data, or the **Azure Digital Twins Data Owner** role on the instance if you're trying to manage its data.
3535

3636
Note that this role is different from...
37-
* the former name for this role during preview, *Azure Digital Twins Owner (Preview)* (the role is the same, but the name has changed)
38-
* the *Owner* role on the entire Azure subscription. *Azure Digital Twins Data Owner* is a role within Azure Digital Twins and is scoped to this individual Azure Digital Twins instance.
39-
* the *Owner* role in Azure Digital Twins. These are two distinct Azure Digital Twins management roles, and *Azure Digital Twins Data Owner* is the role that should be used for management.
37+
* the former name for this role during preview, **Azure Digital Twins Owner (Preview)** (the role is the same, but the name in GA is different)
38+
* the **Owner** role on the entire Azure subscription. **Azure Digital Twins Data Owner** is a role within Azure Digital Twins and is scoped to this individual Azure Digital Twins instance.
39+
* the **Owner** role in Azure Digital Twins. These are two distinct Azure Digital Twins management roles, and **Azure Digital Twins Data Owner** is the role that should be used for data management.
4040

4141
If you do not have this role, set it up to resolve the issue.
4242

@@ -48,18 +48,18 @@ If you do not have this role, set it up to resolve the issue.
4848

4949
If you do not have this role assignment, someone with an Owner role in your Azure subscription should run the following command to give your Azure user the appropriate role on the Azure Digital Twins instance.
5050

51-
If you're an Owner on the subscription, you can run this command yourself. If you're not, contact an Owner to run this command on your behalf. The role name is *Azure Digital Twins Data Owner* for edit access, or *Azure Digital Twins Data Reader* for read access.
51+
If you're an Owner on the subscription, you can run this command yourself. If you're not, contact an Owner to run this command on your behalf. The role name is **Azure Digital Twins Data Reader** for read access, or **Azure Digital Twins Data Owner** for edit access.
5252

5353
```azurecli-interactive
5454
az dt role-assignment create --dt-name <your-Azure-Digital-Twins-instance> --assignee "<your-Azure-AD-email>" --role "<role-name>"
5555
```
5656

57-
For more details about this role requirement and the assignment process, see [Set up your user's access permissions](how-to-set-up-instance-CLI.md#set-up-user-access-permissions).
57+
For more details about this role requirement and the assignment process, see [Set up your user's access permissions](how-to-set-up-instance-cli.md#set-up-user-access-permissions).
5858

5959
## Next steps
6060

61-
Read the setup steps for creating and authenticating a new Azure Digital Twins instance:
61+
Read the steps for creating and authenticating a new Azure Digital Twins instance:
6262
* [Set up an instance and authentication (CLI)](how-to-set-up-instance-cli.md)
6363

64-
Read more about security and permissions on Azure Digital Twins:
64+
Read more about security and permissions in Azure Digital Twins:
6565
* [Security for Azure Digital Twins solutions](concepts-security.md)

articles/digital-twins/troubleshoot-performance.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ titleSuffix: Azure Digital Twins
44
description: Tips for troubleshooting performance of an Azure Digital Twins instance.
55
author: baanders
66
ms.author: baanders
7-
ms.date: 03/10/2022
7+
ms.date: 06/17/2025
88
ms.topic: troubleshooting
99
ms.service: azure-digital-twins
1010
---
@@ -23,20 +23,20 @@ If your solution uses Azure Digital Twins in combination with other Azure servic
2323

2424
## Check logs
2525

26-
Azure Digital Twins can collect logs for your service instance to help monitor its performance, among other data. Logs can be sent to [Log Analytics](/azure/azure-monitor/logs/log-analytics-overview) or your custom storage mechanism. To enable logging in your instance, use the instructions in [Diagnostic settings in Azure Monitor](/azure/azure-monitor/essentials/diagnostic-settings). You can analyze the timestamps on the logs to measure latencies, evaluate if they're consistent, and understand their source.
26+
Azure Digital Twins can collect logs for your service instance to help monitor its performance, among other data. Logs can be sent to [Log Analytics](/azure/azure-monitor/logs/log-analytics-overview) or your custom storage mechanism. To enable logging in your instance, use the instructions in [Diagnostic settings in Azure Monitor](/azure/azure-monitor/essentials/diagnostic-settings). You can analyze the timestamps on the logs to measure latencies, evaluate whether they're consistent, and understand their source.
2727

2828
## Check API frequency
2929

30-
Another factor that might affect performance is time taken to reauthorize API calls. Consider the frequency of your API calls. If there's a gap of more than 15 minutes between calls, the system may be reauthorizing with each call, taking up extra time to do so. You can prevent this issue by adding a timer or something similar in your code to ensure that you call into Azure Digital Twins at least once every 15 minutes.
30+
Another factor that might affect performance is time taken to reauthorize API calls. Consider the frequency of your API calls. If there's a gap of more than 15 minutes between calls, the system may be taking time to reauthorize with each call. You can prevent this issue by adding a timer or similar feature in your code to ensure that it calls into Azure Digital Twins at least once every 15 minutes.
3131

3232
## Contact support
3333

34-
If you're still experiencing performance issues after troubleshooting with the steps above, you can create a support request from Azure Help + Support for more troubleshooting assistance.
34+
If you're still experiencing performance issues after troubleshooting with the steps in this article, you can create a support request from **Azure Help + support** for more troubleshooting assistance.
3535

3636
Follow these steps:
3737

3838
1. Gather [metrics](how-to-monitor.md#metrics-and-alerts) and [logs](how-to-monitor.md#diagnostics-logs) for your instance.
39-
2. Navigate to [Azure Help + support](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/newsupportrequest) in the Azure portal. Use the prompts to provide details of your issue, see recommended solutions, share your metrics/log files, and submit any other information that the support team can use to help investigate your issue. For more information on creating support requests, see [Create an Azure support request](/azure/azure-portal/supportability/how-to-create-azure-support-request).
39+
2. Navigate to [Help + support](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/newsupportrequest) in the Azure portal. Use the prompts to provide details of your issue, see recommended solutions, share your metrics/log files, and submit any other information that the support team can use to help investigate your issue. For more information on creating support requests, see [Create an Azure support request](/azure/azure-portal/supportability/how-to-create-azure-support-request).
4040

4141
## Next steps
4242

0 commit comments

Comments
 (0)