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-api-import-restrictions.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -254,6 +254,9 @@ Namespaces other than the target aren't preserved on export. While you can impor
254
254
### Multiple endpoints
255
255
WSDL files can define multiple services and endpoints (ports) by one or more `wsdl:service` and `wsdl:port` elements. However, the API Management gateway is able to import and proxy requests to only a single service and endpoint. If multiple services or endpoints are defined in the WSDL file, identify the target service name and endpoint when importing the API by using the [wsdlSelector](/rest/api/apimanagement/apis/create-or-update#wsdlselector) property.
256
256
257
+
> [!TIP]
258
+
> If you want to load-balance requests across multiple services and endpoints, consider configuring a [load-balanced backend pool](backends.md#load-balanced-pool-preview).
259
+
257
260
### Arrays
258
261
SOAP-to-REST transformation supports only wrapped arrays shown in the example below:
title: Azure API Management backends | Microsoft Docs
3
-
description: Learn about custom backends in API Management
3
+
description: Learn about custom backends in Azure API Management
4
4
services: api-management
5
5
documentationcenter: ''
6
6
author: dlepow
7
7
editor: ''
8
8
9
9
ms.service: api-management
10
10
ms.topic: article
11
-
ms.date: 08/16/2023
11
+
ms.date: 01/09/2024
12
12
ms.author: danlep
13
13
ms.custom:
14
14
---
@@ -26,9 +26,13 @@ API Management also supports using other Azure resources as an API backend, such
26
26
* A [Service Fabric cluster](how-to-configure-service-fabric-backend.md).
27
27
* A custom service.
28
28
29
-
API Management supports custom backends so you can manage the backend services of your API. Use custom backends, for example, to authorize the credentials of requests to the backend service. Configure and manage custom backends in the Azure portal, or using Azure APIs or tools.
29
+
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:
30
30
31
-
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.
31
+
* Authorize the credentials of requests to the backend service
32
+
* Protect your backend from too many requests
33
+
* Route or load-balance requests to multiple backends
34
+
35
+
Configure and manage custom backends in the Azure portal, or using Azure APIs or tools.
32
36
33
37
## Benefits of backends
34
38
@@ -38,6 +42,43 @@ A custom backend has several benefits, including:
38
42
* Easily used by configuring a transformation policy on an existing API.
39
43
* 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.
40
44
45
+
## Reference backend using set-backend-service policy
46
+
47
+
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:
48
+
49
+
```xml
50
+
<policies>
51
+
<inbound>
52
+
<base />
53
+
<set-backend-servicebackend-id="myBackend" />
54
+
</inbound>
55
+
[...]
56
+
<policies/>
57
+
```
58
+
59
+
You can use conditional logic with the `set-backend-service` policy to change the effective backend based on location, gateway that was called, or other expressions.
60
+
61
+
For example, here is a policy to route traffic to another backend based on the gateway that was called:
Starting in API version 2023-03-01 preview, API Management exposes a [circuit breaker](/rest/api/apimanagement/current-preview/backend/create-or-update?tabs=HTTP#backendcircuitbreaker) property in the backend resource to protect a backend service from being overwhelmed by too many requests.
@@ -50,16 +91,15 @@ The backend circuit breaker is an implementation of the [circuit breaker pattern
50
91
51
92
### Example
52
93
53
-
Use the API Management REST API or a Bicep or ARM template to configure a circuit breaker in a backend. In the following example, the circuit breaker trips when there are three or more `5xx` status codes indicating server errors in a day. The circuit breaker resets after one hour.
94
+
Use the API Management [REST API](/rest/api/apimanagement/backend) or a Bicep or ARM template to configure a circuit breaker in a backend. In the following example, the circuit breaker in *myBackend* in the API Management instance *myAPIM* trips when there are three or more `5xx` status codes indicating server errors in a day. The circuit breaker resets after one hour.
54
95
55
96
#### [Bicep](#tab/bicep)
56
97
57
-
Include a snippet similar to the following in your Bicep template:
98
+
Include a snippet similar to the following in your Bicep template for a backend resource with a circuit breaker:
@@ -122,18 +160,88 @@ Include a JSON snippet similar to the following in your ARM template:
122
160
]
123
161
}
124
162
}
125
-
[...]
126
163
}
127
164
```
128
165
129
166
---
130
167
168
+
## Load-balanced pool (preview)
169
+
170
+
Starting in API version 2023-05-01 preview, API Management supports backend *pools*, when you want to implement multiple backends for an API and load-balance requests across those backends. Currently, the backend pool supports round-robin load balancing.
171
+
172
+
Use a backend pool for scenarios such as the following:
173
+
174
+
* Spread the load to multiple backends, which may have individual backend circuit breakers.
175
+
* Shift the load from one set of backends to another for upgrade (blue-green deployment).
131
176
177
+
To create a backend pool, set the `type` property of the backend to `pool` and specify a list of backends that make up the pool.
178
+
179
+
> [!NOTE]
180
+
> Currently, you can only include single backends in a backend pool. You can't add a backend of type `pool` to another backend pool.
181
+
182
+
### Example
183
+
184
+
Use the API Management [REST API](/rest/api/apimanagement/backend) or a Bicep or ARM template to configure a backend pool. In the following example, the backend *myBackendPool* in the API Management instance *myAPIM* is configured with a backend pool. Example backends in the pool are named *backend-1* and *backend-2*.
185
+
186
+
#### [Bicep](#tab/bicep)
187
+
188
+
Include a snippet similar to the following in your Bicep template for a backend resource with a load-balanced pool:
"description": "Load balancer for multiple backends",
222
+
"type": "Pool",
223
+
"protocol": "http",
224
+
"url": "http://unused",
225
+
"pool": {
226
+
"services": [
227
+
{
228
+
"id": "/backends/backend-1"
229
+
},
230
+
{
231
+
"id": "/backends/backend-2"
232
+
}
233
+
]
234
+
}
235
+
}
236
+
}
237
+
```
238
+
239
+
---
132
240
## Limitation
133
241
134
242
For **Developer** and **Premium** tiers, an API Management instance deployed in an [internal virtual network](api-management-using-with-internal-vnet.md) can throw HTTP 500 `BackendConnectionFailure` errors when the gateway endpoint URL and backend URL are the same. If you encounter this limitation, follow the instructions in the [Self-Chained API Management request limitation in internal virtual network mode](https://techcommunity.microsoft.com/t5/azure-paas-blog/self-chained-apim-request-limitation-in-internal-virtual-network/ba-p/1940417) article in the Tech Community blog.
135
243
136
-
## Next steps
244
+
## Related content
137
245
138
246
* Set up a [Service Fabric backend](how-to-configure-service-fabric-backend.md) using the Azure portal.
139
-
* Backends can also be configured using the API Management [REST API](/rest/api/apimanagement), [Azure PowerShell](/powershell/module/az.apimanagement/new-azapimanagementbackend), or [Azure Resource Manager templates](../service-fabric/service-fabric-tutorial-deploy-api-management.md).
Copy file name to clipboardExpand all lines: articles/azure-monitor/visualize/workbooks-jsonpath.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ In this example, the JSON object represents a store's inventory. We're going to
73
73
74
74
:::image type="content" source="media/workbooks-jsonpath/query-jsonpath.png" alt-text="Screenshot that shows editing a query item with JSON data source and JSON path result format.":::
75
75
76
-
## Use regular expressions to covert values
76
+
## Use regular expressions to convert values
77
77
78
78
You may have some data that isn't in a standard format. To use that data effectively, you would want to convert that data into a standard format.
| noSpeakerDevicesAvailable | there's no audio output device (speaker) on the user's system. | - Set to `True` when there are no speaker devices on the system, and speaker selection is supported. <br/> - Set to `False` when there's a least one speaker device on the system, and speaker selection is supported. | All speakers are unplugged | When value set to `True`, consider giving visual notification to end user that their current call session doesn't have any speakers available. |
35
-
| speakingWhileMicrophoneIsMuted | Speaking while being on mute. | - Set to `True` when local microphone is muted and the local user is speaking. <br/> - Set to `False` when local user either stops speaking, or unmutes the microphone. <br/> \* Note: Currently, this option isn't supported on Safari because the audio level samples are taken from WebRTC stats. | During a call, mute your microphone and speak into it. | When value set to `True` consider giving visual notification to end user that they might be talking and not realizing that their audio is muted. |
35
+
| speakingWhileMicrophoneIsMuted | Speaking while being on mute. | - Set to `True` when local microphone is muted and the local user is speaking. <br/> - Set to `False` when local user either stops speaking, or unmutes the microphone. <br/> - This diagnostic event can be automatically disabled if it is triggered for a certain amount of times without any user action to avoid noise and provide a better user experience. It will be re-enabled again when a new mute action occurs. | During a call, mute your microphone and speak into it. | When value set to `True` consider giving visual notification to end user that they might be talking and not realizing that their audio is muted. |
36
36
| noMicrophoneDevicesAvailable | No audio capture devices (microphone) on the user's system | - Set to `True` when there are no microphone devices on the system. <br/> - Set to `False` when there's at least one microphone device on the system. | All microphones are unplugged during the call. | When value set to `True` consider giving visual notification to end user that their current call session doesn't have a microphone. For more information, see [enable microphone from device manger](../../best-practices.md#plug-in-microphone-or-enable-microphone-from-device-manager-when-azure-communication-services-call-in-progress) section. |
37
37
| microphoneNotFunctioning | Microphone isn't functioning. | - Set to `True` when we fail to start sending local audio stream because the microphone device may have been disabled in the system or it's being used by another process. This UFD takes about 10 seconds to get raised. <br/> - Set to `False` when microphone starts to successfully send audio stream again. | No microphones available, microphone access disabled in a system | When value set to `True` give visual notification to end user that there's a problem with their microphone. |
38
38
| microphoneMuteUnexpectedly | Microphone is muted | - Set to `True` when microphone enters muted state unexpectedly. <br/> - Set to `False` when microphone starts to successfully send audio stream | Microphone is muted from the system. Most cases happen when user is on an Azure Communication Services call on a mobile device and a phone call comes in. In most cases, the operating system mutes the Azure Communication Services call so a user can answer the phone call. | When value is set to `True`, give visual notification to end user that their call was muted because a phone call came in. For more information, see how to best handle [OS muting an Azure Communication Services call](../../best-practices.md#handle-os-muting-call-when-phone-call-comes-in) section for more details. |
0 commit comments