https://github.com/Azure/api-management-policy-snippets

Re-usable examples of Azure API Management policies
https://github.com/Azure/api-management-policy-snippets

Last synced: about 2 months ago
JSON representation

Re-usable examples of Azure API Management policies

• Host: GitHub
• URL: https://github.com/Azure/api-management-policy-snippets
• Owner: Azure
• License: mit
• Created: 2017-04-06T23:50:40.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-06T21:43:50.000Z (6 months ago)
• Last Synced: 2024-09-07T01:32:50.478Z (6 months ago)
• Size: 319 KB
• Stars: 330
• Watchers: 35
• Forks: 153
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Azure API Management Policy Snippets

# Policy Toolkit

[Azure API Management policy toolkit](https://github.com/Azure/azure-api-management-policy-toolkit) is a set of libraries and tools for authoring policy documents for Azure API Management. The toolkit was designed to help create and test policy documents with complex expressions.

# Examples

The `examples/` folder contains policy examples contributed by the product team and the user community. The samples are meant to be re-used verbatim, provide inspiration or serve as learning aids. Some of them are parameterized using [Named Values](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties) (formerly known as Properties), which look like this: `{{some-value}}`. When using parametrized samples, you will have to either define relevant Named Values or replace them with values in place.

# Policy expressions cheat-sheet

The `policy-expressions` folder contains a [cheat-sheet](policy-expressions/README.md) with common policy expressions that are often used when authoring Azure API Management policies.

# Visual Studio Code snippets

The `vscode-snippets/` folder contains user snippets for Visual Studio Code. User snippets are helpful for streamlining workflow and simplifying document editing with autocomplete and easy navigation. Please, refer to the [Visual Studio Code documentation](https://code.visualstudio.com/docs/editor/userdefinedsnippets) on how to use them.

![Azure API Management VS Code User Snippet 1](media/vscode-snippets/apim-vscode-snippets-1.png)

![Azure API Management VS Code User Snippet 2](media/vscode-snippets/apim-vscode-snippets-2.png)

![Azure API Management VS Code User Snippet 3](media/vscode-snippets/apim-vscode-snippets-3.png)

# Helpful Links

- [Policies Reference](https://docs.microsoft.com/en-us/azure/api-management/api-management-policies)

- [Policy Expressions](https://docs.microsoft.com/en-us/azure/api-management/api-management-policy-expressions)

- [Handling Errors in Policies](https://docs.microsoft.com/en-us/azure/api-management/api-management-error-handling-policies)

- [Policy Toolkit](https://github.com/Azure/azure-api-management-policy-toolkit)

To learn about Azure API Management go [here.](https://azure.microsoft.com/en-us/services/api-management/)

# Contributing

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.