Creating API management policy fragment with c# snippet containing double quotes

[christian-jendeberg-sj]

I am trying to automate the creation of a fragment with Bicep. I am using the resource something similar to this

resource symbolicname 'Microsoft.ApiManagement/service/policyFragments@2022-08-01' = {
name: 'myFragment'
parent: apimResource
properties: {
description: 'my fragment description'
format: 'xml'
value: loadTextContent('myPolicyFragment.xml')
}
}

and the myPolicyFragment.xml file starts with these lines

...

The problem seems to be that the xml syntax is invalid, containing C# snippets with double quotes.
Any ideas on how to achieve this, without changing the logic in the fragment?

[brwilkinson]

@christian-jendeberg-sj

are you able to share the fragment?

<fragment>
    <set-header name="x-request-context-data" exists-action="override">
      <value>@(context.User.Id)</value>
      <value>@(context.Deployment.Region)</value>
    </set-header>
</fragment>

The above works fine and I also tested a few others without any issues.

resource APIM 'Microsoft.ApiManagement/service@2022-09-01-preview' existing = {
  name: 'AEU1-PE-AKS-D2-apim01'
}

resource myFragment 'Microsoft.ApiManagement/service/policyFragments@2022-08-01' = {
  name: 'myFragment'
  parent: APIM
  properties: {
    description: 'x-request-context-data'
    format: 'xml'
    value: loadTextContent('loadtextcontent/fragment-request-context-data.xml')
  }
}

right click "Build ARM Template" to get the json version

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.17.104.16619",
      "templateHash": "6228299398059222876"
    }
  },
  "variables": {
    "$fxv#0": "<fragment>\r\n    <set-header name=\"x-request-context-data\" exists-action=\"override\">\r\n      <value>@(context.User.Id)</value>\r\n      <value>@(context.Deployment.Region)</value>\r\n    </set-header>\r\n</fragment>"
  },
  "resources": [
    {
      "type": "Microsoft.ApiManagement/service/policyFragments",
      "apiVersion": "2022-08-01",
      "name": "[format('{0}/{1}', 'AEU1-PE-AKS-D2-apim01', 'myFragment')]",
      "properties": {
        "description": "x-request-context-data",
        "format": "xml",
        "value": "[variables('$fxv#0')]"
      }
    }
  ]
}

Please also ensure you are using a later version of Bicep.

code --list-extensions --show-versions --category Azure
> ms-azuretools.vscode-bicep@0.17.1

bicep --version
> Bicep CLI version 0.17.104 (40eb1127ff)

Then also please share if you have enabled any preview features. e.g. if you have modified the bicepconfig.json file

[brwilkinson]

Hi @christian-jendeberg-sj

I was able to get valid XML with the following

1. Use single quotes, which then wrap double quotes and expression
   <when condition='@(!context.Variables.ContainsKey("AccessToken"))'>

2. I had issues with the < > so I tried < and >
<set-variable name="ResponseJObject" value='@(((IResponse)context.Variables["AccessTokenResponse"]).Body.As&lt;JObject&gt;())' />

By doing these I was able to get these to deploy

After the deployment the sample appears correct with the double quotes and <>

[christian-jendeberg-sj]

Marvelous, didn't think of using single quotes, since I assumed that wouldn't be valid xml either.
Thanks a lot for this!

[brwilkinson]

I used an xml validation tool... To test and update the format prior to deploying.

Please provide an update once you test.

[christian-jendeberg-sj]

That did the trick! I actually replaced all sorrounding double quotes with single quotes, for all C# snippets and didn't even have to bother about the escaping of the <JObject>.
Yet again, a huge thanks!

[kamilzzz]

Using most recent API version, that is 2023-05-01-preview, I was able to successfully deploy policy with type set to 'rawxml'. No need to replce double quotes with single quotes nor encoding <, > characters.