How to add APIs of serverless llm deployments(on AI foundary) to Azure API management service?

Question

How to add APIs of serverless llm deployments(on AI foundary) to Azure API management service?

Vivek Kumar 45

I am adding multiple APIs in Azure API management service instance(Consumption plan) using Azure portal by option Add API>Create from definition>OpenAPI. Now in that i am able to add azure openai apis using swagger or inference.json from azure-rest-api-specs
Now for adding api of serverless llm deployment like Meta-Llama-3-8B-Instruct, after deploying the model in AI Foundary we get the swagger.json for the deployment as a url. I downloaded it and used the same for adding the api, but got this error

Parsing error(s): redact is not a valid property at #/components/schemas/ChatCompletionRequest/properties/messages [] redact is not a valid property at #/components/schemas/ChatCompletionRequest/properties/stop [] redact is not a valid property at #/components/schemas/ChatCompletionRequest/properties/tools [] redact is not a valid property at #/components/schemas/ChatCompletionRequest/properties/user [] redact is not a valid property at #/components/schemas/ChatCompletionRequestOssVllm/properties/messages [] redact is not a valid property at #/components/schemas/ChatCompletionRequestOssVllm/properties/stop [] redact is not a valid property at #/components/schemas/ChatCompletionRequestOssVllm/properties/tools [] const is not a valid property at #/components/schemas/ToolType []
Parsing error(s): The input OpenAPI file is not valid for the OpenAPI specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md (schema https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.yaml).

The version of openai specification in swagger.json is openapi": "3.1.0" (while in the Azure openai models it is 3.0.0) . I also tried removing those redact and const lines still the api was not working. Please answer the following questions

Is openai specification openapi": "3.1.0" is supported by API Management consumption plan
How can I add the APIs of the serverless models(deployed in Azure AI foundary) in the APIM service. Are there any other ways

Please guide me in detail

Khadeer Ali 5,990 Reputation points Microsoft External Staff Moderator

2025-03-19T15:30:49.8066667+00:00
@Vivek Kumar ,

Yes, the Azure API Management service supports OpenAPI 3.1 for import only, meaning you can import definitions, but execution may fail if there are unsupported properties.

The errors related to redact and const indicate that these properties are not recognized in OpenAPI 3.1 as expected by Azure APIM. To resolve this:

Validate the OpenAPI Specification using tools like Swagger Editor.

Modify the swagger.json file by removing redact and const properties.

Consider downgrading the OpenAPI version to 3.0.3, which is fully supported in APIM.
Khadeer Ali 5,990 Reputation points Microsoft External Staff Moderator

2025-03-20T11:40:51.27+00:00

@Vivek Kumar ,

I wanted to check in and see if my earlier response addressed your question. If you still need assistance or have additional questions, feel free to share more details.
Vivek Kumar 45 Reputation points

2025-03-20T16:23:18.9033333+00:00

Hi Khadeer,
I have removed those properties then got the api working. But what if the redact properties are important, i hope there are no data leaks.
Khadeer Ali 5,990 Reputation points Microsoft External Staff Moderator

2025-03-20T17:33:27.9533333+00:00

@Vivek Kumar ,

Thanks for letting us know that the API working!.

Regarding the redact properties—if they were only metadata in the OpenAPI spec, removing them shouldn’t cause any issues. However, if they were actually used for masking sensitive data, we should verify whether any logs or responses now expose sensitive information.

One alternative is to handle redaction at the API Management level using policies to mask or remove sensitive data. Let me know if we need to explore that.
Vivek Kumar 45 Reputation points

2025-03-20T17:39:25.16+00:00

It is fine for now.

Thanks for your help

Accepted answer

0 additional answers

Your answer

Khadeer Ali 5,990 Reputation points Microsoft External Staff Moderator

2025-03-19T15:30:49.8066667+00:00

@Vivek Kumar ,

Yes, the Azure API Management service supports OpenAPI 3.1 for import only, meaning you can import definitions, but execution may fail if there are unsupported properties.

The errors related to redact and const indicate that these properties are not recognized in OpenAPI 3.1 as expected by Azure APIM. To resolve this:

Validate the OpenAPI Specification using tools like Swagger Editor.

Modify the swagger.json file by removing redact and const properties.

Consider downgrading the OpenAPI version to 3.0.3, which is fully supported in APIM.
Khadeer Ali 5,990 Reputation points Microsoft External Staff Moderator

2025-03-20T11:40:51.27+00:00

@Vivek Kumar ,

I wanted to check in and see if my earlier response addressed your question. If you still need assistance or have additional questions, feel free to share more details.
Vivek Kumar 45 Reputation points

2025-03-20T16:23:18.9033333+00:00

Hi Khadeer,
I have removed those properties then got the api working. But what if the redact properties are important, i hope there are no data leaks.
Khadeer Ali 5,990 Reputation points Microsoft External Staff Moderator

2025-03-20T17:33:27.9533333+00:00

@Vivek Kumar ,

Thanks for letting us know that the API working!.

Regarding the redact properties—if they were only metadata in the OpenAPI spec, removing them shouldn’t cause any issues. However, if they were actually used for masking sensitive data, we should verify whether any logs or responses now expose sensitive information.

One alternative is to handle redaction at the API Management level using policies to mask or remove sensitive data. Let me know if we need to explore that.
Vivek Kumar 45 Reputation points

2025-03-20T17:39:25.16+00:00

It is fine for now.

Thanks for your help

Answer 1

@Vivek Kumar ,

As per our discussion, the issue with importing the AI Foundry API into Azure API Management (APIM) was due to unsupported properties like redact and const in the OpenAPI 3.1 specification. After removing these properties, the API was successfully added.

Key Considerations & Solution Approach:

Validation & Modification of OpenAPI Specification

The Azure APIM Consumption Plan supports OpenAPI 3.0.x (fully) and 3.1 (import-only).
The original swagger.json contained properties (redact, const) that were not compliant with APIM’s expected schema.
Removing these properties allowed successful import.

Hope this helps. do click Accept Answer and Yes for "Was this answer helpful." And if you have any further questions, let us know.

Share via

How to add APIs of serverless llm deployments(on AI foundary) to Azure API management service?

0 additional answers

Your answer