Skip to content

Commit 503f061

Browse files
Merge branch 'MicrosoftDocs:main' into main
2 parents 9eed572 + 459ceb9 commit 503f061

File tree

72 files changed

+675
-3316
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+675
-3316
lines changed

articles/api-management/api-management-howto-aad.md

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Learn how to enable user sign-in to the API Management developer po
66
author: dlepow
77
ms.service: azure-api-management
88
ms.topic: article
9-
ms.date: 12/08/2023
9+
ms.date: 09/19/2024
1010
ms.author: danlep
1111
ms.custom: engagement-fy23, devx-track-azurecli
1212
---
@@ -76,14 +76,7 @@ After the Microsoft Entra provider is enabled:
7676
1. Save the **Redirect URL** for later.
7777

7878
:::image type="content" source="media/api-management-howto-aad/api-management-with-aad001.png" alt-text="Screenshot of adding identity provider in Azure portal.":::
79-
80-
> [!NOTE]
81-
> There are two redirect URLs:<br/>
82-
> * **Redirect URL** points to the latest developer portal of the API Management.
83-
> * **Redirect URL (deprecated portal)** points to the deprecated developer portal of API Management.
84-
>
85-
> We recommended you use the latest developer portal Redirect URL.
86-
79+
8780
1. In your browser, open the Azure portal in a new tab.
8881
1. Navigate to [App registrations](https://go.microsoft.com/fwlink/?linkid=2083908) to register an app in Active Directory.
8982
1. Select **New registration**. On the **Register an application** page, set the values as follows:
@@ -104,9 +97,6 @@ After the Microsoft Entra provider is enabled:
10497
* Select any option for **Expires**.
10598
* Choose **Add**.
10699
1. Copy the client **Secret value** before leaving the page. You will need it later.
107-
1. Under **Manage** in the side menu, select **Authentication**.
108-
1. Under the **Implicit grant and hybrid flows** section, select the **ID tokens** checkbox.
109-
1. Select **Save**.
110100
1. Under **Manage** in the side menu, select **Token configuration** > **+ Add optional claim**.
111101
1. In **Token type**, select **ID**.
112102
1. Select (check) the following claims: **email**, **family_name**, **given_name**.
@@ -117,21 +107,14 @@ After the Microsoft Entra provider is enabled:
117107
> [!IMPORTANT]
118108
> Update the **Client secret** before the key expires.
119109
120-
1. In the **Add identity provider** pane's **Allowed tenants** field, specify the Microsoft Entra instance's domains to which you want to grant access to the API Management service instance APIs.
121-
* You can separate multiple domains with newlines, spaces, or commas.
122-
123-
> [!NOTE]
124-
> You can specify multiple domains in the **Allowed Tenants** section. A global administration must grant the application access to directory data before users can sign in from a different domain than the original app registration domain. To grant permission, the global administrator should:
125-
> 1. Go to `https://<URL of your developer portal>/aadadminconsent` (for example, `https://contoso.portal.azure-api.net/aadadminconsent`).
126-
> 1. Enter the domain name of the Microsoft Entra tenant to which they want to grant access.
127-
> 1. Select **Submit**.
128-
110+
1. In **Signin tenant**, specify a tenant name or ID to use for sign-in to Microsoft Entra. If no value is specified, the Common endpoint is used.
111+
1. In **Allowed tenants**, add specific Microsoft Entra tenant names or IDs for sign-in to Microsoft Entra.
129112
1. After you specify the desired configuration, select **Add**.
130113
1. Republish the developer portal for the Microsoft Entra configuration to take effect. In the left menu, under **Developer portal**, select **Portal overview** > **Publish**.
131114

132115
After the Microsoft Entra provider is enabled:
133116

134-
* Users in the specified Microsoft Entra instance can [sign into the developer portal by using a Microsoft Entra account](#log_in_to_dev_portal).
117+
* Users in the specified Microsoft Entra tenant(s) can [sign into the developer portal by using a Microsoft Entra account](#log_in_to_dev_portal).
135118
* You can manage the Microsoft Entra configuration on the **Developer portal** > **Identities** page in the portal.
136119
* Optionally configure other sign-in settings by selecting **Identities** > **Settings**. For example, you might want to redirect anonymous users to the sign-in page.
137120
* Republish the developer portal after any configuration change.
@@ -160,7 +143,7 @@ For steps, see [Switch redirect URIs to the single-page application type](../act
160143
## Add an external Microsoft Entra group
161144

162145
Now that you've enabled access for users in a Microsoft Entra tenant, you can:
163-
* Add Microsoft Entra groups into API Management.
146+
* Add Microsoft Entra groups into API Management. Groups added must be in the tenant where your API Management instance is deployed.
164147
* Control product visibility using Microsoft Entra groups.
165148

166149
1. Navigate to the App Registration page for the application you registered in [the previous section](#enable-user-sign-in-using-azure-ad---portal).
-21.1 KB
Loading

articles/api-management/private-endpoint.md

Lines changed: 27 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ms.service: azure-api-management
55
author: dlepow
66
ms.author: danlep
77
ms.topic: how-to
8-
ms.date: 03/20/2023
8+
ms.date: 09/19/2024
99
---
1010

1111
# Connect privately to API Management using an inbound private endpoint
@@ -33,10 +33,11 @@ You can configure an inbound [private endpoint](../private-link/private-endpoint
3333
## Prerequisites
3434

3535
- An existing API Management instance. [Create one if you haven't already](get-started-create-service-instance.md).
36-
- The API Management instance must be hosted on the [`stv2` compute platform](compute-infrastructure.md). For example, create a new instance or, if you already have an instance in the Premium service tier, enable [zone redundancy](../reliability/migrate-api-mgt.md).
36+
- The API Management instance must be hosted on the [`stv2` compute platform](compute-infrastructure.md).
3737
- Do not deploy (inject) the instance into an [external](api-management-using-with-vnet.md) or [internal](api-management-using-with-internal-vnet.md) virtual network.
3838
- A virtual network and subnet to host the private endpoint. The subnet may contain other Azure resources.
3939
- (Recommended) A virtual machine in the same or a different subnet in the virtual network, to test the private endpoint.
40+
[!INCLUDE [azure-cli-prepare-your-environment-no-header.md](~/reusable-content/azure-cli/azure-cli-prepare-your-environment-no-header.md)]
4041

4142
## Approval method for private endpoint
4243

@@ -94,11 +95,11 @@ When you use the Azure portal to create a private endpoint, as shown in the next
9495

9596
1. Navigate to your API Management service in the [Azure portal](https://portal.azure.com/).
9697

97-
1. In the left-hand menu, select **Network**.
98+
1. In the left-hand menu, under **Deployment + infrastructure**, select **Network**.
9899

99100
1. Select **Inbound private endpoint connections** > **+ Add endpoint**.
100101

101-
:::image type="content" source="media/private-endpoint/add-endpoint-from-instance.png" alt-text="Add a private endpoint using Azure portal":::
102+
:::image type="content" source="media/private-endpoint/add-endpoint-from-instance.png" alt-text="Screenshot showing how to add a private endpoint using the Azure portal.":::
102103

103104
1. In the **Basics** tab of **Create a private endpoint**, enter or select the following information:
104105

@@ -112,16 +113,16 @@ When you use the Azure portal to create a private endpoint, as shown in the next
112113
| Network Interface Name | Enter a name for the network interface, such as *myInterface* |
113114
| Region | Select a location for the private endpoint. It must be in the same region as your virtual network. It may differ from the region where your API Management instance is hosted. |
114115

115-
1. Select the **Resource** tab or the **Next: Resource** button at the bottom of the page. The following information about your API Management instance is already populated:
116+
1. Select the **Next: Resource** button at the bottom of the screen. The following information about your API Management instance is already populated:
116117
* Subscription
117-
* Resource group
118+
* Resource type
118119
* Resource name
119120

120121
1. In **Resource**, in **Target sub-resource**, select **Gateway**.
121122

122-
:::image type="content" source="media/private-endpoint/create-private-endpoint.png" alt-text="Create a private endpoint in Azure portal":::
123+
:::image type="content" source="media/private-endpoint/create-private-endpoint.png" alt-text="Screenshot showing settings to create a private endpoint in the Azure portal.":::
123124

124-
1. Select the **Virtual Network** tab or the **Next: Virtual Network** button at the bottom of the screen.
125+
1. Select the **Next: Virtual Network** button at the bottom of the screen.
125126

126127
1. In **Networking**, enter or select this information:
127128

@@ -132,7 +133,7 @@ When you use the Azure portal to create a private endpoint, as shown in the next
132133
| Private IP configuration | In most cases, select **Dynamically allocate IP address.** |
133134
| Application security group | Optionally select an [application security group](../virtual-network/application-security-groups.md). |
134135

135-
1. Select the **DNS** tab or the **Next: DNS** button at the bottom of the screen.
136+
1. Select the **Next: DNS** button at the bottom of the screen.
136137

137138
1. In **Private DNS integration**, enter or select this information:
138139

@@ -143,18 +144,15 @@ When you use the Azure portal to create a private endpoint, as shown in the next
143144
| Resource group | Select your resource group. |
144145
| Private DNS zones | The default value is displayed: **(new) privatelink.azure-api.net**.
145146

146-
1. Select the **Tags** tab or the **Next: Tabs** button at the bottom of the screen. If you desire, enter tags to organize your Azure resources.
147+
1. Select the **Next: Tabs** button at the bottom of the screen. If you desire, enter tags to organize your Azure resources.
147148

148-
1. Select **Review + create**.
149+
1. Select the **Next: Review + create** button at the bottom of the screen.
149150

150151
1. Select **Create**.
151152

152153
### List private endpoint connections to the instance
153154

154-
After the private endpoint is created, it appears in the list on the API Management instance's **Inbound private endpoint connections** page in the portal.
155-
156-
You can also use the [Private Endpoint Connection - List By Service](/rest/api/apimanagement/current-ga/private-endpoint-connection/list-by-service) REST API to list private endpoint connections to the service instance.
157-
155+
After the private endpoint is created and the service updated, it appears in the list on the API Management instance's **Inbound private endpoint connections** page in the portal.
158156

159157

160158
Note the endpoint's **Connection status**:
@@ -166,47 +164,34 @@ Note the endpoint's **Connection status**:
166164

167165
If a private endpoint connection is in pending status, an owner of the API Management instance must manually approve it before it can be used.
168166

169-
If you have sufficient permissions, approve a private endpoint connection on the API Management instance's **Private endpoint connections** page in the portal.
167+
If you have sufficient permissions, approve a private endpoint connection on the API Management instance's **Private endpoint connections** page in the portal. In the connection's context (...) menu, select **Approve**.
170168

171-
You can also use the API Management [Private Endpoint Connection - Create Or Update](/rest/api/apimanagement/current-ga/private-endpoint-connection/create-or-update) REST API.
172-
173-
```rest
174-
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{apimServiceName}privateEndpointConnections/{privateEndpointConnectionName}?api-version=2021-08-01
175-
```
169+
You can also use the API Management [Private Endpoint Connection - Create Or Update](/rest/api/apimanagement/private-endpoint-connection/create-or-update) REST API to approve pending private endpoint connectionis.
176170

177171
### Optionally disable public network access
178172

179-
To optionally limit incoming traffic to the API Management instance only to private endpoints, disable public network access. Use the [API Management Service - Create Or Update](/rest/api/apimanagement/current-ga/api-management-service/create-or-update) REST API to set the `publicNetworkAccess` property to `Disabled`.
173+
To optionally limit incoming traffic to the API Management instance only to private endpoints, disable public network access.
180174

181175
> [!NOTE]
182-
> The `publicNetworkAccess` property can only be used to disable public access to API Management instances configured with a private endpoint, not with other networking configurations such as VNet injection.
176+
> Public network access can only be disabled in API Management instances configured with a private endpoint, not with other networking configurations such as VNet injection.
183177
184-
```rest
185-
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{apimServiceName}?api-version=2021-08-01
186-
Authorization: Bearer {{authToken.response.body.access_token}}
187-
Content-Type: application/json
178+
To disable public network access using the Azure CLI, run the following [az apim update](/cli/azure/apim#az-apim-update) command, substituting the names of your API Management instance and resource group:
188179

180+
```azurecli
181+
az apim update --name my-apim-service --resource-group my-resource-group --public-network-access false
189182
```
190-
Use the following JSON body:
191-
192-
```json
193-
{
194-
[...]
195-
"properties": {
196-
"publicNetworkAccess": "Disabled"
197-
}
198-
}
199-
```
183+
184+
You can also use the [API Management Service - Update](/rest/api/apimanagement/api-management-service/update) REST API to disable public network access, by setting the `publicNetworkAccess` property to `Disabled`.
200185

201186
## Validate private endpoint connection
202187

203188
After the private endpoint is created, confirm its DNS settings in the portal:
204189

205190
1. Navigate to your API Management service in the [Azure portal](https://portal.azure.com/).
206191

207-
1. In the left-hand menu, select **Network** > **Inbound private endpoint connections**, and select the private endpoint you created.
192+
1. In the left-hand menu, under **Deployment + infrastructure**, select **Network** > **Inbound private endpoint connections**, and select the private endpoint you created.
208193

209-
1. In the left-hand navigation, select **DNS configuration**.
194+
1. In the left-hand navigation, under **Settings**, select **DNS configuration**.
210195

211196
1. Review the DNS records and IP address of the private endpoint. The IP address is a private address in the address space of the subnet where the private endpoint is configured.
212197

@@ -226,19 +211,19 @@ API calls initiated within the virtual network to the default Gateway endpoint s
226211

227212
### Test from internet
228213

229-
From outside the private endpoint path, attempt to call the API Management instance's default Gateway endpoint. If public access is disabled, output will include an error with status code `403` and a message similar to:
214+
From outside the private endpoint path, attempt to call the API Management instance's default Gateway endpoint. If public access is disabled, output includes an error with status code `403` and a message similar to:
230215

231216
```
232217
Request originated from client public IP address xxx.xxx.xxx.xxx, public network access on this 'Microsoft.ApiManagement/service/my-apim-service' is disabled.
233218
234219
To connect to 'Microsoft.ApiManagement/service/my-apim-service', please use the Private Endpoint from inside your virtual network.
235220
```
236221

237-
## Next steps
222+
## Related content
238223

239224
* Use [policy expressions](api-management-policy-expressions.md#ref-context-request) with the `context.request` variable to identify traffic from the private endpoint.
240225
* Learn more about [private endpoints](../private-link/private-endpoint-overview.md) and [Private Link](../private-link/private-link-overview.md), including [Private Link pricing](https://azure.microsoft.com/pricing/details/private-link/).
241-
* Learn more about [managing private endpoint connections](../private-link/manage-private-endpoint.md).
226+
* [Manage private endpoint connections](../private-link/manage-private-endpoint.md).
242227
* [Troubleshoot Azure private endpoint connectivity problems](../private-link/troubleshoot-private-endpoint-connectivity.md).
243228
* Use a [Resource Manager template](https://azure.microsoft.com/resources/templates/api-management-private-endpoint/) to create an API Management instance and a private endpoint with private DNS integration.
244229

0 commit comments

Comments
 (0)