Issue with OpenAPI file import in APIM

Question

Issue with OpenAPI file import in APIM

SALOMONE ANTONIO 0

Hi,

I'm trying to create an API by importing an OpenAPI yaml file, already validated with https://editor.swagger.io/ but I'm received the following errors:

Code: ValidationError

    *Message: URL template is invalid*

    *Target: value[8].urlTemplate    (ValidationError) URL template is invalid*

    *Code: ValidationError*

    *Message: URL template is invalid*

    *Target: value[9].urlTemplate    (ValidationError) URL template is invalid*

    *Code: ValidationError*

    *Message: URL template is invalid*

    *Target: value[10].urlTemplate   (ValidationError) URL template is invalid*

    *Code: ValidationError*

    *Message: URL template is invalid*

    *Target: value[11].urlTemplate   (ValidationError) All template parameters used in the UriTemplate must be defined in the Operation 'Container_SetMetadata', and vice-versa.*

    *Code: ValidationError*

    *Message: All template parameters used in the UriTemplate must be defined in the Operation 'Container_SetMetadata', and vice-versa.*

    *Target: value[11]       (ValidationError) URL template is invalid*

It seems additional requirements are checked for other the ones required by OpenAPI standard. Please see the here attached OpenAPI file I'm using: blob_openapi.yaml.txt

This is the az cli command I've ran:

APIMServiceName="My_APIM_Resopurce"

ResourceGroupName="My_Resource_Group"

APIId="azure-blob-storage"

APIPath="blob"

SpecificationFormat="OpenApi"

SpecificationPath="blob_openapi.yaml"

az apim api import --path $APIPath --resource-group $ResourceGroupName --service-name $APIMServiceName --api-id $APIId --specification-format $SpecificationFormat --specification-path $SpecificationPath

Thanks

Antonio

Alex Burlachenko 4,875 Reputation points

2025-05-06T09:52:02.7133333+00:00

SALOMONE ANTONIO Dear friend, could you please let me know if you’ve had a chance to check my response? If everything works, I’d really appreciate it if you could accept my answer. Best regards, Alex

1 answer

Your answer

Alex Burlachenko 4,875 Reputation points

2025-05-06T09:52:02.7133333+00:00

SALOMONE ANTONIO Dear friend, could you please let me know if you’ve had a chance to check my response? If everything works, I’d really appreciate it if you could accept my answer. Best regards, Alex

Answer 1

Alex Burlachenko 4,875

Hi Antonio,

Thank you for reaching out. The errors indicate URL template validation issues in your OpenAPI file. Azure API Management has specific requirements for URL templates and parameter definitions.

For guidance, please refer to Microsoft’s official documentation:

Import an OpenAPI specification

API Management policies for URL handling

Ensure all template parameters in your paths are explicitly defined in the corresponding operations.


Best regards,
Alex
PS If my answer help to you, please Accept my answer.
PPS that is my answer and it is not a comment :)

Ranashekar Guda 1,360 Reputation points Microsoft External Staff

2025-04-29T14:06:45.95+00:00

Hello @SALOMONE ANTONIO,
Just checking in to see if the above answer provided by @Alex Burlachenko helped.

if you have any further query do let us know.
Ranashekar Guda 1,360 Reputation points Microsoft External Staff

2025-04-30T13:43:08.7733333+00:00

Hi @SALOMONE ANTONIO,
We haven’t heard from you on the last response and was just checking back to see if you have a resolution yet.
SALOMONE ANTONIO 0 Reputation points

2025-05-02T05:09:46.9366667+00:00

Hi Ranasheker,

I don't have a solution for the issue. Since I've an OpenAPI spec file, validated by https://editor.swagger.io/ that is not imported in APIM.Moreover, the spec file is provided by Microsoft, since it is for Azure Blob Storage REST API and I've download it from the following link: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-07-05/blob.json

Thanks

Antonio
SALOMONE ANTONIO 0 Reputation points

2025-05-06T21:09:17.6866667+00:00

Hello @Ranashekar Guda ,

did you have had the opportunity the see my latest comment ?

Thanks

Antonio

Share via

Issue with OpenAPI file import in APIM

1 answer

Your answer