Skip to content

Releases: Azure/API-Management

Release - API Management service: September, 2025

03 Sep 19:10
27b2e12

Choose a tag to compare

Highlights

Since the last update, we've added:

New features and improvements

  • You can now enable content-safety checks on chat completions for final redaction, logging, and response validation using the enforce-on-completions attribute of the llm-content-safety policy. This setting is off by default.
  • Model logging now supports the Azure OpenAI Realtime API.
  • Product resource names can now include dots (.).
  • Email notifications are now supported in v2 tiers.
  • OpenAPI imports are now safer, result in cleaner API definitions, and fail with clearer error messages.
    • Imports are blocked if a path placeholder (e.g., /orders/{id}) has no matching parameter, with a clear validation error shown.
    • Imports from localhost URLs are now blocked. You can use file upload or an accessible non-localhost URL instead.
    • If a response object doesn't include a description, API Management now defaults it to an empty string.
  • The policy engine now blocks embedding scripts using the XsltSettings.EnableScript setting.
  • Policy parsing is now consistent across locales, ensuring numbers are interpreted reliably regardless of browser language or region (comma vs. dot), preventing save errors.
  • The validate-azure-ad-token policy now returns more detailed error messages when token validation fails.
  • API inspector now provides better visibility into authentication, showing when OAuth or OIDC settings were last refreshed, whether refresh succeeded, and any error details.
  • The self-hosted gateway now produces cleaner JSON logs, applies configuration updates more reliably, and starts successfully even when the OpenTelemetry monitoring isn't configured.

Bug fixes

  • Resolved issue where prolonged cache outages could cause gateway data plane downtime.

⚠️ Changes

Self-hosted gateway

Release - API Management service: May, 2025

03 May 00:24
aa6ca0f

Choose a tag to compare

This release will be deployed gradually in phases and batches, following the safe deployment practices framework. The rollout will span several weeks across all Azure regions, so your services may not have the new features and fixes until the deployment is complete.

New Features and Improvements

Workspaces

  • Workspaces are now supported in Norway East and West Europe. See the documentation for details and instructions for accessing workspaces in West Europe.
  • You can now associate multiple workspaces with a single workspace gateway.

Gateway & Traffic Management

  • Quota-by-key policy is now available in v2 service tiers, enabling more flexible and fine-grained rate limiting. More info.
  • Circuit breaker configuration in backends now supports an optional failureResponse property, allowing you to define fallback HTTP status codes (100–599). More info.
  • Data-plane events in Azure Event Grid (Public Preview) are now enabled by default in the gateway, allowing for richer event notifications and diagnostics.
  • You can now configure the same URL suffix for both HTTP REST and WebSocket APIs, simplifying endpoint design.

Platform & Portal Enhancements

  • Authoring API Management policies with Microsoft Copilot in Azure is now Generally Available.
  • The Network Status page in the Azure Portal now displays new monitoring endpoints for national cloud regions, improving visibility into service health and diagnostics. More info.

LLM & Semantic Caching

  • Launched enhanced logging for large language model (LLM) scenarios, including new fields — resourceId, workspaceId, and region — for improved traceability. Log timestamps are now emitted in date-time format instead of long integers, aligning with standard observability practices.
  • Semantic caching has been updated to support GPT-4o prompts that include multiple content types and now correctly identifies max-message-count of the most recent messages.

Observability Enhancements

  • The emit-metric, azure-openai-emit-token-metric , and llm-emit-token-metric policies now treat dimension keys as case-insensitive, ensuring consistent metric grouping and reducing casing-related issues.
  • Backend pool failures now include a Retry-After header to support client-side resiliency strategies.
  • Self-hosted gateway now emits additional debug logs, including snapshot decompression, manglers, and listeners to assist with diagnostics. More info.

⚠️ Changes

  • You may need to associate a workspace with a workspace gateway before managing resources in that workspace. More info
  • We've updated how the state of asynchronous operations is tracked in the Microsoft.ApiManagement resource provider in all API version. Going forward, responses will include an Azure-AsyncOperation header, in addition to the Location header. This header contains a URL following the format below, which can be used to monitor the operation status: https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ApiManagement/service/{service-name}/tenant/operationResults/{operation-id}. To check the status of an operation, customers using built-in roles don't need to take any action. However, custom reader roles must be updated to allow the Microsoft.ApiManagement/service/tenant/*/read action. Learn more.
  • We’ve improved how capacity usage is calculated for API Management services. As a result, you may notice that reported usage appears higher than before. This change reflects a more accurate calculation method that better represents the actual utilization of your service. It should have no impact on the performance or throughput of your service.

Bug Fixes

Gateway & Traffic Management

  • Fixed a bug where VNet-integrated Standard v2 services required blob storage access to be unblocked via NSG for management operations.
  • Fixed delivery issues in log-to-eventhub policy in Basic v2 and Standard v2 SKUs.
  • Fixed inaccurate detection and counting of backend connectivity errors in the Circuit Breaker policy.
  • Fixed bandwidth calculation in quota-by-key policy on self-hosted gateway to include transferred bytes.

Telemetry and Monitoring

  • Fixed a bug where backendTime reported in Azure Monitor and Application Insights was higher than expected.
  • Resolved startup and connection failures in self-hosted gateway when telemetry or feature-flagged endpoints were not fully rolled out.
  • Fixed missing WebSocket Azure Monitor logs due to lowercase resource IDs.

OpenAPI Specification Handling

  • Resolved an issue where OpenAPI definition did not include a response description. If omitted, it is now auto-filled as an empty string.
  • OpenAPI 'format' properties are now preserved correctly during import (previously could appear in the description).
  • Required formData fields are now properly enforced.

Workspace & Product Configuration

  • Fixed an issue preventing workspace deletion after failed gateway activation.
  • Deleting an API Management service now requires removal of all associated workspace gateways.
  • When a product is configured to limit subscriptions, the limit must now be greater than zero.

Other Reliability Improvements

  • Improved reliability of the llm-content-safety policy and added support for multiple blocklists and categories.
  • Import of API specifications from a localhost address is no longer supported.
  • Improved formatting of error responses for management API requests that fail due to minimum API version enforcement.

Developer Portal

Self-hosted Gateway

Release - API Management service: January, 2025

27 Jan 22:00
76b35f0

Choose a tag to compare

This release will be deployed gradually in phases and batches, following the safe deployment practices framework. The rollout will span several weeks across all Azure regions, so your services may not have the new features and fixes until the deployment is complete.

Featured content

New features and improvements

Bug fixes

  • Requests to an API in an open product and containing a subscription key for a different product are not being rejected anymore.
  • Validate content policy now works correctly with nullable properties in JSON payloads, including those defined by the oneOf, anyOf, and allOf schema constructs.
  • Redirect content URLs policy doesn't add redundant slashes to the output URLs like it used to in some cases.
  • Validate Entra ID token policy now correctly puts decrypted token into the context variable specified in the output-token-variable-name attribute.
  • Rate limit by key policy now returns correct value in the Retry-After header in all cases.
  • Array fields are now returned when included in Synthetic GraphQL subscriptions.
  • You can now successfully add a workspace to a service configured with a custom hostname.

Self-hosted developer portal releases

Self-hosted gateway container image releases

  • None

Self-hosted gateway Helm chart releases

  • None

Release - API Management service: August, 2024

30 Aug 15:46
437e61c

Choose a tag to compare

🎉 Announcements

❗ Changes

  • If an API does not require subscription authentication, any API request that includes a subscription key will now be treated the same as a request without a subscription key. Previously, if a request included a subscription key associated with a different API or product, API Management would return a 401 Unauthorized response. This change improves the security of your APIs by preventing the accidental exposure of subscription keys linked to other products. Update Sep 3, 2024: This change will be rolled out with another release.
  • As part of the general availability of workspaces, we are discontinuing support for preview workspaces in API Management. You can learn more about these changes in the last section of the workspaces general availability announcement and in this documentation article.

New features

Fixes and improvements

  • We fixed an issue with the retry policy not working correctly with load balancer backends.
  • We fixed a bug with the backend reconnect action not working properly.
  • We fixed a bug with the decrypted token not being included in a context variable when using the validate-azure-ad-token policy.
  • We made the certificate-id attribute of the decryption-keys element in the validate-azure-ad-token policy optional.
  • We fixed a bug that caused refresh failures for certificates in a key vault referenced within a policy fragment.
  • We optimized the performance of deleting users. Previously, the operation could time out if there were thousands or more users in the API Management service.
  • We fixed a bug that caused an incorrect date-time format to be returned when testing GraphQL resolvers.
  • We removed internal runtime exception details from GraphQL resolver error messages.
  • The developer portal delegationUrl setting now defaults to null. Previously, it defaulted to an empty string, causing payload validation errors on PUT calls to the management API.

Self-hosted developer portal releases

Self-hosted gateway container image releases

Self-hosted gateway Helm chart releases

Release - API Management service: June, 2024

26 Jun 21:07
b70ccdd

Choose a tag to compare

New features, improvements, and changes

Fixes

  • We fixed an issue which caused GraphQL resolver runtime errors when primitive type fileds had null value
  • We fixed a bug and stopped the fields of type array-of-objects from causing GraphQL resolver runtime errors
  • Expressions now work as expected for in the <audience/> elements in the validate-jwt policy
  • We fixed a bug causing XML elements within Liquid templates in policy documents to be needlessly decoded
  • URL properties in the Backend entity no longer accept URLs containing query parameters. We've made the change to fix a bug. Please use set-query-parameter policy and backend.credentials.query to set query parameters
  • We fixed an issue preventing backend load balancing feature from working properly with retry policy

Self-hosted gateway container image releases

Self-hosted gateway Helm chart releases

Release - API Management service: May, 2024

08 May 19:36
bed8c62

Choose a tag to compare

New features, improvements, and changes

Fixes

  • We now correctly import schemas from OpenAPI 3.1 specifications.
  • API imports will no longer fail because of OData specification warnings. However, errors will still cause import failures.
  • Liquid template and policy expressions with XML special characters, such as "<" or ">", no longer result in runtime failures.
  • We did not respect the JWT specification in validate-jwt policy and did not enforce "sub" claim to be a string or URI

Self-hosted developer portal releases

Self-hosted gateway container image releases

  • No new releases

Self-hosted gateway Helm chart releases

  • No new releases

Release - API Management service: March 2024

19 Mar 21:24
0833b1c

Choose a tag to compare

‼️ Breaking changes ‼️

  • On June 14, 2024, we’re introducing breaking changes to the Workspaces feature. You may have to take action to continue using workspaces beyond June 14, 2024.

New features, improvements, and changes

  • We’ve introduced several new features and improvements to workspaces:
    • You can now create and manage certificates, backends, diagnostics, and loggers inside a workspace with the 2023-09-01-preview management API version.Azure portal interface will be released soon.
    • You can now use context.Workspace in policy expressions.
    • "default-workspace" is now a reserved workspace resource name.
  • We now preserve the format and schema properties of the form-data parameters when importing OpenAPI APIs.
  • HTTP version information will now be included in the request trace.
  • We’ve added support for HS512 and RS512 algorithms in the validate-jwt policy.
  • client-application-ids element is now optional in validate-azure-ad-token policy.
  • We've made a couple improvements to the GraphQL support:
  • An Azure Advisor notification will be sent to customers when they inadvertantly delete the FQDN property from the public IP resource assigned to API Management.
  • We've made several improvements to the VNet integration in the Standard v2 tier:
    • We will now detect if the prerequisites for VNet integration are not being met - i.e., subnet delegation and service association link, and fail the deployment faster.
    • All traffic from the VNet-integrated Standard v2 service instances to the Internet will be now routed via the integrated VNet.
    • The outbound IP will now be populated and shows its respective value.

Fixes

  • We’ve resolved the issue where Azure API Management would incorrectly log requests that were rejected due to public network access is disabled. This fix ensures that logs and metrics in Azure Monitor now exclude these rejected requests when API Management is set up with a private endpoint.
  • An attempt to create diagnostics in a workspace that doesn't exist will now return a 404 Not Found error. Previously, API Management returned a 500 Internal Server Error response.
  • Workspace users can no longer override diagnostics settings defined for all APIs on the service level.
  • Exporting APIs with empty or whitespace-only examples no longer produces an error.
  • Optional string query parameters are no longer added to the API operation's URL template.
  • $DevPortalUrl variable in the developer welcome email template now returns a new developer portal URL. Previously, it returned a legacy developer portal URL.
  • The authenticate-certificate policy now performs a case-sensitive certificate ID validation. Previously, request processing would fail when the casing between the certificate ID in the policy and in the request didn’t match.
  • We've fixed an issue preventing recovery of the soft-deleted Basic v2 and Standard v2 service instances.

Self-hosted developer portal releases

Self-hosted gateway container image releases

Self-hosted gateway Helm chart releases

Release - API Management service: February 2024

07 Feb 01:07
9d6f0f5

Choose a tag to compare

New features, improvements, and changes

Fixes

  • Self-hosted gateway using EntraID authentication to connect to the associated Azure API Management service instance are now showing heartbeats in the Azure Portal.
  • We fixed the issue preventing “Scheduled Maintenance” events from being shown in the Activity log.
  • The set-body policies contained within GraphQL resolver policies (see example) is now executed for streamed responses.
  • The issue making resolver get incorrect values from the cache for some GraphQL requests is now fixed.
  • Requests resulting in a log entry larger than 32KB, previously not logged at all, are now logged to Azure Monitor after trimming.

Developer portal releases

  • No releases.

Self-hosted gateway container image releases

2.5.0

Self-hosted gateway Helm chart releases

1.9.0

Release - API Management service: December, 2023

07 Dec 20:47
f771ea4

Choose a tag to compare

New features, improvements, and changes

  • We reserved default Workspace name for internal use. After the update, users will not be able to create Workspaces with that name.

Fixes

  • We fixed an issue causing degraded performance when creating new service instance.
  • We fixed an issue with DevPortalHost property not being passed correctly into the email notification template.
  • We eliminated inconsistency in Security Scheme and Security Requirement objects in OpenAPI exports when performed by authenticated vs. anonymous users.

Developer portal releases

  • No releases.

Self-hosted gateway container image releases

Self-hosted gateway Helm chart releases

Release - API Management service: November, 2023

08 Nov 22:14
bebe41f

Choose a tag to compare

New features, improvements, and changes

  • We will now provide specifics about token validation failures in validate-azure-ad-token policy in API Inspector.
  • We made the password policy stronger for users creating accounts on the developer portal - e.g., it now requires using a special character. Complete password requirements will be shown on the sign-up page.
  • Users now must provide their current password before changing it on the developer portal.
  • Pagination controls on the developer portal now feature only the Next and Previous buttons.

Fixes

  • We fixed an issue that caused tokens of logged-out developer portal users signed in via Azure AD B2C to remain valid under some circumstances.
  • We fixed a regression that caused POST requests issued from the try it console on the developer portal not to work correctly.
  • We fixed an issue in the Content Access Control feature of the developer portal that allowed unauthorized access to pages via direct link.

Developer portal releases

  • No releases.

Self-hosted gateway container image releases

Self-hosted gateway Helm chart releases