Skip to content

Commit b8aae12

Browse files
authored
Merge pull request #98127 from DennisLee-DennisLee/v-dele-1645361-003
1645361 portal-nav: Updated two API management articles.
2 parents 976012a + eb2fd1c commit b8aae12

File tree

2 files changed

+36
-33
lines changed

2 files changed

+36
-33
lines changed

articles/api-management/api-management-howto-protect-backend-with-aad.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ Here is a quick overview of the steps:
4343

4444
To protect an API with Azure AD, the first step is to register an application in Azure AD that represents the API.
4545

46-
1. Navigate to the [Azure portal - App registrations](https://go.microsoft.com/fwlink/?linkid=2083908) page.
46+
1. Go to the [Azure portal](https://portal.azure.com) to register your application. Search for and select **API registrations**.
4747

4848
1. Select **New registration**.
4949

5050
1. When the **Register an application page** appears, enter your application's registration information:
51-
- In the **Name** section, enter a meaningful application name that will be displayed to users of the app, for example `backend-app`.
51+
- In the **Name** section, enter a meaningful application name that will be displayed to users of the app, such as *backend-app*.
5252
- In the **Supported account types** section, select an option that suits your scenario.
5353

5454
1. Leave the **Redirect URI** section empty.
@@ -59,51 +59,51 @@ To protect an API with Azure AD, the first step is to register an application in
5959

6060
1. Select **Expose an API** and set the **Application ID URI** with the default value. Record this value for later.
6161

62-
1. In the **Add a scope** page, create a new scope supported by the API. (e.g., Read) then click on *Add scope* to create the scope. Repeat this step to add all scopes supported by your API.
62+
1. Select the **Add a scope** button to display the **Add a scope** page. Then create a new scope that's supported by the API (for example, `Files.Read`). Finally, select the **Add scope** button to create the scope. Repeat this step to add all scopes supported by your API.
6363

64-
1. When the scope is created, make a note of it, for use in a subsequent step.
64+
1. When the scopes are created, make a note of them for use in a subsequent step.
6565

6666
## Register another application in Azure AD to represent a client application
6767

6868
Every client application that calls the API needs to be registered as an application in Azure AD as well. In this example, the client application is the Developer Console in the API Management developer portal. Here's how to register another application in Azure AD to represent the Developer Console.
6969

70-
1. Navigate to the [Azure portal - App registrations](https://go.microsoft.com/fwlink/?linkid=2083908) page.
70+
1. Go to the [Azure portal](https://portal.azure.com) to register your application. Search for and select **API registrations**.
7171

7272
1. Select **New registration**.
7373

7474
1. When the **Register an application page** appears, enter your application's registration information:
75-
- In the **Name** section, enter a meaningful application name that will be displayed to users of the app, for example `client-app`.
76-
- In the **Supported account types** section, select **Accounts in any organizational directory**.
75+
- In the **Name** section, enter a meaningful application name that will be displayed to users of the app, such as *client-app*.
76+
- In the **Supported account types** section, select **Accounts in any organizational directory (Any Azure AD directory - Multitenant)**.
7777

78-
1. In the **Redirect URI** section, select `Web` and enter the URL `https://contoso5.portal.azure-api.net/signin`
78+
1. In the **Redirect URI** section, select `Web` and enter the URL `https://contoso5.portal.azure-api.net/signin`.
7979

8080
1. Select **Register** to create the application.
8181

8282
1. On the app **Overview** page, find the **Application (client) ID** value and record it for later.
8383

84-
Now, create a client secret for this application, for use in a subsequent step.
84+
Now, create a client secret for this application to use in a subsequent step.
8585

8686
1. From the list of pages for your client app, select **Certificates & secrets**, and select **New client secret**.
8787

8888
1. Under **Add a client secret**, provide a **Description**. Choose when the key should expire, and select **Add**.
8989

90-
When the secret is created, make a note of the key value, for use in a subsequent step.
90+
When the secret is created, note the key value for use in a subsequent step.
9191

9292
## Grant permissions in Azure AD
9393

9494
Now that you have registered two applications to represent the API and the Developer Console, you need to grant permissions to allow the client-app to call the backend-app.
9595

96-
1. Navigate to **App registrations**.
96+
1. Go to the [Azure portal](https://portal.azure.com) to grant permissions to your client application. Search for and select **API registrations**.
9797

98-
1. Select `client-app`, and in the list of pages for the app go to **API permissions**.
98+
1. Choose your client app. Then in the list of pages for the app, select **API permissions**.
9999

100100
1. Select **Add a Permission**.
101101

102-
1. Under **Select an API**, find and select `backend-app`.
102+
1. Under **Select an API**, select **My APIs**, and then find and select your backend-app.
103103

104-
1. Under **Delegated Permissions**, select the appropriate permissions to `backend-app` then click on **Add permissions**.
104+
1. Under **Delegated Permissions**, select the appropriate permissions to your backend-app, then select **Add permissions**.
105105

106-
1. Optionally, on the **API permissions** page, click on **Grant admin consent for <your-tenant-name>** in the bottom of the page to grant consent on behalf of all users in this directory.
106+
1. Optionally, on the **API permissions** page, select **Grant admin consent for \<your-tenant-name>** to grant consent on behalf of all users in this directory.
107107

108108
## Enable OAuth 2.0 user authorization in the Developer Console
109109

articles/api-management/api-management-using-with-vnet.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,44 +41,47 @@ To perform the steps described in this article, you must have:
4141

4242
### Enable VNET connectivity using the Azure portal
4343

44-
1. Navigate to your APIM instance in the [Azure portal](https://portal.azure.com/).
45-
2. Select **Virtual Network**.
46-
3. Configure the API Management instance to be deployed inside a Virtual network.
44+
1. Go to the [Azure portal](https://portal.azure.com) to find your API management instance. Search for and select **API Management services**.
45+
46+
2. Choose your API Management instance.
47+
48+
3. Select **Virtual network**.
49+
4. Configure the API Management instance to be deployed inside a Virtual network.
4750

4851
![Virtual network menu of API Management][api-management-using-vnet-menu]
49-
4. Select the desired access type:
52+
5. Select the desired access type:
53+
54+
* **Off**: This is the default. API Management is not deployed into a virtual network.
5055

51-
* **Off**: this is the default. API Management is not deployed into a virtual network.
56+
* **External**: The API Management gateway and developer portal are accessible from the public internet via an external load balancer. The gateway can access resources within the virtual network.
5257

53-
* **External**: the API Management gateway and developer portal are accessible from the public internet via an external load balancer. The gateway can access resources within the virtual network.
58+
![Public peering][api-management-vnet-public]
5459

55-
![Public peering][api-management-vnet-public]
60+
* **Internal**: The API Management gateway and developer portal are accessible only from within the virtual network via an internal load balancer. The gateway can access resources within the virtual network.
5661

57-
* **Internal**: the API Management gateway and developer portal are accessible only from within the virtual network via an internal load balancer. The gateway can access resources within the virtual network.
62+
![Private peering][api-management-vnet-private]
5863

59-
![Private peering][api-management-vnet-private]
64+
6. If you selected **External** or **Internal**, you will see a list of all regions where your API Management service is provisioned. Choose a **Location**, and then pick its **Virtual network** and **Subnet**. The virtual network list is populated with both classic and Resource Manager virtual networks available in your Azure subscriptions that are set up in the region you are configuring.
6065

61-
You will now see a list of all regions where your API Management service is provisioned. Select a VNET and subnet for every region. The list is populated with both classic and Resource Manager virtual networks available in your Azure subscriptions that are setup in the region you are configuring.
66+
> [!IMPORTANT]
67+
> When deploying an Azure API Management instance to a Resource Manager VNET, the service must be in a dedicated subnet that contains no other resources except for Azure API Management instances. If an attempt is made to deploy an Azure API Management instance to a Resource Manager VNET subnet that contains other resources, the deployment will fail.
6268
63-
> [!IMPORTANT]
64-
> When deploying an Azure API Management instance to a Resource Manager VNET, the service must be in a dedicated subnet that contains no other resources except for Azure API Management instances. If an attempt is made to deploy an Azure API Management instance to a Resource Manager VNET subnet that contains other resources, the deployment will fail.
65-
>
69+
Then select **Apply**. The **Virtual network** page of your API Management instance is updated with your new virtual network and subnet choices.
6670

67-
![Select VPN][api-management-setup-vpn-select]
71+
![Select VPN][api-management-setup-vpn-select]
6872

69-
5. Click **Save** in the top navigation bar.
70-
6. Click **Apply network configuration** in the top navigation bar.
73+
7. In the top navigation bar, select **Save**, and then select **Apply network configuration**.
7174

7275
> [!NOTE]
7376
> The VIP address of the API Management instance will change each time VNET is enabled or disabled.
74-
> The VIP address will also change when API Management is moved from **External** to **Internal** or vice-versa
77+
> The VIP address will also change when API Management is moved from **External** to **Internal**, or vice-versa.
7578
>
7679
7780
> [!IMPORTANT]
7881
> If you remove API Management from a VNET or change the one it is deployed in, the previously used VNET can remain locked for up to six hours. During this period it will not be possible to delete the VNET or deploy a new resource to it. This behavior is true for clients using api-version 2018-01-01 and earlier. Clients using api-version 2019-01-01 and later, the VNET is freed up as soon as the associated API Management service is deleted.
7982
8083
## <a name="enable-vnet-powershell"> </a>Enable VNET connection using PowerShell cmdlets
81-
You can also enable VNET connectivity using the PowerShell cmdlets
84+
You can also enable VNET connectivity using the PowerShell cmdlets.
8285

8386
* **Create an API Management service inside a VNET**: Use the cmdlet [New-AzApiManagement](/powershell/module/az.apimanagement/new-azapimanagement) to create an Azure API Management service inside a VNET.
8487

0 commit comments

Comments
 (0)