Skip to content

Commit 26a9dce

Browse files
Merge pull request #227770 from CelesteDG/patch-46
Updated instances of Azure AD and AAD
2 parents 3cafe3e + d134971 commit 26a9dce

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

articles/app-service/configure-authentication-api-version.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Manage AuthN/AuthZ API versions
33
description: Upgrade your App Service authentication API to V2 or pin it to a specific version, if needed.
44
ms.topic: article
5-
ms.date: 03/29/2021
5+
ms.date: 02/17/2023
66
ms.custom: seodec18, devx-track-azurecli
77
---
88

@@ -15,15 +15,15 @@ There are two versions of the management API for App Service authentication. The
1515
## Update the configuration version
1616

1717
> [!WARNING]
18-
> Migration to V2 will disable management of the App Service Authentication / Authorization feature for your application through some clients, such as its existing experience in the Azure portal, Azure CLI, and Azure PowerShell. This cannot be reversed.
18+
> Migration to V2 will disable management of the App Service Authentication/Authorization feature for your application through some clients, such as its existing experience in the Azure portal, Azure CLI, and Azure PowerShell. This cannot be reversed.
1919
20-
The V2 API does not support creation or editing of Microsoft Account as a distinct provider as was done in V1. Rather, it leverages the converged [Microsoft Identity Platform](../active-directory/develop/v2-overview.md) to sign-in users with both Azure AD and personal Microsoft accounts. When switching to the V2 API, the V1 Azure Active Directory configuration is used to configure the Microsoft Identity Platform provider. The V1 Microsoft Account provider will be carried forward in the migration process and continue to operate as normal, but it is recommended that you move to the newer Microsoft Identity Platform model. See [Support for Microsoft Account provider registrations](#support-for-microsoft-account-provider-registrations) to learn more.
20+
The V2 API does not support creation or editing of Microsoft Account as a distinct provider as was done in V1. Rather, it leverages the converged [Microsoft identity platform](../active-directory/develop/v2-overview.md) to sign-in users with both Azure AD and personal Microsoft accounts. When switching to the V2 API, the V1 Azure Active Directory (Azure AD) configuration is used to configure the Microsoft identity platform provider. The V1 Microsoft Account provider will be carried forward in the migration process and continue to operate as normal, but it is recommended that you move to the newer Microsoft Identity Platform model. See [Support for Microsoft Account provider registrations](#support-for-microsoft-account-provider-registrations) to learn more.
2121

2222
The automated migration process will move provider secrets into application settings and then convert the rest of the configuration into the new format. To use the automatic migration:
2323

2424
1. Navigate to your app in the portal and select the **Authentication** menu option.
25-
1. If the app is configured using the V1 model, you will see an **Upgrade** button.
26-
1. Review the description in the confirmation prompt. If you are ready to perform the migration, click **Upgrade** in the prompt.
25+
1. If the app is configured using the V1 model, you'll see an **Upgrade** button.
26+
1. Review the description in the confirmation prompt. If you're ready to perform the migration, click **Upgrade** in the prompt.
2727

2828
### Manually managing the migration
2929

@@ -37,9 +37,9 @@ The following steps will allow you to manually migrate the application to the V2
3737
az webapp auth show -g <group_name> -n <site_name>
3838
```
3939

40-
In the resulting JSON payload, make note of the secret value used for each provider you have configured:
40+
In the resulting JSON payload, make note of the secret value used for each provider you've configured:
4141

42-
* AAD: `clientSecret`
42+
* Azure AD: `clientSecret`
4343
* Google: `googleClientSecret`
4444
* Facebook: `facebookAppSecret`
4545
* Twitter: `twitterConsumerSecret`
@@ -48,7 +48,7 @@ The following steps will allow you to manually migrate the application to the V2
4848
> [!IMPORTANT]
4949
> The secret values are important security credentials and should be handled carefully. Do not share these values or persist them on a local machine.
5050
51-
1. Create slot-sticky application settings for each secret value. You may choose the name of each application setting. It's value should match what you obtained in the previous step or [reference a Key Vault secret](./app-service-key-vault-references.md?toc=/azure/azure-functions/toc.json) that you have created with that value.
51+
1. Create slot-sticky application settings for each secret value. You may choose the name of each application setting. Its value should match what you obtained in the previous step or [reference a Key Vault secret](./app-service-key-vault-references.md?toc=/azure/azure-functions/toc.json) that you've created with that value.
5252

5353
To create the setting, you can use the Azure portal or run a variation of the following for each provider:
5454

@@ -63,17 +63,17 @@ The following steps will allow you to manually migrate the application to the V2
6363
> [!NOTE]
6464
> The application settings for this configuration should be marked as slot-sticky, meaning that they will not move between environments during a [slot swap operation](./deploy-staging-slots.md). This is because your authentication configuration itself is tied to the environment.
6565
66-
1. Create a new JSON file named `authsettings.json`.Take the output that you received previously and remove each secret value from it. Write the remaining output to the file, making sure that no secret is included. In some cases, the configuration may have arrays containing empty strings. Make sure that `microsoftAccountOAuthScopes` does not, and if it does, switch that value to `null`.
66+
1. Create a new JSON file named `authsettings.json`. Take the output that you received previously and remove each secret value from it. Write the remaining output to the file, making sure that no secret is included. In some cases, the configuration may have arrays containing empty strings. Make sure that `microsoftAccountOAuthScopes` does not, and if it does, switch that value to `null`.
6767

6868
1. Add a property to `authsettings.json` which points to the application setting name you created earlier for each provider:
6969

70-
* AAD: `clientSecretSettingName`
70+
* Azure AD: `clientSecretSettingName`
7171
* Google: `googleClientSecretSettingName`
7272
* Facebook: `facebookAppSecretSettingName`
7373
* Twitter: `twitterConsumerSecretSettingName`
7474
* Microsoft Account: `microsoftAccountClientSecretSettingName`
7575

76-
An example file after this operation might look similar to the following, in this case only configured for AAD:
76+
An example file after this operation might look similar to the following, in this case only configured for Azure AD:
7777

7878
```json
7979
{
@@ -133,24 +133,24 @@ The following steps will allow you to manually migrate the application to the V2
133133

134134
1. Delete the file used in the previous steps.
135135

136-
You have now migrated the app to store identity provider secrets as application settings.
136+
You've now migrated the app to store identity provider secrets as application settings.
137137

138138
#### Support for Microsoft Account provider registrations
139139

140-
If your existing configuration contains a Microsoft Account provider and does not contain an Azure Active Directory provider, you can switch the configuration over to the Azure Active Directory provider and then perform the migration. To do this:
140+
If your existing configuration contains a Microsoft Account provider and does not contain an Azure AD provider, you can switch the configuration over to the Azure AD provider and then perform the migration. To do this:
141141

142142
1. Go to [**App registrations**](https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) in the Azure portal and find the registration associated with your Microsoft Account provider. It may be under the "Applications from personal account" heading.
143143
1. Navigate to the "Authentication" page for the registration. Under "Redirect URIs" you should see an entry ending in `/.auth/login/microsoftaccount/callback`. Copy this URI.
144144
1. Add a new URI that matches the one you just copied, except instead have it end in `/.auth/login/aad/callback`. This will allow the registration to be used by the App Service Authentication / Authorization configuration.
145145
1. Navigate to the App Service Authentication / Authorization configuration for your app.
146146
1. Collect the configuration for the Microsoft Account provider.
147-
1. Configure the Azure Active Directory provider using the "Advanced" management mode, supplying the client ID and client secret values you collected in the previous step. For the Issuer URL, use Use `<authentication-endpoint>/<tenant-id>/v2.0`, and replace *\<authentication-endpoint>* with the [authentication endpoint for your cloud environment](../active-directory/develop/authentication-national-cloud.md#azure-ad-authentication-endpoints) (e.g., "https://login.microsoftonline.com" for global Azure), also replacing *\<tenant-id>* with your **Directory (tenant) ID**.
148-
1. Once you have saved the configuration, test the login flow by navigating in your browser to the `/.auth/login/aad` endpoint on your site and complete the sign-in flow.
149-
1. At this point, you have successfully copied the configuration over, but the existing Microsoft Account provider configuration remains. Before you remove it, make sure that all parts of your app reference the Azure Active Directory provider through login links, etc. Verify that all parts of your app work as expected.
150-
1. Once you have validated that things work against the AAD Azure Active Directory provider, you may remove the Microsoft Account provider configuration.
147+
1. Configure the Azure AD provider using the "Advanced" management mode, supplying the client ID and client secret values you collected in the previous step. For the Issuer URL, use Use `<authentication-endpoint>/<tenant-id>/v2.0`, and replace *\<authentication-endpoint>* with the [authentication endpoint for your cloud environment](../active-directory/develop/authentication-national-cloud.md#azure-ad-authentication-endpoints) (e.g., "https://login.microsoftonline.com" for global Azure), also replacing *\<tenant-id>* with your **Directory (tenant) ID**.
148+
1. Once you've saved the configuration, test the login flow by navigating in your browser to the `/.auth/login/aad` endpoint on your site and complete the sign-in flow.
149+
1. At this point, you've successfully copied the configuration over, but the existing Microsoft Account provider configuration remains. Before you remove it, make sure that all parts of your app reference the Azure AD provider through login links, etc. Verify that all parts of your app work as expected.
150+
1. Once you've validated that things work against the Azure AD provider, you may remove the Microsoft Account provider configuration.
151151

152152
> [!WARNING]
153-
> It is possible to converge the two registrations by modifying the [supported account types](../active-directory/develop/supported-accounts-validation.md) for the AAD app registration. However, this would force a new consent prompt for Microsoft Account users, and those users' identity claims may be different in structure, `sub` notably changing values since a new App ID is being used. This approach is not recommended unless thoroughly understood. You should instead wait for support for the two registrations in the V2 API surface.
153+
> It is possible to converge the two registrations by modifying the [supported account types](../active-directory/develop/supported-accounts-validation.md) for the Azure AD app registration. However, this would force a new consent prompt for Microsoft Account users, and those users' identity claims may be different in structure, `sub` notably changing values since a new App ID is being used. This approach is not recommended unless thoroughly understood. You should instead wait for support for the two registrations in the V2 API surface.
154154
155155
#### Switching to V2
156156

@@ -160,7 +160,7 @@ Alternatively, you may make a PUT request against the `config/authsettingsv2` re
160160

161161
## Pin your app to a specific authentication runtime version
162162

163-
When you enable Authentication / Authorization, platform middleware is injected into your HTTP request pipeline as described in the [feature overview](overview-authentication-authorization.md#how-it-works). This platform middleware is periodically updated with new features and improvements as part of routine platform updates. By default, your web or function app will run on the latest version of this platform middleware. These automatic updates are always backwards compatible. However, in the rare event that this automatic update introduces a runtime issue for your web or function app, you can temporarily roll back to the previous middleware version. This article explains how to temporarily pin an app to a specific version of the authentication middleware.
163+
When you enable authentication/authorization, platform middleware is injected into your HTTP request pipeline as described in the [feature overview](overview-authentication-authorization.md#how-it-works). This platform middleware is periodically updated with new features and improvements as part of routine platform updates. By default, your web or function app will run on the latest version of this platform middleware. These automatic updates are always backwards compatible. However, in the rare event that this automatic update introduces a runtime issue for your web or function app, you can temporarily roll back to the previous middleware version. This article explains how to temporarily pin an app to a specific version of the authentication middleware.
164164

165165
### Automatic and manual version updates
166166

@@ -185,7 +185,7 @@ az webapp auth show --name <my_app_name> \
185185

186186
In this code, replace `<my_app_name>` with the name of your app. Also replace `<my_resource_group>` with the name of the resource group for your app.
187187

188-
You will see the `runtimeVersion` field in the CLI output. It will resemble the following example output, which has been truncated for clarity:
188+
You'll see the `runtimeVersion` field in the CLI output. It will resemble the following example output, which has been truncated for clarity:
189189
```output
190190
{
191191
"additionalLoginParams": null,

0 commit comments

Comments
 (0)