Skip to content

Commit ed2ae6b

Browse files
authored
Merge pull request #294531 from DENKEN02MSFT/ADTFreshnessTop40_Row25
ADT freshness review - row 25
2 parents 2f94ce1 + daeed0b commit ed2ae6b

13 files changed

+27
-28
lines changed

articles/digital-twins/how-to-set-up-instance-portal.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ titleSuffix: Azure Digital Twins
55
description: See how to set up an instance of the Azure Digital Twins service using the Azure portal
66
author: baanders
77
ms.author: baanders # Microsoft employees only
8-
ms.date: 11/17/2022
8+
ms.date: 2/12/2025
99
ms.topic: how-to
1010
ms.service: azure-digital-twins
1111
ms.custom: subject-rbac-steps, engagement-fy23
@@ -30,17 +30,16 @@ This version of this article goes through these steps manually, one by one, usin
3030

3131
[!INCLUDE [digital-twins-setup-portal.md](../../includes/digital-twins-setup-portal.md)]
3232

33-
3. On the following **Create Resource** page, fill in the values given below:
34-
* **Subscription**: The Azure subscription you're using
35-
- **Resource group**: A resource group in which to deploy the instance. If you don't already have an existing resource group in mind, you can create one here by selecting the **Create new** link and entering a name for a new resource group
36-
* **Location**: An Azure Digital Twins-enabled region for the deployment. For more details on regional support, visit [Azure products available by region (Azure Digital Twins)](https://azure.microsoft.com/global-infrastructure/services/?products=digital-twins).
37-
* **Resource name**: A name for your Azure Digital Twins instance. If your subscription has another Azure Digital Twins instance in the region that's
38-
already using the specified name, you'll be asked to pick a different name.
39-
* **Grant access to resource**: Checking the box in this section will give your Azure account permission to access and manage data in the instance. If you're the one that will be managing the instance, you should check this box now. If it's greyed out because you don't have permission in the subscription, you can continue creating the resource and have someone with the required permissions grant you the role later. For more information about this role and assigning roles to your instance, see the next section, [Set up user access permissions](#set-up-user-access-permissions).
33+
3. On the following **Create Resource** page, fill in the following values:
34+
* **Subscription**: The Azure subscription you're using.
35+
- **Resource group**: A resource group in which to deploy the instance. If you don't already have an existing resource group in mind, you can create one here by selecting the **Create new** link and entering a name for a new resource group.
36+
* **Resource name**: A name for your Azure Digital Twins instance. If your subscription has another Azure Digital Twins instance in the region that's already using the specified name, you are asked to pick a different name.
37+
* **Region**: An Azure Digital Twins-enabled region for the deployment. For more details on regional support, visit [Azure products available by region (Azure Digital Twins)](https://azure.microsoft.com/global-infrastructure/services/?products=digital-twins).
38+
* **Grant access to resource**: Checking the box in this section gives your Azure account permission to access and manage data in the instance. If you're the one that will be managing the instance, you should check this box now. If it's greyed out because you don't have permission in the subscription, you can continue creating the resource and have someone with the required permissions grant you the role later. For more information about this role and assigning roles to your instance, see the next section, [Set up user access permissions](#set-up-user-access-permissions).
4039

4140
:::image type="content" source= "media/how-to-set-up-instance/portal/create-azure-digital-twins-2.png" alt-text="Screenshot of the Create Resource process for Azure Digital Twins in the Azure portal. The described values are filled in.":::
4241

43-
4. When you're finished, you can select **Review + create** if you don't want to configure any more settings for your instance. Doing so will take you to a summary page, where you can review the instance details you've entered and finish with **Create**.
42+
4. When you're finished, you can select **Review + create** if you don't want to configure any more settings for your instance. Doing so takes you to a summary page, where you can review the instance details that you entered and finish with **Create**.
4443

4544
If you do want to configure more details for your instance, the next section describes the remaining setup tabs.
4645

@@ -49,21 +48,21 @@ This version of this article goes through these steps manually, one by one, usin
4948
Here are the additional options you can configure during setup, using the other tabs in the **Create Resource** process.
5049

5150
* **Networking**: In this tab, you can enable private endpoints with [Azure Private Link](../private-link/private-link-overview.md) to eliminate public network exposure to your instance. For instructions, see [Enable private access with Private Link](./how-to-enable-private-link.md?tabs=portal#add-a-private-endpoint-during-instance-creation).
52-
* **Advanced**: In this tab, you can enable a system-assigned [managed identity](concepts-security.md#managed-identity-for-accessing-other-resources) for your instance. When this is enabled, Azure automatically creates an identity for the instance in [Microsoft Entra ID](../active-directory/fundamentals/active-directory-whatis.md), which can be used to authenticate to other services. You can enable that system-assigned managed identity while you're creating the instance here, or [later on an existing instance](#enabledisable-managed-identity-for-the-instance). If you want to enable a user-assigned managed identity instead, you'll need to do it later on an existing instance.
51+
* **Advanced**: In this tab, you can enable a system-assigned [managed identity](concepts-security.md#managed-identity-for-accessing-other-resources) for your instance. When this option is enabled, Azure automatically creates an identity for the instance in [Microsoft Entra ID](../active-directory/fundamentals/active-directory-whatis.md), which can be used to authenticate to other services. You can enable that system-assigned managed identity while you're creating the instance here, or [later on an existing instance](#enabledisable-managed-identity-for-the-instance). If you want to enable a user-assigned managed identity instead, you need to do it later on an existing instance.
5352
* **Tags**: In this tab, you can add tags to your instance to help you organize it among your Azure resources. For more about Azure resource tags, see [Tag resources, resource groups, and subscriptions for logical organization](../azure-resource-manager/management/tag-resources.md).
5453

5554
### Verify success and collect important values
5655

57-
After finishing your instance setup by selecting **Create**, you can view the status of your instance's deployment in your Azure notifications along the portal icon bar. The notification will indicate when deployment has succeeded, at which point you can select the **Go to resource** button to view your created instance.
56+
After finishing your instance setup by selecting **Create**, you can view the status of your instance's deployment in your Azure notifications along the portal icon bar. The notification indicates when deployment succeeds, at which point you can select the **Go to resource** button to view your created instance.
5857

5958
:::image type="content" source="media/how-to-set-up-instance/portal/notifications-deployment.png" alt-text="Screenshot of the Azure notifications showing a successful deployment and highlighting the 'Go to resource' button in the Azure portal.":::
6059

61-
If deployment fails, the notification will indicate why. Observe the advice from the error message and retry creating the instance.
60+
If deployment fails, the notification indicates why. Observe the advice from the error message and retry creating the instance.
6261

6362
>[!TIP]
6463
>Once your instance is created, you can return to its page at any time by searching for the name of your instance in the Azure portal search bar.
6564
66-
From the instance's **Overview** page, note its **Name**, **Resource group**, and **Host name**. These values are all important and you may need to use them as you continue working with your Azure Digital Twins instance. If other users will be programming against the instance, you should share these values with them.
65+
From the instance's **Overview** page, note its **Name**, **Resource group**, and **Host name**. These values are all important and you might need to use them as you continue working with your Azure Digital Twins instance. If other users will be programming against the instance, you should share these values with them.
6766

6867
:::image type="content" source="media/how-to-set-up-instance/portal/instance-important-values.png" alt-text="Screenshot of the Azure portal, highlighting the important values from the Azure Digital Twins instance's Overview page.":::
6968

@@ -85,15 +84,15 @@ They both require the same permissions.
8584

8685
### Assign the role during instance creation
8786

88-
While creating your Azure Digital Twins resource through the process described [earlier in this article](#create-the-azure-digital-twins-instance), select the **Assign Azure Digital Twins Data Owner Role** under **Grant access to resource**. Doing so will grant yourself full access to the data plane APIs.
87+
While creating your Azure Digital Twins resource through the process described [earlier in this article](#create-the-azure-digital-twins-instance), select the **Assign Azure Digital Twins Data Owner Role** under **Grant access to resource**. Doing so grants yourself full access to the data plane APIs.
8988

9089
:::image type="content" source= "media/how-to-set-up-instance/portal/create-azure-digital-twins-2-role.png" alt-text="Screenshot of the Create Resource process for Azure Digital Twins in the Azure portal. The checkbox under Grant access to resource is highlighted.":::
9190

92-
If you don't have permission to assign a role to an identity, the box will appear greyed out.
91+
If you don't have permission to assign a role to an identity, the box appears greyed out.
9392

9493
:::image type="content" source= "media/how-to-set-up-instance/portal/create-azure-digital-twins-2-role-greyed.png" alt-text="Screenshot of the Create Resource process for Azure Digital Twins in the Azure portal. The checkbox under Grant access to resource is disabled.":::
9594

96-
In that case, you can still continue to successfully create the Azure Digital Twins resource, but someone with the appropriate permissions will need to assign this role to you or the person who will be managing the instance's data.
95+
In that case, you can still continue to successfully create the Azure Digital Twins resource, but someone with the appropriate permissions needs to assign this role to you or to the person who will manage the instance's data.
9796

9897
### Assign the role using Azure Identity Management (IAM)
9998

@@ -117,11 +116,11 @@ You can also assign the **Azure Digital Twins Data Owner** role using the access
117116

118117
### Verify success
119118

120-
You can view the role assignment you've set up under **Access control (IAM) > Role assignments**. The user should show up in the list with a role of **Azure Digital Twins Data Owner**.
119+
You can view the role assignment you set up under **Access control (IAM) > Role assignments**. The user should show up in the list with a role of **Azure Digital Twins Data Owner**.
121120

122121
:::image type="content" source="media/how-to-set-up-instance/portal/verify-role-assignment.png" alt-text="Screenshot of the role assignments for an Azure Digital Twins instance in the Azure portal.":::
123122

124-
You now have an Azure Digital Twins instance ready to go, and have assigned permissions to manage it.
123+
You now have an Azure Digital Twins instance ready to go, and assigned permissions to manage it.
125124

126125
## Enable/disable managed identity for the instance
127126

@@ -144,13 +143,13 @@ Start by opening the [Azure portal](https://portal.azure.com) in a browser.
144143

145144
:::image type="content" source="media/how-to-set-up-instance/portal/identity-user-assigned.png" alt-text="Screenshot of the Azure portal showing the Identity page and user-assigned options for an Azure Digital Twins instance." lightbox="media/how-to-set-up-instance/portal/identity-user-assigned.png":::
146145

147-
Or, if there is already an identity listed here that you want to disable, you can check the box next to it in the list and **Remove** it.
146+
Or, if there's already an identity listed here that you want to disable, you can check the box next to it in the list and **Remove** it.
148147

149-
Once an identity has been added, you can select its name from the list here to open its details. From its details page, you can view its **Object ID** and use the left menu to see its **Azure role assignments**.
148+
Once an identity is added, you can select its name from the list here to open its details. From its details page, you can view its **Object ID** and use the left menu to see its **Azure role assignments**.
150149

151150
### Considerations for disabling managed identities
152151

153-
It's important to consider the effects that any changes to the identity or its roles can have on the resources that use it. If you're [using managed identities with your Azure Digital Twins endpoints](how-to-create-endpoints.md#endpoint-options-identity-based-authentication) or for [data history](how-to-create-data-history-connection.md) and the identity is disabled, or a necessary role is removed from it, the endpoint or data history connection can become inaccessible and the flow of events will be disrupted.
152+
It's important to consider the effects that any changes to the identity or its roles can have on the resources that use it. If you're [using managed identities with your Azure Digital Twins endpoints](how-to-create-endpoints.md#endpoint-options-identity-based-authentication) or for [data history](how-to-create-data-history-connection.md) and the identity is disabled, or a necessary role is removed from it, the endpoint or data history connection can become inaccessible and the flow of events is disrupted.
154153

155154
## Next steps
156155

-103 KB
Loading
-100 KB
Loading
-83.7 KB
Loading
200 KB
Loading
60.8 KB
Loading
-144 KB
Loading
-191 KB
Loading
-67.1 KB
Loading
-126 KB
Loading

0 commit comments

Comments
 (0)