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-howto-api-inspector.md
+19-9Lines changed: 19 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ author: dlepow
7
7
editor: ''
8
8
ms.service: api-management
9
9
ms.topic: tutorial
10
-
ms.date: 12/10/2021
10
+
ms.date: 08/08/2022
11
11
ms.author: danlep
12
12
ms.custom: devdivchpfy22
13
13
---
@@ -32,9 +32,14 @@ In this tutorial, you learn how to:
32
32
33
33
## Verify allow tracing setting
34
34
35
-
The **Allow tracing** setting for the subscription used for your API must be enabled. If you're using the built-in all-access subscription, it's enabled by default. To verify in the portal, navigate to your API Management instance and select **Subscriptions**.
35
+
To trace request processing, you must enable the **Allow tracing** setting for the subscription used to debug your API. To check in the portal:
36
+
37
+
1. Navigate to your API Management instance and select **Subscriptions** to review the settings.
36
38
37
39
:::image type="content" source="media/api-management-howto-api-inspector/allow-tracing-1.png" alt-text="Allow tracing for subscription":::
40
+
1. If tracing isn't enabled for the subscription you're using, select the subscription and enable **Allow tracing**.
@@ -43,18 +48,21 @@ The **Allow tracing** setting for the subscription used for your API must be ena
43
48
1. Select **Demo Conference API** from your API list.
44
49
1. Select the **Test** tab.
45
50
1. Select the **GetSpeakers** operation.
46
-
1. Confirm that the HTTP request header includes **Ocp-Apim-Trace: True** and a valid value for **Ocp-Apim-Subscription-Key**. If it doesn't, select **+ Add header** to add the header.
47
-
1. Select **Send** to make an API call.
51
+
1. Optionally check the value for the **Ocp-Apim-Subscription-Key** header used in the request by selecting the "eye" icon.
52
+
> [!TIP]
53
+
> 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.
48
54
49
-
:::image type="content" source="media/api-management-howto-api-inspector/06-debug-your-apis-01-trace-call-1.png" alt-text="Configure API tracing":::
55
+
1. Select **Trace**.
50
56
51
-
> [!TIP]
52
-
> If **Ocp-Apim-Subscription-Key** isn't automatically populated in the HTTP request, you can retrieve it in the portal. Select **Subscriptions**, and open the context menu (**...**) for your suscription. Select **Show/hide keys**. You can also regenerate keys if needed. Then, add a key to the header.
57
+
* If your subscription doesn't already allow tracing, you're prompted to enable it if you want to trace the call.
58
+
* You can also choose to send the request without tracing.
59
+
60
+
:::image type="content" source="media/api-management-howto-api-inspector/06-debug-your-apis-01-trace-call-1.png" alt-text="Screenshot showing configure API tracing.":::
53
61
54
62
## Review trace information
55
63
56
64
1. After the call completes, go to the **Trace** tab in the **HTTP response**.
57
-
1. Select any of the following links to jump to detailed trace info: **Inbound**, **Backend**, **Outbound**.
65
+
1. Select any of the following links to jump to detailed trace info: **Inbound**, **Backend**, **Outbound**, **On error**.
@@ -64,10 +72,12 @@ The **Allow tracing** setting for the subscription used for your API must be ena
64
72
65
73
***Outbound** - Shows the policies applied to the response before sending back to the caller.
66
74
75
+
***On error** - Shows the errors that occurred during the processing of the request and the policies applied to the errors.
76
+
67
77
> [!TIP]
68
78
> Each step also shows the elapsed time since the request is received by API Management.
69
79
70
-
1. On the **Message** tab, the **ocp-apim-trace-location** header shows the location of the trace data stored in Azure blob storage. If needed, go to this location to retrieve the trace.
80
+
1. On the **Message** tab, the **ocp-apim-trace-location** header shows the location of the trace data stored in Azure blob storage. If needed, go to this location to retrieve the trace. Trace data can be accessed for up to 24 hours.
71
81
72
82
:::image type="content" source="media/api-management-howto-api-inspector/response-message-1.png" alt-text="Trace location in Azure Storage":::
:::image type="content" source="media/api-management-howto-create-subscriptions/create-subscription.png" alt-text="Screenshot showing how to create an API Management subscription in the portal.":::
39
43
40
-
After you create the subscription, two API keys are provided to access the APIs. One key is primary, and one is secondary.
44
+
After you create the subscription, it appears in the list on the **Subscriptions** page. Two API keys are provided to access the APIs. One key is primary, and one is secondary.
Copy file name to clipboardExpand all lines: articles/api-management/api-management-subscriptions.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,6 +63,9 @@ In these cases, you don't need to create a product and add APIs to it first.
63
63
64
64
Each API Management instance comes with an immutable, all-APIs subscription (also called an *all-access* subscription). This built-in subscription makes it straightforward to test and debug APIs within the test console.
65
65
66
+
> [!WARNING]
67
+
> The all-access subscription enables access to every API in the API Management instance and should only be used by authorized users. Never use this subscription for routine API access or embed the all-access subscription key in client apps.
68
+
66
69
> [!NOTE]
67
70
> If you're using an API-scoped subscription or the all-access subscription, any [policies](api-management-howto-policies.md) configured at the product scope aren't applied to requests from that subscription.
68
71
@@ -76,9 +79,7 @@ Creating a subscription without assigning an owner makes it a standalone subscri
76
79
77
80
## Create subscriptions in Azure portal
78
81
79
-
API publishers can [create subscriptions](api-management-howto-create-subscriptions.md) directly in the Azure portal:
0 commit comments