Skip to content

Commit 13d5e36

Browse files
Merge pull request #260085 from dlepow/cop
[APIM] Add copilot links
2 parents 424a519 + baaded9 commit 13d5e36

8 files changed

+37
-27
lines changed

articles/api-management/TOC.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@
150150
- name: Security controls by Azure Policy
151151
href: ./security-controls-policy.md
152152
- name: Security baseline
153-
href: /security/benchmark/azure/baselines/api-management-security-baseline?toc=/azure/api-management/&bc=/azure/api-management/breadcrumb/toc.json
153+
href: /security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
154154
- name: Logs and monitoring
155155
items:
156156
- name: Observability
@@ -211,7 +211,7 @@
211211
- name: Azure OpenAI
212212
items:
213213
- name: Protect Azure OpenAI keys
214-
href: /semantic-kernel/deploy/use-ai-apis-with-api-management?toc=/azure/api-management/&bc=/azure/api-management/breadcrumb/toc.json
214+
href: /semantic-kernel/deploy/use-ai-apis-with-api-management?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
215215
- name: Configure API for SSE
216216
href: how-to-server-sent-events.md
217217
- name: API import restrictions
@@ -247,7 +247,7 @@
247247
- name: Set or edit policies
248248
href: set-edit-policies.md
249249
- name: Author policies using Microsoft Copilot for Azure
250-
href: ../copilot/author-api-management-policies.md?toc=/azure/api-management/&bc=/azure/api-management/breadcrumb/toc.json
250+
href: ../copilot/author-api-management-policies.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
251251
- name: Debug policies in VS Code
252252
href: api-management-debug-policies.md
253253
- name: Policy expressions

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,14 @@ ms.author: danlep
1313
---
1414
# Policies in Azure API Management
1515

16-
In Azure API Management, API publishers can change API behavior through configuration using *policies*. Policies are a collection of statements that are run sequentially on the request or response of an API. Popular statements include:
16+
In Azure API Management, API publishers can change API behavior through configuration using *policies*. Policies are a collection of statements that are run sequentially on the request or response of an API. API Management provides more than 50 policies out of the box that you can configure to address common API scenarios such as authentication, rate limiting, caching, and transformation of requests or responses. For a complete list, see [API Management policy reference](api-management-policies.md).
17+
18+
Popular policies include:
1719

1820
* Format conversion from XML to JSON
1921
* Call rate limiting to restrict the number of incoming calls from a developer
2022
* Filtering requests that come from certain IP addresses
2123

22-
Many more policies are available out of the box. For a complete list, see [API Management policy reference](api-management-policies.md).
2324

2425
Policies are applied inside the gateway between the API consumer and the managed API. While the gateway receives requests and forwards them, unaltered, to the underlying API, a policy can apply changes to both the inbound request and outbound response.
2526

@@ -116,6 +117,8 @@ In API Management, a [GraphQL resolver](configure-graphql-resolver.md) is config
116117

117118
For more information, see [Configure a GraphQL resolver](configure-graphql-resolver.md).
118119

120+
[!INCLUDE [api-management-policies-azure-copilot](../../includes/api-management-policies-azure-copilot.md)]
121+
119122
## Examples
120123

121124
### Apply policies specified at different scopes

articles/api-management/api-management-policies.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ More information about policies:
1717
+ [Policy overview](api-management-howto-policies.md)
1818
+ [Set or edit policies](set-edit-policies.md)
1919
+ [Policy expressions](api-management-policy-expressions.md)
20+
+ [Author policies using Microsoft Copilot for Azure](../copilot/author-api-management-policies.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json)
2021

2122
> [!IMPORTANT]
2223
> [Limit call rate by subscription](rate-limit-policy.md) and [Set usage quota by subscription](quota-policy.md) have a dependency on the subscription key. A subscription key isn't required when other policies are applied.
@@ -100,10 +101,5 @@ More information about policies:
100101
- [Validate parameters](validate-parameters-policy.md) - Validates the request header, query, or path parameters against the API schema.
101102
- [Validate headers](validate-headers-policy.md) - Validates the response headers against the API schema.
102103
- [Validate status code](validate-status-code-policy.md) - Validates the HTTP status codes in responses against the API schema.
103-
## Next steps
104104

105-
For more information about working with policies, see:
106-
107-
+ [Tutorial: Transform and protect your API](transform-api.md)
108-
+ [Set or edit policies](set-edit-policies.md)
109-
+ [Policy snippets repo](https://github.com/Azure/api-management-policy-snippets)
105+
[!INCLUDE [api-management-policy-ref-next-steps](../../includes/api-management-policy-ref-next-steps.md)]

articles/api-management/api-management-policy-expressions.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,14 +241,15 @@ The `context` variable is implicitly available in every policy [expression](api-
241241
|`bool VerifyNoRevocation(input: this System.Security.Cryptography.X509Certificates.X509Certificate2)`|Performs an X.509 chain validation without checking certificate revocation status.<br /><br />`input` - certificate object<br /><br />Returns `true` if the validation succeeds; `false` if the validation fails.|
242242

243243

244-
## Next steps
244+
## Related content
245245

246246
For more information working with policies, see:
247247

248248
+ [Policies in API Management](api-management-howto-policies.md)
249-
+ [Transform APIs](transform-api.md)
250-
+ [Policy Reference](./api-management-policies.md) for a full list of policy statements and their settings
251-
+ [Policy samples](./policy-reference.md)
249+
+ [Tutorial: Transform and protect APIs](transform-api.md)
250+
+ [Policy reference](./api-management-policies.md) for a full list of policy statements and their settings
251+
+ [Policy snippets repo](https://github.com/Azure/api-management-policy-snippets)
252+
+ [Author policies using Microsoft Copilot for Azure](../copilot/author-api-management-policies.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json)
252253

253254
For more information:
254255

articles/api-management/policy-fragments.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,12 @@ After creating a policy fragment, you can view and update the properties of a po
110110
1. Review **Policy document references** for policy definitions that include the fragment. Before a fragment can be deleted, you must remove the fragment references from all policy definitions.
111111
1. After all references are removed, select **Delete**.
112112

113-
## Next steps
113+
## Related content
114114

115115
For more information about working with policies, see:
116116

117117
+ [Tutorial: Transform and protect APIs](transform-api.md)
118118
+ [Set or edit policies](set-edit-policies.md)
119119
+ [Policy reference](./api-management-policies.md) for a full list of policy statements
120120
+ [Policy snippets repo](https://github.com/Azure/api-management-policy-snippets)
121+
+ [Author policies using Microsoft Copilot for Azure](../copilot/author-api-management-policies.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json)

articles/api-management/set-edit-policies.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -114,16 +114,6 @@ To configure a policy:
114114
The **ip-filter** policy now appears in the **Inbound processing** section.
115115
---
116116

117-
## Get assistance creating policies using Microsoft Copilot for Azure (preview)
118-
119-
120-
[Microsoft Copilot for Azure](../copilot/overview.md) (preview) provides policy authoring capabilities for Azure API Management. Using Copilot for Azure in the context of API Management's policy editor, you can create policies that match your specific requirements without knowing the syntax or have already configured policies explained to you. This proves particularly useful for handling complex policies with multiple requirements.
121-
122-
You can prompt Copilot for Azure to generate policy definitions, then copy the results into the policy editor and make any necessary adjustments. Ask questions to gain insights into different options, modify the provided policy, or clarify the policy you already have. [Learn more](../copilot/author-api-management-policies.md) about this capability.
123-
124-
> [!NOTE]
125-
> Microsoft Copilot for Azure requires [registration](../copilot/limited-access.md#registration-process) (preview) and is currently only available to approved enterprise customers and partners.
126-
127117
## Configure policies at different scopes
128118

129119
API Management gives you flexibility to configure policy definitions at multiple [scopes](api-management-howto-policies.md#scopes), in each of the policy sections.
@@ -233,6 +223,8 @@ To modify the policy evaluation order using the policy editor:
233223

234224
A globally scoped policy has no parent scope, and using the `base` element in it has no effect.
235225

226+
[!INCLUDE [api-management-policies-azure-copilot](../../includes/api-management-policies-azure-copilot.md)]
227+
236228
## Related content
237229

238230
For more information about working with policies, see:
@@ -241,3 +233,4 @@ For more information about working with policies, see:
241233
+ [Set or edit policies](set-edit-policies.md)
242234
+ [Policy reference](./api-management-policies.md) for a full list of policy statements and their settings
243235
+ [Policy snippets repo](https://github.com/Azure/api-management-policy-snippets)
236+
+ [Author policies using Microsoft Copilot for Azure](../copilot/author-api-management-policies.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
author: dlepow
3+
ms.service: api-management
4+
ms.topic: include
5+
ms.date: 12/01/2023
6+
ms.author: danlep
7+
---
8+
## Get assistance creating policies using Microsoft Copilot for Azure (preview)
9+
10+
11+
[Microsoft Copilot for Azure](../articles/copilot/overview.md) (preview) provides policy authoring capabilities for Azure API Management. Use Copilot for Azure in the context of API Management's policy editor to create policies that match your specific requirements without knowing the syntax, or have already configured policies explained to you.
12+
13+
You can prompt Copilot for Azure to generate policy definitions, then copy the results into the policy editor and make any necessary adjustments. Ask questions to gain insights into different options, modify the provided policy, or clarify the policy you already have. [Learn more](../articles/copilot/author-api-management-policies.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json)
14+
15+
[!INCLUDE [preview-note](../articles/copilot/includes/preview-note.md)]

includes/api-management-policy-ref-next-steps.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ For more information about working with policies, see:
1414
+ [Policy expressions](../articles/api-management/api-management-policy-expressions.md)
1515
+ [Set or edit policies](../articles/api-management/set-edit-policies.md)
1616
+ [Reuse policy configurations](../articles/api-management/policy-fragments.md)
17-
+ [Policy snippets repo](https://github.com/Azure/api-management-policy-snippets)
17+
+ [Policy snippets repo](https://github.com/Azure/api-management-policy-snippets)
18+
+ [Author policies using Microsoft Copilot for Azure](../articles/copilot/author-api-management-policies.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json)

0 commit comments

Comments
 (0)