Azure API Management Export Bug By Design


I’ve been playing with Azure API Management for some time now, creating POCs and lately using it for work projects.

It is a great tool, which allows you to centralize all your Microservices or APIs, both public available or inside your On-Premise network.

Among the many features it offers, there is an Import tool that allows you to create an API definition from a Swagger or WSDL file.

And as you would expect from a great tool, there is also an Export tool that allows you to create a Swagger file from an existing API definition.

All great except, when you export a definition from API Management, 

you cannot re-use that definition into any API Management service anymore.

In fact, by design (see the answer from Microsoft Azure Support below), the tool will change your definition, duplicating parameters, and when you import it again, your new API will throw an error when tested:

















“Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription”

So be aware of this “by-design” unexpected behavior (shall we call it bug, really?), and make sure you clean up your exported file before (or after through the Publisher portal) re-importing it into a new API Management instance.

Here’s the answer from Microsoft Azure Support:

“Looks like you are right. I just imported your swagger file…. Then deleted all those subscription-key parameters and saved those changes. Then when I go to export that API the subscription-key does get injected into the query string parameters again. I’ll open up a ticket with the product team and give them the repro. I’ll keep you updated on the investigations.”

However…

“The product team is telling me that this is by design. We add the Ocp-Apim-Subscription-Key and subscription-key parameters. They tell me that the exported swagger file targets clients that want to call the API and that if clients are going to call the API then they have a chance to pass in their API Subscription key using either of those parameters.
They state that the Import/Export API feature isn’t a good backup/restore type of functionality. They do have other functionality that supports backup/restore of the APIM service: https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-disaster-recovery-backup-restore”


But all I wanted was to export an API definition from the Export tool, and import it through the Import tool, not backing up and restoring the whole API Management service… 

Comments

Post a Comment

Popular posts from this blog

Cloud Computing using Microsoft Azure for Dummies

Image
Microsoft Azure is one of the first On-Demand Cloud Services available since several years, along with Amazon . So what is this Cloud Computing ? “Cloud computing, also known as 'on-demand computing', is a kind of Internet-based computing, where shared resources, data and information are provided to computers and other devices on-demand” [ Wikipedia ] Since a few years, and especially thanks to the worldwide Globalization , the amount of data exchanged over the Internet has been growing exponentially, bringing into the game some new paradigm such as Big Data , which challenged the existing hardware and infrastructure at every level. Most public exposed systems and websites had suddenly to deal with a huge amount of traffic, data and requests, from any part of the world, with potential peaks at any given time, 24/7.  This represented a big challenge for the stability and availability of systems, which for most businesses required an incredib...
Read more

RabbitMQ on Kubernetes Container Cluster in Azure

Image
Introduction This post is quite technical (and long, and detailed), so sit down, enjoy your coffee, and let’s get started! Containers are becoming the way forward in the DevOps and IT worlds, as they greatly simplify deployments of applications and IT infrastructure . RabbitMQ is “the most widely deployed open source message broker”, and easy to use within a Docker Container Image . Kubernetes is considered the De-facto Standard for Container Orchestration . To follow this tutorial you can use the built in Azure Cloud Shell , or download and install the Azure CLI , and use PowerShell locally. Make sure you have installed  Azure PowerShell . You will also need Kubectl , so make sure you install that too (I suggest Choco as the easiest way). Here I am using PowerShell . Resource Group First you have to login to Azure through PowerShell: az login You will receive a message such as: To sign in , use a web browser to open the page ...
Read more

PowerHell

Image
So here's another rant about Microsoft inconsistency and UN-usability of their products (sorry but I cannot hold this anymore).. Since it's been introduced years ago, Microsoft Powershell looked very promising, with its CMDLet approach to reuse scripts, not only for sysadmin tasks, but for almost everything Microsoft . There is only one problem with it (still nowadays): inconsistency . The reason why I say this, is because most of the times (I am serious, most of them) I try to use Powershell , I get the famous error message: The term '[ Put your Powershell Module name here]' is not recognized as the name of a cmdlet, function, script file, or operable program. That seems like a trivial error, so the next thing to do is to install the missing module. This generally requires a few steps: Figure out which module contains the command you are trying to run (not always straightforward). Figure out which version of the module contains the exact comman...
Read more