Azure APIM subscription 'Display Name' does not accept user defined value

Question

Azure APIM subscription 'Display Name' does not accept user defined value

Kanagaraj Subramaniam 5

Trying to achieve product subscription through subscription api (https://management.azure.com/subscriptions/{subscription}resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2021-08-01) and the request payload contains (displayname, scope, ownerid and state). Once the product subscription is created through api the display name shows "product {my product name} Subscription} instead of that I have provided.

Whether am I missing anything?

Ref: https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-setup-delegation https://learn.microsoft.com/en-us/rest/api/apimanagement/current-ga/subscription/create-or-update?tabs=HTTP

MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-10T20:00:29.85+00:00
Kanagaraj Subramaniam Thanks for posting your question in Microsoft Q&A. I have created a subscription for a Product via Portal (doc reference) as well as Try it in Subscription API and both worked as expected with the correct display name. Here is the sample payload that I tested:

{ "properties": { "displayName": "New Test Subscription", "scope": "/products/starter", "ownerId": "/users/user1", "state": "active" } }

Where do you see display name as "product {my product name} Subscription}? API response or azure portal or your application? Also, how do you consume this API? through Try it option in API page or tool like Postman or your application?

If you are validating via application/tool, then validate full payload request and response. I would also suggest directly testing it via Try it option and if still facing the issue, let me know x-ms-correlation-request-id.

Kanagaraj Subramaniam 5

Hi @MuthuKumaranMurugaachari-MSFT -

I am creating the subscription through application code and the api call sample is below, and the subscription display name I could see it in azure portal, developer portal once it is created through Api.

API call Snippet:

ApimSubscriptionRequest apimSubscriptionRequest = new ApimSubscriptionRequest
                {
                    DisplayName = $"{productId}-{subscriptionId:N}",//subscription name
                    OwnerId = "/users/" + userId,
                    Scope = "/products/" + productId,
                    State = "active",
                    PrimaryKey = subscriptionId.ToString("N")
                };

                HttpResponseMessage response = await client.PutAsync($"subscriptions/{subscriptionId}?api-version={_apimRestApiVersion}", GetContent(SerializeToJson(apimSubscriptionRequest)));

Azure APIM Portal shows -

User's image

1 answer

Your answer

MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-10T20:00:29.85+00:00

Kanagaraj Subramaniam Thanks for posting your question in Microsoft Q&A. I have created a subscription for a Product via Portal (doc reference) as well as Try it in Subscription API and both worked as expected with the correct display name. Here is the sample payload that I tested:

{ "properties": { "displayName": "New Test Subscription", "scope": "/products/starter", "ownerId": "/users/user1", "state": "active" } }

Where do you see display name as "product {my product name} Subscription}? API response or azure portal or your application? Also, how do you consume this API? through Try it option in API page or tool like Postman or your application?

If you are validating via application/tool, then validate full payload request and response. I would also suggest directly testing it via Try it option and if still facing the issue, let me know x-ms-correlation-request-id.
Kanagaraj Subramaniam 5 Reputation points

2023-02-14T14:45:02.7033333+00:00

Hi @MuthuKumaranMurugaachari-MSFT -

I am creating the subscription through application code and the api call sample is below, and the subscription display name I could see it in azure portal, developer portal once it is created through Api.

API call Snippet:

ApimSubscriptionRequest apimSubscriptionRequest = new ApimSubscriptionRequest { DisplayName = $"{productId}-{subscriptionId:N}",//subscription name OwnerId = "/users/" + userId, Scope = "/products/" + productId, State = "active", PrimaryKey = subscriptionId.ToString("N") }; HttpResponseMessage response = await client.PutAsync($"subscriptions/{subscriptionId}?api-version={_apimRestApiVersion}", GetContent(SerializeToJson(apimSubscriptionRequest)));

Azure APIM Portal shows -

Answer 1

MuthuKumaranMurugaachari-MSFT 22,416

Kanagaraj Subramaniam Thanks for sharing the code snippet. It appears that you have defined model class ApimSubscriptionRequest in your application and performing some JSON serialization/processing using GetContent(SerializeToJson(apimSubscriptionRequest))) functions before calling Rest API. I would suggest you capture Http request, payload info either while debugging or using tools like Fiddler and investigate the issue. If you still help, please share request info/payload (removing critical/sensitive info) and correlation ID.

Alternatively, you can quickly test it via portal, Rest API directly and see whether you are able to reproduce the issue. If you observe the issue only with the application code (not Rest API - Try it/portal), then submit a ticket to our support team and they have the best resources/tools to investigate the backend logs for the cause.

I hope this helps your question and feel free to add a comment for any other questions.

Kanagaraj Subramaniam 5 Reputation points

2023-02-15T19:24:54.0466667+00:00

@MuthuKumaranMurugaachari-MSFT I have attached below the sample request payload that we try to process,

{ "properties" :{"DisplayName":"Sandbox-38efdfa36f6541e5a8eeaee93a0d1cf9","OwnerId":"/users/1","Scope":"/products/Sandbox","State":"active","PrimaryKey":"38efdfa36f6541e5a8eeaee93a0d1cf9"}}

In the payload we are passing product id, owner id, state and primary key which all were assigned/processed successfully in the api call where only Display name does not reflect.
MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-15T19:39:04.01+00:00

Kanagaraj Subramaniam I have tested the API with similar payload via Try it Rest Api and couldn't reproduce the issue. It saved successfully and returned response as 201 as shown below:

The same has been reflected in the azure portal as well.

This requires deeper investigation to review backend logs for your APIM instance, correlation id, timestamp etc. (cannot share the info publicly) and hence our support team are the best way to find the cause. They have the best tools and resources to quickly help with this issue.

Do you have support plan with us? If not, let me know so that I can assist with the next steps in creating a one-time free technical support for you. Feel free to share if you have any thoughts or questions.
Kanagaraj Subramaniam 5 Reputation points

2023-02-17T04:33:02.56+00:00

Hi @MuthuKumaranMurugaachari-MSFT - Thanks for your verification and update, we've Azure support plan with MS, so let me post the ticket to support team and continue tracking the update with support channel. Thanks.
MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-17T14:27:16.4+00:00

Kanagaraj Subramaniam Sounds good. Feel free to reach out for any other questions.

Share via

Azure APIM subscription 'Display Name' does not accept user defined value

1 answer

Your answer