Skip to content

Commit 5da4a38

Browse files
authored
Merge pull request #108221 from stevemunk/how-to-manage-authentication
Grammar improvements and created end-links in web-sdk-best-practices.md
2 parents 6a23904 + 4e04d18 commit 5da4a38

File tree

1 file changed

+48
-25
lines changed

1 file changed

+48
-25
lines changed

articles/azure-maps/how-to-manage-authentication.md

Lines changed: 48 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ custom.ms: subject-rbac-steps
1313

1414
# Manage authentication in Azure Maps
1515

16-
When you create an Azure Maps account, your client ID is automatically generated along with primary and secondary keys that are required for authentication when using [Azure Active Directory (Azure AD)](../active-directory/fundamentals/active-directory-whatis.md) or [Shared Key authentication](./azure-maps-authentication.md#shared-key-authentication).
16+
When you create an Azure Maps account, your client ID and shared keys are created automatically. These values are required for authentication when using either [Azure Active Directory (Azure AD)] or [Shared Key authentication].
1717

1818
## Prerequisites
1919

20-
Sign in to the [Azure portal](https://portal.azure.com). If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/) before you begin.
21-
- A familiarization with [managed identities for Azure resources](../active-directory/managed-identities-azure-resources/overview.md). Be sure to understand the two [Managed identity types](../active-directory/managed-identities-azure-resources/overview.md#managed-identity-types) and how they differ.
22-
- [An Azure Maps account](quick-demo-map-app.md#create-an-azure-maps-account).
23-
- A familiarization with [Azure Maps Authentication](./azure-maps-authentication.md).
20+
Sign in to the [Azure portal]. If you don't have an Azure subscription, create a [free account] before you begin.
21+
22+
- A familiarization with [managed identities for Azure resources]. Be sure to understand the two [Managed identity types] and how they differ.
23+
- [An Azure Maps account].
24+
- A familiarization with [Azure Maps Authentication].
2425

2526
## View authentication details
2627

@@ -29,7 +30,7 @@ Sign in to the [Azure portal](https://portal.azure.com). If you don't have an Az
2930
3031
To view your Azure Maps authentication details:
3132

32-
1. Sign in to the [Azure portal](https://portal.azure.com).
33+
1. Sign in to the [Azure portal].
3334

3435
2. Select **All resources** in the **Azure services** section, then select your Azure Maps account.
3536

@@ -41,18 +42,18 @@ To view your Azure Maps authentication details:
4142

4243
## Choose an authentication category
4344

44-
Depending on your application needs, there are specific pathways to application security. Azure AD defines specific authentication categories to support a wide range of authentication flows. To choose the best category for your application, see [application categories](../active-directory/develop/authentication-flows-app-scenarios.md#application-categories).
45+
Depending on your application needs, there are specific pathways to application security. Azure AD defines specific authentication categories to support a wide range of authentication flows. To choose the best category for your application, see [application categories].
4546

4647
> [!NOTE]
4748
> Understanding categories and scenarios will help you secure your Azure Maps application, whether you use Azure Active Directory or shared key authentication.
4849
4950
## How to add and remove managed identities
5051

51-
To enable [Shared access signature (SAS) token authentication](./azure-maps-authentication.md#shared-access-signature-token-authentication) with the Azure Maps REST API you need to add a user-assigned managed identity to your Azure Maps account.
52+
To enable [Shared access signature (SAS) token authentication] with the Azure Maps REST API, you need to add a user-assigned managed identity to your Azure Maps account.
5253

5354
### Create a managed identity
5455

55-
You can create a user-assigned managed identity before or after creating a map account. You can add the managed identity through the portal, Azure management SDKs, or the Azure Resource Manager (ARM) template. To add a user-assigned managed identity through an ARM template, specify the resource identifier of the user-assigned managed identity. See example below:
56+
You can create a user-assigned managed identity before or after creating a map account. You can add the managed identity through the portal, Azure management SDKs, or the Azure Resource Manager (ARM) template. To add a user-assigned managed identity through an ARM template, specify the resource identifier of the user-assigned managed identity.
5657

5758
```json
5859
"identity": {
@@ -67,7 +68,7 @@ You can create a user-assigned managed identity before or after creating a map a
6768

6869
You can remove a system-assigned identity by disabling the feature through the portal or the Azure Resource Manager template in the same way that it was created. User-assigned identities can be removed individually. To remove all identities, set the identity type to `"None"`.
6970

70-
Removing a system-assigned identity in this way will also delete it from Azure AD. System-assigned identities are also automatically removed from Azure AD when the Azure Maps account is deleted.
71+
Removing a system-assigned identity in this way also deletes it from Azure AD. System-assigned identities are also automatically removed from Azure AD when the Azure Maps account is deleted.
7172

7273
To remove all identities by using the Azure Resource Manager template, update this section:
7374

@@ -79,20 +80,20 @@ To remove all identities by using the Azure Resource Manager template, update th
7980

8081
## Choose an authentication and authorization scenario
8182

82-
This table outlines common authentication and authorization scenarios in Azure Maps. Each scenario describes a type of app which can be used to access Azure Maps REST API. Use the links to learn detailed configuration information for each scenario.
83+
This table outlines common authentication and authorization scenarios in Azure Maps. Each scenario describes a type of app that can be used to access Azure Maps REST API. Use the links to learn detailed configuration information for each scenario.
8384

8485
> [!IMPORTANT]
8586
> For production applications, we recommend implementing Azure AD with Azure role-based access control (Azure RBAC).
8687
87-
| Scenario | Authentication | Authorization | Development effort | Operational effort |
88-
| ----------------------------------------------------------------------------------- | -------------- | ------------- | ------------------ | ------------------ |
89-
| [Trusted daemon app or non-interactive client app](./how-to-secure-daemon-app.md) | Shared Key | N/A | Medium | High |
90-
| [Trusted daemon or non-interactive client app](./how-to-secure-daemon-app.md) | Azure AD | High | Low | Medium |
91-
| [Web single page app with interactive single-sign-on](./how-to-secure-spa-users.md) | Azure AD | High | Medium | Medium |
92-
| [Web single page app with non-interactive sign-on](./how-to-secure-spa-app.md) | Azure AD | High | Medium | Medium |
93-
| [Web app, daemon app, or non-interactive sign-on app](./how-to-secure-sas-app.md) | SAS Token | High | Medium | Low |
94-
| [Web application with interactive single-sign-on](./how-to-secure-webapp-users.md) | Azure AD | High | High | Medium |
95-
| [IoT device or an input constrained application](./how-to-secure-device-code.md) | Azure AD | High | Medium | Medium |
88+
| Scenario | Authentication | Authorization | Development effort | Operational effort |
89+
| -----------------------------------------------------| -------------- | ------------- | ------------------ | ------------------ |
90+
| [Trusted daemon app or non-interactive client app] | Shared Key | N/A | Medium | High |
91+
| [Trusted daemon or non-interactive client app] | Azure AD | High | Low | Medium |
92+
| [Web single page app with interactive single-sign-on]| Azure AD | High | Medium | Medium |
93+
| [Web single page app with non-interactive sign-on] | Azure AD | High | Medium | Medium |
94+
| [Web app, daemon app, or non-interactive sign-on app]| SAS Token | High | Medium | Low |
95+
| [Web application with interactive single-sign-on] | Azure AD | High | High | Medium |
96+
| [IoT device or an input constrained application] | Azure AD | High | Medium | Medium |
9697

9798
## View built-in Azure Maps role definitions
9899

@@ -131,7 +132,7 @@ Request a token from the Azure AD token endpoint. In your Azure AD request, use
131132
| Azure public cloud | `https://login.microsoftonline.com` | `https://atlas.microsoft.com/` |
132133
| Azure Government cloud | `https://login.microsoftonline.us` | `https://atlas.microsoft.com/` |
133134

134-
For more information about requesting access tokens from Azure AD for users and service principals, see [Authentication scenarios for Azure AD](../active-directory/develop/authentication-vs-authorization.md). To view specific scenarios, see [the table of scenarios](./how-to-manage-authentication.md#choose-an-authentication-and-authorization-scenario).
135+
For more information about requesting access tokens from Azure AD for users and service principals, see [Authentication scenarios for Azure AD]. To view specific scenarios, see [the table of scenarios].
135136

136137
## Manage and rotate shared keys
137138

@@ -142,14 +143,14 @@ Your Azure Maps subscription keys are similar to a root password for your Azure
142143
143144
### Manually rotate subscription keys
144145

145-
To help keep your Azure Maps account secure, we recommend periodically rotating your subscription keys. If possible, use Azure Key Vault to manage your access keys. If you aren't using Key Vault, you'll need to manually rotate your keys.
146+
To help keep your Azure Maps account secure, we recommend periodically rotating your subscription keys. If possible, use Azure Key Vault to manage your access keys. If you aren't using Key Vault, you need to manually rotate your keys.
146147

147148
Two subscription keys are assigned so that you can rotate your keys. Having two keys ensures that your application maintains access to Azure Maps throughout the process.
148149

149150
To rotate your Azure Maps subscription keys in the Azure portal:
150151

151152
1. Update your application code to reference the secondary key for the Azure Maps account and deploy.
152-
2. In the [Azure portal](https://portal.azure.com/), navigate to your Azure Maps account.
153+
2. In the [Azure portal], navigate to your Azure Maps account.
153154
3. Under **Settings**, select **Authentication**.
154155
4. To regenerate the primary key for your Azure Maps account, select the **Regenerate** button next to the primary key.
155156
5. Update your application code to reference the new primary key and deploy.
@@ -163,9 +164,31 @@ To rotate your Azure Maps subscription keys in the Azure portal:
163164
Find the API usage metrics for your Azure Maps account:
164165

165166
> [!div class="nextstepaction"]
166-
> [View usage metrics](how-to-view-api-usage.md)
167+
> [View usage metrics]
167168
168169
Explore samples that show how to integrate Azure AD with Azure Maps:
169170

170171
> [!div class="nextstepaction"]
171-
> [Azure AD authentication samples](https://github.com/Azure-Samples/Azure-Maps-AzureAD-Samples)
172+
> [Azure AD authentication samples]
173+
174+
[Azure portal]: https://portal.azure.com/
175+
[Azure AD authentication samples]: https://github.com/Azure-Samples/Azure-Maps-AzureAD-Samples
176+
[View usage metrics]: how-to-view-api-usage.md
177+
[Authentication scenarios for Azure AD]: ../active-directory/develop/authentication-vs-authorization.md
178+
[the table of scenarios]: how-to-manage-authentication.md#choose-an-authentication-and-authorization-scenario
179+
[Trusted daemon app or non-interactive client app]: how-to-secure-daemon-app.md
180+
[Trusted daemon or non-interactive client app]: how-to-secure-daemon-app.md
181+
[Web single page app with interactive single-sign-on]: how-to-secure-spa-users.md
182+
[Web single page app with non-interactive sign-on]: how-to-secure-spa-app.md
183+
[Web app, daemon app, or non-interactive sign-on app]: how-to-secure-sas-app.md
184+
[Web application with interactive single-sign-on]: how-to-secure-webapp-users.md
185+
[IoT device or an input constrained application]: how-to-secure-device-code.md
186+
[Shared access signature (SAS) token authentication]: azure-maps-authentication.md#shared-access-signature-token-authentication
187+
[application categories]: ../active-directory/develop/authentication-flows-app-scenarios.md#application-categories
188+
[Azure Active Directory (Azure AD)]: ../active-directory/fundamentals/active-directory-whatis.md
189+
[Shared Key authentication]: azure-maps-authentication.md#shared-key-authentication
190+
[free account]: https://azure.microsoft.com/free/
191+
[managed identities for Azure resources]: ../active-directory/managed-identities-azure-resources/overview.md
192+
[Managed identity types]: ../active-directory/managed-identities-azure-resources/overview.md#managed-identity-types
193+
[An Azure Maps account]: quick-demo-map-app.md#create-an-azure-maps-account
194+
[Azure Maps Authentication]: azure-maps-authentication.md

0 commit comments

Comments
 (0)