APIM Version Set name - How to find and set it from Portal?

Question

I am using Azure APIOPS CI/CD process to do CI/CD of APIM and artifacts.
To extract and publish Versionset, the tool need to specify versionset name (not the display name).
I can find the actual name by using az cli. However it is cumbersome
az apim api versionset list --resource-group apim --service-name martinapimext

Q1. Is there a way to find Version Set name from portal? (Not the display name, but the actual name)
Q2. Is there a way to specify Version set name (not the display name) when creating versions , so that meaningful names can be assigned to version set, which can later be referenced in API OPS CI/CD process.
Q3. Once an api version is created which will automatically create a version set, can the version set actual name be changed via az cli? I suppose not, because the respective api versions are linked to version set via versionset name.
Q4. Can an RFE be submitted to allow az portal to be able to supply a versionset name when the first version of an API is created ?

Answer

Hi @Martin Kallukalam

According to Api Version Set - REST API (Azure API Management) | Microsoft Learn, you can view Version Sets and update the name and description to your choosing. If you're not seeing this experience after selecting the APIM version, let me know.

Another option is to use Api Version Set - REST API (Azure API Management) | Microsoft Learn instead. There are update method is the same as the create method, which accepts a body response like

{
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

But it doesn't have a property for the version set name. I have to confirm, but for Q2, since the version set name is maintained by the service by using the display name and version scheme, it can't be customized. I agree with you on Q3, but I think you can use still use the update REST API to update the display name and/or versioning scheme which should reflect in the version set. I can pass this feedback along to the product team and see if and how it can be addressed.

Share via

APIM Version Set name - How to find and set it from Portal?

1 answer

Your answer