Cannot create API on Azure API Management which contains {} in the URL Path using bicep

Question

Cannot create API on Azure API Management which contains {} in the URL Path using bicep

Nagul M Shaik 20

resource apiOperation 'Microsoft.ApiManagement/service/apis/operations@2022-08-01' = {

name: '${apimName}/${apiName}/${operationName}'

properties: {

displayName: operationName

method: method

urlTemplate: urlTemplate

description: operationDescription

request: {

  description: '${method} request for ${operationName}'

  headers: headers

}

}

urlTemplate value should be {purchaseorder} , but when I give it in bicep the validation failing, cannot create API, even tried with different combinations including double quotes, single quotes around the brackets or within it.

is there way we can make sure the bicep passes {} as a string ?

Ranashekar Guda 2,905 Reputation points Moderator

2025-05-29T00:21:07.8166667+00:00
Hello @Nagul M Shaik,
To pass curly braces {} as a string in Bicep, you can use double curly braces {{}}. This way, Bicep will interpret the double curly braces as a single curly brace in the final output.

Here is an example of how you can define the urlTemplate property in your Bicep file to include {purchaseorder} as a string:

resource apiOperation 'Microsoft.ApiManagement/service/apis/operations@2022-08-01' = { name: '${apimName}/${apiName}/${operationName}' properties: { displayName: operationName method: method urlTemplate: '{{purchaseorder}}' description: operationDescription request: { description: '${method} request for ${operationName}' headers: headers } } }

By using {{purchaseorder}}, Bicep will treat it as a string {purchaseorder} in the final output, allowing you to include curly braces in the URL path without causing validation issues.
Kindly refer below link:
Quickstart: Create a new Azure API Management service instance using Bicep

Hope this helps. Do let us know if you any further queries.

Answer accepted by question author

0 additional answers

Your answer

Ranashekar Guda 2,905 Reputation points Moderator

2025-05-29T00:21:07.8166667+00:00

Hello @Nagul M Shaik,
To pass curly braces {} as a string in Bicep, you can use double curly braces {{}}. This way, Bicep will interpret the double curly braces as a single curly brace in the final output.

Here is an example of how you can define the urlTemplate property in your Bicep file to include {purchaseorder} as a string:

resource apiOperation 'Microsoft.ApiManagement/service/apis/operations@2022-08-01' = { name: '${apimName}/${apiName}/${operationName}' properties: { displayName: operationName method: method urlTemplate: '{{purchaseorder}}' description: operationDescription request: { description: '${method} request for ${operationName}' headers: headers } } }

By using {{purchaseorder}}, Bicep will treat it as a string {purchaseorder} in the final output, allowing you to include curly braces in the URL path without causing validation issues.
Kindly refer below link:
Quickstart: Create a new Azure API Management service instance using Bicep

Hope this helps. Do let us know if you any further queries.

Answer 1

Hi @Nagul M Shaik ,

Using flower braces directly is not supported but to send a value during the execution time and to use {} inside the urlTemplate, one has to also define templateParameters as below:

param rithapimNme string = 'testapirith'
param apiName string = 'sample-api'
param riopname string = 'get-operation'
resource api 'Microsoft.ApiManagement/service/apis@2022-08-01' = {
  name: '${rithapimNme}/${apiName}'
  properties: {
    displayName: 'Sample API'
    path: apiName
    protocols: [ 'https' ]
    serviceUrl: 'https://httpbin.org/anything' 
  }
}
resource apiOperation 'Microsoft.ApiManagement/service/apis/operations@2022-08-01' = {
  name: '${rithapimNme}/${apiName}/${riopname}'
  dependsOn: [ api ]
  properties: {
    displayName: 'Get the Order'
    method: 'GET'
    urlTemplate: '{purchaseorder}'  
    templateParameters: [
      {
        name: 'purchaseorder'
        type: 'string'
        required: true
        description: 'Purchase order ID'
      }
    ]
    request: {
      description: 'Hey Rithwik, Test request for Operation'
      queryParameters: []
      headers: []
    }
    responses: [
      {
        statusCode: 200
        description: 'Succeeded'
        representations: []
      }
    ]
  }
}

Output:

If Value given it changes as below:

enter image description here

If this answer was helpful, please click "Accept the answer" and mark Yes, as this can help other community members.

enter image description here

If you have any other questions or are still experiencing issues, feel free to ask in the "comments" section, and I'd be happy to help.

RChotu 3,210 Reputation points Microsoft External Staff Moderator

2025-05-30T05:14:32.1833333+00:00

Hi @Nagul M Shaik ,I wanted to follow up and see if the given answer was helpful. If this resolves your issue, please click Accept Answer and kindly upvote it. If you have any further questions about this answer, please click Comment.
RChotu 3,210 Reputation points Microsoft External Staff Moderator

2025-06-02T04:55:08.26+00:00

Hi @Nagul M Shaik ,I wanted to follow up and see if the given answer was helpful. If this resolves your issue, please click Accept Answer and kindly upvote it. If you have any further questions about this answer, please click Comment.
Nagul M Shaik 20 Reputation points

2025-06-05T13:39:03.09+00:00

Hello @RChotu

Thank you for the response, yes, This did the trick and resolved the issue.

urlTemplate: '{purchaseorder}'

templateParameters: [

{ name: 'purchaseorder' type: 'string' required: true description: 'Purchase order ID' }

]

Share via

Cannot create API on Azure API Management which contains {} in the URL Path using bicep

0 additional answers

Your answer