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/active-directory-b2c/client-credentials-grant-flow.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
@@ -152,7 +152,7 @@ There are no specific actions to enable the client credentials for user flows or
152
152
| grant_type |`client_credentials`|
153
153
| client_id | The **Client ID** from the [Step 2 Register an application](#step-2-register-an-application). |
154
154
| client_secret | The **Client secret** value from [Step 2.1 Create a client secret](#step-21-create-a-client-secret). |
155
-
| scope | The **Application ID URI** from [Step 1.1 Define web API roles (scopes)](#step-11-define-web-api-roles-scopes) and `.default`. For example `https://contoso.onmicrosoft.com/api/.default`, or `https://contoso.onmicrosoft.com/00001111-aaaa-2222-bbbb-3333cccc4444/.default`.|
155
+
| scope | The **Application ID URI** from [Step 1.1 Define web API roles (scopes)](#step-11-define-web-api-roles-scopes) and `.default`. For example `https://contoso.onmicrosoft.com/api/.default`, or `https://contoso.onmicrosoft.com/aaaabbbb-0000-cccc-1111-dddd2222eeee/.default`.|
156
156
157
157
The actual POST request looks like the following example:
Copy file name to clipboardExpand all lines: articles/active-directory-b2c/partner-dynamics-365-fraud-protection.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
@@ -117,7 +117,7 @@ In the provided [custom policies](https://github.com/azure-ad-b2c/partner-integr
117
117
|{Settings:FacebookClientId}|App ID of the Facebook app you configured for federation with B2C|`000000000000000`|
118
118
|{Settings:FacebookClientSecretKeyContainer}| Name of the policy key, in which you saved Facebook's app secret |`B2C_1A_FacebookAppSecret`|
119
119
|{Settings:ContentDefinitionBaseUri}|Endpoint in where you deployed the UI files|`https://<my-storage-account>.blob.core.windows.net/<my-storage-container>`|
120
-
|{Settings:DfpApiBaseUrl}|The base path for your DFP API instance, found in the DFP portal|`https://tenantname-00001111-aaaa-2222-bbbb-3333cccc4444.api.dfp.dynamics.com/v1.0/`|
120
+
|{Settings:DfpApiBaseUrl}|The base path for your DFP API instance, found in the DFP portal|`https://tenantname-aaaabbbb-0000-cccc-1111-dddd2222eeee.api.dfp.dynamics.com/v1.0/`|
121
121
|{Settings:DfpApiAuthScope}|The client_credentials scope for the DFP API service|`https://api.dfp.dynamics-int.com/.default or https://api.dfp.dynamics.com/.default`|
122
122
|{Settings:DfpTenantId}|The ID of the Microsoft Entra tenant (not B2C) where DFP is licensed and installed|`00001111-aaaa-2222-bbbb-3333cccc4444` or `contoso.onmicrosoft.com`|
123
123
|{Settings:DfpAppClientIdKeyContainer}|Name of the policy key-in which you save the DFP client ID|`B2C_1A_DFPClientId`|
Copy file name to clipboardExpand all lines: articles/active-directory-b2c/partner-onfido.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
@@ -128,7 +128,7 @@ In [/samples/OnFido-Combined/Policies](https://github.com/azure-ad-b2c/partner-i
128
128
|{your_tenant_IdentityExperienceFramework_appid}|IdentityExperienceFramework app App ID configured in your Azure AD B2C tenant|00001111-aaaa-2222-bbbb-3333cccc4444|
129
129
|{your_tenant_ ProxyIdentityExperienceFramework_appid}|ProxyIdentityExperienceFramework app App ID configured in your Azure AD B2C tenant| 00001111-aaaa-2222-bbbb-3333cccc4444|
This article provides information about the roles and features of the API Management *gateway* component and compares the gateways you can deploy.
19
+
This article describes the roles and features of the API Management *gateway* component. It also compares the gateways you can deploy.
20
20
21
21
Related information:
22
22
@@ -34,21 +34,21 @@ The API Management *gateway* (also called *data plane* or *runtime*) is the serv
34
34
35
35
36
36
> [!NOTE]
37
-
> All requests to the API Management gateway, including those rejected by policy configurations, count toward configured rate limits, quotas, and billing limits if applied in the service tier.
37
+
> All requests to the API Management gateway, including those rejected by policy configurations, count toward configured rate limits, quotas, and billing limits if the service tier applies them.
38
38
39
39
40
-
## Managed and self-hosted
40
+
## Managed and self-hosted gateways
41
41
42
42
API Management offers both managed and self-hosted gateways:
43
43
44
-
***Managed** - The managed gateway is the default gateway component that is deployed in Azure for every API Management instance in every service tier. A standalone managed gateway can also be associated with a [workspace](workspaces-overview.md) in an API Management instance. With the managed gateway, all API traffic flows through Azure regardless of where backends implementing the APIs are hosted.
44
+
***Managed** - The managed gateway is the default gateway component that Azure deploys for every API Management instance in every service tier. You can also associate a standalone managed gateway with a [workspace](workspaces-overview.md) in an API Management instance in select service tiers. By using the managed gateway, all API traffic flows through Azure regardless of where backends implementing the APIs are hosted.
45
45
46
46
> [!NOTE]
47
47
> Because of differences in the underlying service architecture, the gateways provided in the different API Management service tiers have some differences in capabilities. For details, see the section [Feature comparison: Managed versus self-hosted gateways](#feature-comparison-managed-versus-self-hosted-gateways).
48
48
>
49
49
50
50
51
-
***Self-hosted** - The [self-hosted gateway](self-hosted-gateway-overview.md) is an optional, containerized version of the default managed gateway that is available in select service tiers. It's useful for hybrid and multicloud scenarios where there's a requirement to run the gateways off of Azure in the same environments where API backends are hosted. The self-hosted gateway enables customers with hybrid IT infrastructure to manage APIs hosted on-premises and across clouds from a single API Management service in Azure.
51
+
***Self-hosted** - The [self-hosted gateway](self-hosted-gateway-overview.md) is an optional, containerized version of the default managed gateway that's available in select service tiers. It's useful for hybrid and multicloud scenarios where there's a requirement to run the gateways off of Azure in the same environments where API backends are hosted. The self-hosted gateway enables customers with hybrid IT infrastructure to manage APIs hosted on-premises and across clouds from a single API Management service in Azure.
52
52
53
53
* The self-hosted gateway is [packaged](self-hosted-gateway-overview.md#packaging) as a Linux-based Docker container and is commonly deployed to Kubernetes, including to [Azure Kubernetes Service](how-to-deploy-self-hosted-gateway-azure-kubernetes-service.md) and [Azure Arc-enabled Kubernetes](how-to-deploy-self-hosted-gateway-azure-arc.md).
54
54
@@ -66,7 +66,7 @@ The following tables compare features available in the following API Management
66
66
67
67
> [!NOTE]
68
68
> * Some features of managed and self-hosted gateways are supported only in certain [service tiers](api-management-features.md) or with certain [deployment environments](self-hosted-gateway-overview.md#packaging) for self-hosted gateways.
69
-
> *For the current supported features of the self-hosted gateway, ensure that you have upgraded to the latest major version of the self-hosted gateway [container image](self-hosted-gateway-overview.md#container-images).
69
+
> *To see the current supported features of the self-hosted gateway, make sure you upgraded to the latest major version of the self-hosted gateway [container image](self-hosted-gateway-overview.md#container-images).
70
70
> * See also self-hosted gateway [limitations](self-hosted-gateway-overview.md#limitations).
71
71
72
72
### Infrastructure
@@ -90,7 +90,7 @@ The following tables compare features available in the following API Management
90
90
91
91
<sup>1</sup> Depends on how the gateway is deployed, but is the responsibility of the customer.<br/>
92
92
<sup>2</sup> Connectivity to the self-hosted gateway v2 [configuration endpoint](self-hosted-gateway-overview.md#fqdn-dependencies) requires DNS resolution of the endpoint hostname.<br/>
93
-
<sup>3</sup> CA root certificates for self-hosted gateway are managed separately per gateway<br/>
93
+
<sup>3</sup> CA root certificates for self-hosted gateway are managed separately per gateway.<br/>
94
94
<sup>4</sup> Client protocol needs to be enabled.<br/>
95
95
<sup>5</sup> Configure using the [forward-request](forward-request-policy.md) policy.<br/>
96
96
<sup>6</sup> Configure CA certificate details for backend certificate authentication in [backend](backends.md) settings.
@@ -154,7 +154,7 @@ For details about monitoring options, see [Observability in Azure API Management
<sup>1</sup> The v2 tiers support Azure Monitor-based analytics.<br/>
157
-
<sup>2</sup> Gateway uses [Azure Application Insight's built-in memory buffer](/azure/azure-monitor/app/telemetry-channels#built-in-telemetry-channels) and does not provide delivery guarantees.<br/>
157
+
<sup>2</sup> Gateway uses [Azure Application Insight's built-in memory buffer](/azure/azure-monitor/app/telemetry-channels#built-in-telemetry-channels) and doesn't provide delivery guarantees.<br/>
158
158
<sup>3</sup> The self-hosted gateway currently doesn't send resource logs (diagnostic logs) to Azure Monitor. Optionally [send metrics](how-to-configure-cloud-metrics-logs.md) to Azure Monitor, or [configure and persist logs locally](how-to-configure-local-metrics-logs.md) where the self-hosted gateway is deployed.<br/>
159
159
160
160
### Authentication and authorization
@@ -169,17 +169,17 @@ Managed and self-hosted gateways support all available [API authentication and a
169
169
## Gateway throughput and scaling
170
170
171
171
> [!IMPORTANT]
172
-
> Throughput is affected by the number and rate of concurrent client connections, the kind and number of configured policies, payload sizes, backend API performance, and other factors. Self-hosted gateway throughput is also dependent on the compute capacity (CPU and memory) of the host where it runs. Perform gateway load testing using anticipated production conditions to determine expected throughput accurately.
172
+
> Throughput depends on many factors, including the number and rate of concurrent client connections, the kind and number of configured policies, payload sizes, backend API performance, and other factors. Self-hosted gateway throughput also depends on the compute capacity (CPU and memory) of the host where it runs. To accurately determine expected throughput, perform gateway load testing by using anticipated production conditions.
173
173
174
174
### Managed gateway
175
175
176
176
For estimated maximum gateway throughput in the API Management service tiers, see [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/).
177
177
178
178
> [!IMPORTANT]
179
-
> Throughput figures are presented for information only and must not be relied upon for capacity and budget planning. See [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/) for details.
179
+
> Use the throughput figures for information only. Don't rely on them for capacity and budget planning. See [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/) for details.
180
180
181
181
***Classic tiers**
182
-
* Scale gateway capacity by adding and removing scale [units](upgrade-and-scale.md), or upgrade the service tier. (Scaling not available in the Developer tier.)
182
+
* Scale gateway capacity by adding and removing scale [units](upgrade-and-scale.md), or upgrade the service tier. (Scaling isn't available in the Developer tier.)
183
183
* In the Basic, Standard, and Premium tiers, optionally configure [Azure Monitor autoscale](api-management-howto-autoscale.md).
184
184
* In the Premium tier, optionally add and distribute gateway capacity across multiple [regions](api-management-howto-deploy-multi-region.md).
185
185
@@ -198,6 +198,19 @@ For estimated maximum gateway throughput in the API Management service tiers, se
198
198
199
199
Scale capacity by adding and removing scale [units](upgrade-and-scale.md) in the workspace gateway.
200
200
201
+
## Gateway health check endpoint
202
+
203
+
In all tiers except the Consumption tier, Azure API Management provides a built-in gateway health check endpoint at path `/status-0123456789abcdef`. Reach this endpoint to help confirm that the API gateway is available and functioning correctly. It doesn't test backend APIs, only the gateway itself.
204
+
205
+
A request to the endpoint returns a `200 OK` HTTP response when the gateway is healthy; failures indicate networking or gateway issues.
206
+
207
+
* Azure uses this endpoint internally for continuous SLA monitoring and gateway health validation.
208
+
* Customers can integrate requests to this endpoint into their own monitoring tools and probes.
209
+
* The endpoint is available for managed gateways (including regional gateways in multi-region deployments), self-hosted gateways, and workspace gateways.
210
+
211
+
> [!TIP]
212
+
> When you [integrate Azure Application Insights](api-management-howto-app-insights.md) with API Management, you can optionally enable availability monitoring of the gateway. This setting regularly polls the gateway health check endpoint and reports results on the **Availability** tab in Application Insights.
0 commit comments