You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/api-management-policies.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ services: api-management
5
5
author: dlepow
6
6
ms.service: api-management
7
7
ms.topic: article
8
-
ms.date: 12/01/2022
8
+
ms.date: 03/08/2024
9
9
ms.author: danlep
10
10
---
11
11
@@ -86,7 +86,7 @@ More information about policies:
86
86
-[Convert XML to JSON](xml-to-json-policy.md) - Converts request or response body from XML to JSON.
87
87
-[Find and replace string in body](find-and-replace-policy.md) - Finds a request or response substring and replaces it with a different substring.
88
88
-[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 implement [load balancing of traffic across a pool of backend services](backends.md#load-balanced-pool-preview) and [circuit breaker rules](backends.md#circuit-breaker-preview) to protect the backend from too many requests.
90
90
-[Set body](set-body-policy.md) - Sets the message body for a request or response.
91
91
-[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.
92
92
-[Set query string parameter](set-query-parameter-policy.md) - Adds, replaces value of, or deletes request query string parameter.
Copy file name to clipboardExpand all lines: articles/api-management/backends.md
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
2
title: Azure API Management backends | Microsoft Docs
3
-
description: Learn about custom backends in Azure API Management
3
+
description: Learn about backends in Azure API Management. A backend entity encapsulates information about the backend service, promoting reusability across APIs and improved governance.
4
4
services: api-management
5
5
author: dlepow
6
6
ms.service: api-management
7
7
ms.topic: article
8
-
ms.date: 01/09/2024
8
+
ms.date: 03/14/2024
9
9
ms.author: danlep
10
10
ms.custom:
11
11
---
@@ -23,25 +23,22 @@ API Management also supports using other Azure resources as an API backend, such
23
23
* A [Service Fabric cluster](how-to-configure-service-fabric-backend.md).
24
24
* A custom service.
25
25
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
27
28
-
* Authorize the credentials of requests to the backend service
29
-
* Protect your backend from too many requests
30
-
* Route or load-balance requests to multiple backends
28
+
API Management supports backend entities so you can manage the backend services of your API. A backend entity encapsulates information about the backend service, promoting reusability across APIs and improved governance.
31
29
32
-
Configure and manage custom backends in the Azure portal, or using Azure APIs or tools.
30
+
Use backends for one or more of the following:
33
31
34
-
## Benefits of backends
35
-
36
-
A custom backend has several benefits, including:
32
+
* 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.
34
+
* Define circuit breaker rules to protect your backend from too many requests
35
+
* Route or load-balance requests to multiple backends
37
36
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.
37
+
Configure and manage backend entities in the Azure portal, or using Azure APIs or tools.
41
38
42
39
## Reference backend using set-backend-service policy
43
40
44
-
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:
41
+
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 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 backend entity instead. For example:
Copy file name to clipboardExpand all lines: articles/api-management/high-availability.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Learn how to use Azure reliability features including availability
5
5
author: dlepow
6
6
ms.service: api-management
7
7
ms.topic: conceptual
8
-
ms.date: 06/28/2023
8
+
ms.date: 03/08/2024
9
9
ms.author: danlep
10
10
ms.custom: engagement-fy23
11
11
---
@@ -62,7 +62,11 @@ API Management provides an SLA of 99.99% when you deploy at least one unit in tw
62
62
63
63
## Backend availability
64
64
65
-
Depending on where and how your backend services are hosted, you may need to set up redundant backends in different regions to meet your requirements for service availability. You can manage regional backends and handle failover through API Management to maintain availability. For example:
65
+
Depending on where and how your backend services are hosted, you may need to set up redundant backends in different regions to meet your requirements for service availability. You can also configure backend properties to improve the resilience and availability of your backend services.
66
+
67
+
### Regional backends
68
+
69
+
You can manage regional backends and handle failover through API Management to maintain availability. For example:
66
70
67
71
* In multi-region deployments, use [policies to route requests](api-management-howto-deploy-multi-region.md#-route-api-calls-to-regional-backend-services) through regional gateways to regional backends.
68
72
@@ -72,6 +76,13 @@ Depending on where and how your backend services are hosted, you may need to set
72
76
73
77
For details, see the blog post [Back-end API redundancy with Azure API Manager](https://devblogs.microsoft.com/premier-developer/back-end-api-redundancy-with-azure-api-manager/).
74
78
79
+
### Configure backend properties for availability
80
+
81
+
API Management [backend](backends.md) entities allow you to manage and apply backend properties to improve the availability of backends. For example:
82
+
83
+
* Distribute and load-balance traffic to a [pool of URLs](backends.md#load-balanced-pool-preview)
84
+
* Configure [circuit breaker rules](backends.md#circuit-breaker-preview) to apply the circuit breaker pattern to protect the backend from too many requests
85
+
75
86
## Next steps
76
87
77
88
* Learn more about [reliability in Azure](../reliability/overview.md)
Copy file name to clipboardExpand all lines: articles/api-management/set-backend-service-policy.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,15 @@ author: dlepow
6
6
7
7
ms.service: api-management
8
8
ms.topic: article
9
-
ms.date: 12/02/2022
9
+
ms.date: 03/14/2024
10
10
ms.author: danlep
11
11
---
12
12
13
13
# Set backend service
14
14
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.
15
15
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 implement [load balancing of traffic across a pool of backend services](backends.md#load-balanced-pool-preview) and [circuit breaker rules](backends.md#circuit-breaker-preview) to protect the backend from too many requests.
17
+
16
18
> [!NOTE]
17
19
> 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).
0 commit comments