Skip to content

Commit 79cfc1a

Browse files
Freshness.
1 parent fee65dc commit 79cfc1a

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.custom:
1717

1818
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
1919

20-
This tutorial describes how to inspect (trace) request processing in Azure API Management. Tracing helps you debug and troubleshoot your API.
20+
This tutorial describes how to inspect, or *trace*, request processing in Azure API Management. Tracing helps you debug and troubleshoot your API.
2121

2222
[!INCLUDE [api-management-workspace-try-it](../../includes/api-management-workspace-try-it.md)]
2323

@@ -38,7 +38,7 @@ In this tutorial, you learn how to:
3838

3939
[!INCLUDE [api-management-tracing-alert](../../includes/api-management-tracing-alert.md)]
4040

41-
## Trace a call in the portal
41+
## Trace a call in the Azure portal
4242

4343
Follow these steps to trace an API request in the test console in the portal. This example assumes that you [imported](import-and-publish.md) a sample API in a previous tutorial. You can follow similar steps with a different API that you imported.
4444

@@ -52,14 +52,14 @@ Follow these steps to trace an API request in the test console in the portal. Th
5252

5353
> [!TIP]
5454
>
55-
> You can override the value of **Ocp-Apim-Subscription-Key** by retrieving a key for another subscription in the portal. Select **Subscriptions**, and open the context menu (**...**) for another subscription. Select **Show/hide keys** and copy one of the keys. You can also regenerate keys if needed. Then, in the test console, select **+ Add header** to add an **Ocp-Apim-Subscription-Key** header with the new key value.
55+
> You can override the value of **Ocp-Apim-Subscription-Key** by retrieving a key for another subscription in the Azure portal. Select **Subscriptions**, and open the context menu (**...**) for another subscription. Select **Show/hide keys** and copy one of the keys. You can also regenerate keys if needed. Then, in the test console, select **+ Add header** to add an **Ocp-Apim-Subscription-Key** header with the new key value.
5656
5757
1. Select **Trace**.
5858

5959
## Review trace information
6060

6161
1. After the call completes, go to the **Trace*- tab in the **HTTP response**.
62-
1. Select any of the following links to jump to detailed trace info: **Inbound**, **Backend**, **Outbound**, **On error**.
62+
1. Select any of the following links to jump to detailed trace information: **Inbound**, **Backend**, **Outbound**, **On error**.
6363

6464
:::image type="content" source="media/api-management-howto-api-inspector/response-trace-1.png" alt-text="Screenshot showing the review response trace.":::
6565

@@ -88,13 +88,13 @@ Detailed steps follow.
8888
> - These steps require API Management REST API version 2023-05-01-preview or later. You must be assigned the Contributor or higher role on the API Management instance to call the REST API.
8989
> - For information about authenticating to the REST API, see [Azure REST API reference](/rest/api/azure).
9090
91-
1. **Obtain a debug token**. Call the API Management gateway's [List debug credentials](/rest/api/apimanagement/gateway/list-debug-credentials) API. In the URI, enter "managed" for the instance's managed gateway in the cloud, or the gateway ID for a self-hosted gateway. For example, to obtain trace credentials for the instance's managed gateway, use a request similar to the following example:
91+
1. **Obtain a debug token**. Call the API Management gateway's [List debug credentials](/rest/api/apimanagement/gateway/list-debug-credentials) API. In the URI, enter *managed* for the instance's managed gateway in the cloud, or the gateway ID for a self-hosted gateway. For example, to obtain trace credentials for the instance's managed gateway, use a request similar to the following example:
9292

9393
```http
9494
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listDebugCredentials?api-version=2023-05-01-preview
9595
```
9696

97-
In the request body, pass the full resource ID of the API that you want to trace, and specify `purposes` as `tracing`. By default the token credential returned in the response expires after 1 hour, but you can specify a different value in the payload. The expiry time is limited to a maximum of 1 hour. For example:
97+
In the request body, pass the full resource ID of the API that you want to trace. Specify `purposes` as `tracing`. By default, the token credential returned in the response expires after 1 hour. You can specify a different value in the payload. The expiry time is limited to a maximum of 1 hour. For example:
9898

9999
```json
100100
{
@@ -105,7 +105,7 @@ Detailed steps follow.
105105
```
106106

107107
> [!NOTE]
108-
> The `apiId` can only be pulled from the full resource ID, not the name displayed in the portal.
108+
> The `apiId` can only be pulled from the full resource ID, not the name displayed in the Azure portal.
109109
110110
Get apiId:
111111

@@ -156,7 +156,7 @@ Detailed steps follow.
156156

157157
The response body contains the trace data for the previous API request to the gateway. The trace is similar to the trace you can see by tracing a call in the portal's test console.
158158

159-
### Example `.http` file for VS Code REST Client extension
159+
### Example http file for VS Code REST Client extension
160160

161161
To help automate these steps with the [Visual Studio Code REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension, you can use the following example `.http` file:
162162

includes/api-management-tracing-alert.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
author: dlepow
33
ms.service: azure-api-management
44
ms.topic: include
5-
ms.date: 11/04/2024
5+
ms.date: 01/28/2026
66
ms.author: danlep
77
---
88
> [!IMPORTANT]
9-
> * API Management no longer supports subscriptions for tracing or the **Ocp-Apim-Trace** header.
10-
> * To improve API security, tracing can now be enabled at the level of an individual API by obtaining a time-limited token using the API Management REST API, and passing the token in a request to the gateway. For details, see [Enable tracing of an API](../articles/api-management/api-management-howto-api-inspector.md#enable-tracing-for-an-api).
11-
> * Take care when enabling tracing, as it can expose sensitive information in the trace data. Ensure that you have appropriate security measures in place to protect the trace data.
9+
> - API Management no longer supports subscriptions for tracing or the **Ocp-Apim-Trace** header.
10+
> - To improve API security, tracing can now be enabled at the level of an individual API. Obtain a time-limited token using the API Management REST API. Pass the token in a request to the gateway. For details, see [Enable tracing of an API](../articles/api-management/api-management-howto-api-inspector.md#enable-tracing-for-an-api).
11+
> - Take care when enabling tracing. It can expose sensitive information in the trace data. Ensure that you have appropriate security measures in place to protect the trace data.

0 commit comments

Comments
 (0)