Releases: Azure-Samples/Apim-Samples
Releases · Azure-Samples/Apim-Samples
v1.12.0
Added
- New infrastructure architecture: Application Gateway to API Management via internal VNet: This is the classic App Gateway & API Management pairing through VNet injection.
Changed
- Bicep execution optimizations: Speed up deployments by batching and parallelizing resource deployments.
- No wait on Key Vault purge: Added a
--no-waitparameter on Key Vault purges to speed up clean-ups. - Enhanced the Python GitHub action workflow: Added pylint, test coverage, and compilation checks.
Fixed
- Fixed Azure Advisories: Addressed all reasonable advisories while ignoring ones such as multiple Availability Zone additions to save cost.
Full Changelog: 1.11.0...1.12.0
v1.11.0
Added
- Add conventional Python
loggingto support detailedDEBUGlevel in.envfile (default set toINFO) #105 - Add script to show soft-deleted API Management and Key Vault instance with optional purge option
Full Changelog: 1.10.1...1.11.0
v1.10.1
This is largely a Python refactoring release.
Changed
- Break up
utils.pymeaningfully as it has grown entirely too large. New files areazure_resources.py,json_utils.py, andconsole.py - Clean up Python code extensively with Pylint rules
- Add ~60 new unit tests
- Parallelize resource cleanup in the same resource group (previously only across resource groups)
- Create Python and Bicep specific Copilot instruction files
- Normalize line endings to
LFfor cross-OS compatibility - Include Python 3.14 test coverage in GitHub action
Full Changelog: 1.10.0...1.10.1
v1.10.0
Added
- New infrastructure architecture: Application Gateway to API Management via Private Endpoint: Application Gateway has been added with private endpoint connectivity to API Management Standard V2. This can result in significant cost savings and is the reason it was added before a VNet injection infrastructure.
Changed
- Housekeeping: Clean up Python code extensively with Pylint rules
Full Changelog: 1.9.0...1.10.0
v1.9.0
Added
- API ID general sample: Extracts an API ID based on an API naming convention. Unfortunately, the
contextobject in an API call does not reveal any tags, making it difficult for telemetry to explicitly identify an API. - Azure Front Door diagnostic logging: Logs all metrics to the common log analytics workspace for the infrastructure. Previously, we did not see requests to Front Door reflected in telemetry due to an omission of the diagnostic settings. #89
- Parallel clean-up: When more than one index is defined in the
clean-up.ipynbfiles, cleaning resources is multi-threaded. This speeds up the process substantially, especially with Azure Container Apps infrastructures. #87 - [Engineering]: Added infrastructure classes to consolidate infrastructure creation logic. #88
Changed
- Allow Infrastructure Updates: Re-running infrastructure builds is now possible. This is helpful when new APIs, named values, etc. are added to infrastructures notebooks after they were already built in Azure. Previously, manual changes needed to be made, or the infrastructure had to be cleaned up, then redeployed. #86
Fixed
- GitHub Copilot instructions file was named incorrectly (leading period in filename) and was consequently not automatically added to the chat context.
Full Changelog: 1.8.0...1.9.0
v1.8.0
Added
- Ability to execute a sample without a preexisting, supported infrastructure. Depending on your input parameters, you may now be presented with options to select an existing, supported infrastructure or create a new one. This simplifies APIM Samples quite a bit! #80
Changed
- Code and documentation refactoring for conformity, providing a simpler, cleaner, and homogenous way to create and execute infrastructures and samples.
- [Engineering]: Many more Python unit tests to increase coverage meaningfully.
Full Changelog: 1.7.0...1.8.0
v1.7.0
Added
- Added API Management subscriptions support for all infrastructure and sample APIs and products. This is also now the default behavior. #66
Changed
- Minor refactoring and formatting across source files
Fixed
- AuthX-Pro now uses the correct APIM policy #67
Full Changelog: 1.6.0...1.7.0
v1.6.0
Added
- Azure Maps sample to demonstrate the three authentication methods (Shared Key, Azure Entra ID, SAS Token) for integrating Azure Maps with API Management. By @anotherRedbeard
- Credential Manager (OAuth to Spotify) sample to show JSON Web Token authentication & authorization from a caller to API Management, then OAuth 2.0 authentication with a separate JSON Web Token from API Management to Spotify. This initial sample retrieves basic artist information.
Changed
- Refactored notebooks slightly by using a new
NotebookHelper. We will continuously refine and abstract to make it simpler for you to focus on what's relevant.
Full Changelog: 1.5.0...1.6.0
v1.5.0
Added
- Functionality to return the backend API URL to the caller. It's on by default since this is a learning environment. It is useful for testing and basing further logic on that value in API Management policies; however, be mindful of this logic entering production code as it reveals internal URLs.
Changed
- Infrastructure and sample validations now use explicit assertions to clearly inform whether the setup is working as expected.
- Shared policy fragments are now set up via the infrastructures rather than samples. This reduces sample setup and redundancy.
Full Changelog: 1.4.1...1.5.0
v1.4.1
Added
Troubleshooting.mdto help users resolve common pitfalls.
Changed
- Significantly reduced GitHub Codespaces start-up time even after already having prebuilt the container! The environment is almost instantaneously available now.
- Enhanced
Readme.mdto help users get started with local and Dev Container / Codespaces setups. - [Engineering]: Consolidated kernelspec to use
apim-samplesfor local and Dev Container / Codespaces uses. - [Engineering]: Added
Test-Matrix.mdto simplify verification of changes.
Fixed
- Fixed an issue with the
load-balancingsample where thecharts.pylocal import was no longer functioning. - Fixed Python module import logic for Dev Containers. The previous code resulted in failed imports in some scenarios.
Full Changelog: 1.4.0...1.4.1