Skip to content

Commit aa84820

Browse files
committed
[APIM] Make backend LB and CB more discoverable
1 parent 03840dc commit aa84820

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

articles/api-management/api-management-policies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services: api-management
55
author: dlepow
66
ms.service: api-management
77
ms.topic: article
8-
ms.date: 12/01/2022
8+
ms.date: 03/08/2024
99
ms.author: danlep
1010
---
1111

@@ -86,7 +86,7 @@ More information about policies:
8686
- [Convert XML to JSON](xml-to-json-policy.md) - Converts request or response body from XML to JSON.
8787
- [Find and replace string in body](find-and-replace-policy.md) - Finds a request or response substring and replaces it with a different substring.
8888
- [Mask URLs in content](redirect-content-urls-policy.md) - Rewrites (masks) links in the response body so that they point to the equivalent link via the gateway.
89-
- [Set backend service](set-backend-service-policy.md) - Changes the backend service for an incoming request.
89+
- [Set backend service](set-backend-service-policy.md) - Changes the backend service base URL of an incoming request to a URL or a [backend](backends.md). Referencing a backend resource allows you to manage the backend service base URL and other settings in a single place. Also apply backend properties such as [distributing traffic to a pool of URLs](backends.md#load-balanced-pool-preview) and [circuit breaker rules](backends.md#circuit-breaker-preview) to protect the backend from too many requests.
9090
- [Set body](set-body-policy.md) - Sets the message body for a request or response.
9191
- [Set HTTP header](set-header-policy.md) - Assigns a value to an existing response and/or request header or adds a new response and/or request header.
9292
- [Set query string parameter](set-query-parameter-policy.md) - Adds, replaces value of, or deletes request query string parameter.

articles/api-management/backends.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services: api-management
55
author: dlepow
66
ms.service: api-management
77
ms.topic: article
8-
ms.date: 01/09/2024
8+
ms.date: 03/08/2024
99
ms.author: danlep
1010
ms.custom:
1111
---
@@ -23,22 +23,19 @@ API Management also supports using other Azure resources as an API backend, such
2323
* A [Service Fabric cluster](how-to-configure-service-fabric-backend.md).
2424
* A custom service.
2525

26-
API Management supports custom backends so you can manage the backend services of your API. Use custom backends for one or more of the following:
26+
## Benefits of backends
27+
28+
API Management supports custom backends so you can manage the backend services of your API. A backend resource abstracts information about the backend service, promoting reusability across APIs and improved governance.
29+
30+
Use custom backends for one or more of the following:
2731

2832
* Authorize the credentials of requests to the backend service
33+
* Take advantage of API Management functionality to maintain secrets in Azure Key Vault if [named values](api-management-howto-properties.md) are configured for header or query parameter authentication.
2934
* Protect your backend from too many requests
3035
* Route or load-balance requests to multiple backends
3136

3237
Configure and manage custom backends in the Azure portal, or using Azure APIs or tools.
3338

34-
## Benefits of backends
35-
36-
A custom backend has several benefits, including:
37-
38-
* Abstracts information about the backend service, promoting reusability across APIs and improved governance.
39-
* Easily used by configuring a transformation policy on an existing API.
40-
* Takes advantage of API Management functionality to maintain secrets in Azure Key Vault if [named values](api-management-howto-properties.md) are configured for header or query parameter authentication.
41-
4239
## Reference backend using set-backend-service policy
4340

4441
After creating a backend, you can reference the backend in your APIs. Use the [`set-backend-service`](set-backend-service-policy.md) policy to direct an incoming API request to the custom backend. If you already configured a backend web service for an API, you can use the `set-backend-service` policy to redirect the request to a custom backend instead of the default backend web service configured for that API. For example:

articles/api-management/set-backend-service-policy.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ author: dlepow
66

77
ms.service: api-management
88
ms.topic: article
9-
ms.date: 12/02/2022
9+
ms.date: 03/08/2024
1010
ms.author: danlep
1111
---
1212

1313
# Set backend service
1414
Use the `set-backend-service` policy to redirect an incoming request to a different backend than the one specified in the API settings for that operation. This policy changes the backend service base URL of the incoming request to a URL or [backend](backends.md) specified in the policy.
1515

16+
Referencing a backend entity allows you to manage the backend service base URL and other settings in a single place and reuse them across multiple APIs and operations. Also apply backend properties such as [distributing traffic to a pool of URLs](backends.md#load-balanced-pool-preview) and [circuit breaker rules](backends.md#circuit-breaker-preview) to protect the backend from too many requests.
17+
1618
> [!NOTE]
1719
> Backend entities can be managed via [Azure portal](how-to-configure-service-fabric-backend.md), management [API](/rest/api/apimanagement), and [PowerShell](https://www.powershellgallery.com/packages?q=apimanagement).
1820

0 commit comments

Comments
 (0)