Release - API Management service: March, 2022

A regular Azure API Management service update was started on March 28, 2022. It may take several weeks for your API Management service to receive the update.

Starting with this service release, we will be posting regular release announcements only here, on GitHub, and we will not be posting them on Azure Updates. We will continue to post feature or breaking change announcements on Azure Updates and reference them in regular release notes on GitHub.

Featured

1. SOAP and XML request and response validation is now generally available.
2. Developer portal widget for embedding custom HTML code is now generally available.
3. Azure Private Link support in Azure API Management is now in public preview.
4. Tools for easier import of WSDL APIs and XSD and JSON schemas are now available on GitHub.

Breaking change advisory

1. Review your virtual network configuration - it may be affected by IP address changes in March 2023.

Fixes and improvements

1. To protect services from username enumeration attacks, any attempt to reset user's password now results in a successful response from the API Management service. Previously, API Management returned 404 Not Found if the username didn't exist in the service.
2. Users no longer can subscribe to products that they don't have access to. Previously, product access configuration only restricted retrieval of product details and its APIs and it didn't prevent subscription attempts.
3. If a policy expression contains a loop and takes over five seconds to execute, API Management will now terminate its execution to avoid infinite loops.
4. You can now reference JSON schema resources from another JSON schema resource. The new schema entity is used for request or response validation.
5. Null values are no longer accepted inside the certificateIds array when creating or updating backend entities.
6. Client disconnects from gateway are no longer reported as errors.
7. X-Forwarded-For header logs now include addresses added by the gateway.
8. Severity level is now correctly configured in Application Insights traces. Previously, verbose and information traces were logged to Application Insights with higher severity.
9. GraphQL request processing is now faster and more efficient thanks to a series of optimizations.

Developer portal releases

1. 2.14.0 - highlights:
   • Support for contact, license, and termsOfService OpenAPI properties in the API reference pages.
   • Improvements to GraphQL API reference pages, including the code view.
2. 2.13.0 - highlights:
   • HTML injection widget, which allows you to render custom HTML code in an iframe in your managed or self-hosted developer portal pages.
   • Revised code samples in the test console and a new code sample for Swift.

DevOps Resource Kit releases

1. 1.0.0-beta.1:
   • Major code refactoring to the Extractor to make it more maintainable and easier to contribute to.
   • Update of the API version used in the Extractor to the latest generally available version (2021-08-01).
   • Other fixes, improvements, and community contributions.

Release - API Management service: January, 2022

A regular Azure API Management service update was started on January 20, 2022, and included the following new features, bug fixes, and other improvements. It may take several weeks for your API Management service to receive the update.

Featured

1. Managed certificate support is now in public preview.

New

1. Published developer portals are now automatically upgraded to new portal releases, without the need to republish the portal manually. Automated upgrades will preserve the latest published content; they won't publish saved but unpublished content.
2. You can now use curly brackets in a SOAP action URL template (for example, /soapAction={wildcard}) to define a wildcard SOAP action, which will match any SOAP request that doesn't have a dedicated action defined in the API. The value inside the curly brackets doesn't affect the execution.
3. Availability zones are now supported in the East Asia region.
4. New .NET SDK for the management API is now available in preview.

Fixed

1. Newly created diagnostic settings will no longer be configured to log request query parameters by default. As part of this change, Diagnostic entity's dataMasking.queryParams properties will be set with the following wildcard configuration { "value": "*", "mode": "Hide"}. The same wildcard configuration can also be applied to dataMasking.headers.
2. Self-hosted gateway now properly handles a certificate change (certificateId) for existing hostnames.
3. Multiple validate-content policies can now be specified in a single policy section.
4. It is now possible to delete a resource group with an stv2-based API Management service in a virtual network. Previously, the deletion could fail due to an unreleased public IP resource. Learn more about stv2 and API Management's infrastructure.
5. ConfigurationChange event is no longer logged in Resource Health for API Management service backups.
6. tracestate header values are no longer truncated after the first key-value pair.
7. An attempt to deploy an stv2 API Management service into a virtual network subnet with an stv1 API Management service will now result in a descriptive error message.

Release - API Management service: October, 2021

A regular Azure API Management service update was started on October 25, 2021, and included the following new features, bug fixes, and other improvements. It may take several weeks for your API Management service to receive the update.

Featured

1. Public preview: GraphQL passthrough support in Azure API Management.
2. General availability: Native support for WebSocket APIs.
3. General availability: API Management and Event Grid Integration.

New

1. You can now import Azure Container App as an API in API Management.
   
2. API Management now supports managed identity authentication for communication with Application Insights. To configure it, specify the identityClientId key in the properties.credentials property of the Logger object and set the value to:
   • systemAssigned for a system-assigned identity, or
   • ID of a user-assigned identity.
3. Support for the multi-dimensional Request metric in Azure Monitor is now generally available.

Fixed

1. We fixed an issue, where the Portal Revision API marked all new developer portal revisions as current, regardless of the isCurrent parameter's value.
2. We fixed an issue, where the specified-parameter-action attribute of the validate-parameters policy was ignored.
3. Scale-outs of API Management services in the single-tenant v2 (stv2) infrastructure no longer affect existing service capacity. Previously, each scale-out forced a restart of the existing nodes. This optimization has already been implemented in services in the stv1 infrastructure and those services aren't affected by the change.
4. All header's schema properties are now preserved when importing an OpenAPI v3 document. Schemas for headers are supported in management API versions 2021-01-01-preview or later.
5. Properties with format: date in OpenAPI documents are no longer converted to a date-time object.
6. Unknown countries are now reported as Unknown in the built-in API reports (Analytics tab in the Azure portal).
7. WebSocket APIs now support backend service URI with the WebSocket schema and a custom port.

Information

1. Services deployed in a virtual network with forced tunneling need to allow an additional dependency for Windows activations. Although this requirement wasn't documented, it is not introduced by the current release.

Release - developer portal: 2.12.1

A new developer portal version has just been released.

If you use the built-in, managed developer portal, your portal will be automatically upgraded within two weeks. Make sure to republish it to upgrade the published portal.

If you self-host the developer portal, you need to merge the source code changes and republish and redeploy your portal manually.

Detailed release notes are available in the developer portal repository.

Release - developer portal: 2.12.0

A new developer portal version has just been released.

If you use the built-in, managed developer portal, your portal will be automatically upgraded within two weeks. Make sure to republish it to upgrade the published portal.

If you self-host the developer portal, you need to merge the source code changes and republish and redeploy your portal manually.

Detailed release notes are available in the developer portal repository.

Release - self-hosted gateway: 1.2.5

Release - self-hosted gateway: 1.2.5

September 29, 2021

New stable version of the self-hosted gateway is now available. Full list of container versions can be found here.

New

None

Bug fixes

• Concurrency bug in pooled connection acquisition logic that caused request failures under high load
• Bug causing intermittent failures of large (30MB+) requests
• Bug preventing request logs and gateway errors from appearing in standard output

Breaking changes

None

Release - developer portal: 2.11.5

A new developer portal version has just been released.

If you use the built-in, managed developer portal, your portal will be automatically upgraded within two weeks. Make sure to republish it to upgrade the published portal.

If you self-host the developer portal, you need to merge the source code changes and republish and redeploy your portal manually.

Detailed release notes are available in the developer portal repository.

Release - developer portal: 2.11.4

A new developer portal version has just been released.

If you use the built-in, managed developer portal, your portal will be automatically upgraded within two weeks. Make sure to republish it to upgrade the published portal.

If you self-host the developer portal, you need to merge the source code changes and republish and redeploy your portal manually.

Detailed release notes are available in the developer portal repository.

Release - developer portal: 2.11.3

A new developer portal version has just been released.

If you use the built-in, managed developer portal, your portal will be automatically upgraded within two weeks. Make sure to republish it to upgrade the published portal.

If you self-host the developer portal, you need to merge the source code changes and republish and redeploy your portal manually.

Detailed release notes are available in the developer portal repository.

Release - self-hosted gateway: 1.2.4

Release - self-hosted gateway: 1.2.4

August 31, 2021

New stable version of the self-hosted gateway is now available. Full list of container versions can be found here.

New

None

Bug fixes

• Upgraded to use base image mcr.microsoft.com/dotnet/aspnet:3.1.18-alpine3.13 which addressed the following vulnerabilities:

  • CVE-2021-36159
  • CVE-2021-22924
  • CVE-2021-22922
  • CVE-2021-22926
  • CVE-2021-36222
  • CVE-2021-22922
  • CVE-2021-22924

• Fixed the issue causing gateway's failure to start rather than fallback to local configuration snapshot when cloud configuration endpoint is not available

Breaking changes

None