Workflow fails, json regarded as not valid because of property "user-key"

[fritz-raphael]

Select Topic Area

Question

Body

I'm using Github Actions to deploy an instance of Azure Data Factory (ADF). Resources are saved as json files, and the deployment script picks them up and creates or updates resources in the target instance using the Set-AzDataFactoryV2Pipeline-function in PowerShell. This process has worked for several months, but since last week, I get an error when trying to deploy a pipeline with a certain pattern.

We use an API for which we use an attribute user-key in the request header for authentication. This user-key is stored in a key vault, retrieved by a parent pipeline, and passed to that pipeline as a parameter. The json of the part that fails looks like this:

...
"typeProperties": {
    "method": "POST",
    "url": {
        "value": "@parameters.API_URL",
        "type": "Expression"
    },
    "headers": {
        "user-key": {
            "value": "@pipeline().parameters.API_userkey",
            "type": "Expression"
        }
    },
    "body": {
        "message": "test"
    }
}
...

This is valid json and working fine in ADF. However, during deployment the code fails and returns the following error message (in short: the "user-key" attribute is invalid):

Failed to deploy pipeline Call_API. Error message: Json is not valid. Details: 'Newtonsoft.Json.JsonReaderException: Error reading string. Unexpected token: StartObject. Path 'typeProperties.headers.user-key', line 26, position 19.
   at Newtonsoft.Json.JsonReader.ReadAsString()
   at Newtonsoft.Json.JsonReader.ReadForType(JsonContract contract, Boolean hasConverter)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.PopulateDictionary(IDictionary dictionary, JsonReader reader, JsonDictionaryContract contract, JsonProperty containerProperty, String id)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateObject(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateValueInternal(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Deserialize(JsonReader reader, Type objectType, Boolean checkAdditionalContent)
   at Newtonsoft.Json.Linq.JToken.ToObject(Type objectType, JsonSerializer jsonSerializer)
   at Microsoft.Rest.Serialization.PolymorphicDeserializeJsonConverter`1.ReadJson(JsonReader reader, Type objectType, Object existingValue, JsonSerializer serializer)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.DeserializeConvertable(JsonConverter converter, JsonReader reader, Type objectType, Object existingValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.PopulateList(IList list, JsonReader reader, JsonArrayContract contract, JsonProperty containerProperty, String id)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateList(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, Object existingValue, String id)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateValueInternal(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Deserialize(JsonReader reader, Type objectType, Boolean checkAdditionalContent)
   at Newtonsoft.Json.Linq.JToken.ToObject(Type objectType, JsonSerializer jsonSerializer)
   at Microsoft.Rest.Serialization.TransformationJsonConverter.ReadJson(JsonReader reader, Type objectType, Object existingValue, JsonSerializer serializer)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.DeserializeConvertable(JsonConverter converter, JsonReader reader, Type objectType, Object existingValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Deserialize(JsonReader reader, Type objectType, Boolean checkAdditionalContent)
   at Newtonsoft.Json.JsonSerializer.DeserializeInternal(JsonReader reader, Type objectType)
   at Microsoft.Rest.Serialization.SafeJsonConvert.DeserializeObject[T](String json, JsonSerializerSettings settings)
   at Microsoft.Azure.Commands.DataFactoryV2.DataFactoryClient.CreateOrUpdatePipeline(String resourceGroupName, String dataFactoryName, String pipelineName, String rawJsonContent)'.Exception.Message

However, when I hard-code the user-key as a string, the deployment works fine. I assume that this has to do with the way the function is reading the json, so referencing the "user-key" attribute as typeProperties.header.user-key which might be regarded as invalid. But since I'm only evoking an external function of a PowerShell module, I can't customize the way I read the json (at least not that I am aware of). But I have no idea why it works fine when the value of that attribute is just a string.

Did anything change from Github's side so this is failing? I didn't find anything related to this issue on the release notes for the Azure PowerShell module.

For reference, I'm using a Github-hosted runner version 2.314.1 on windows-latest, but ubuntu-latest gives the same results. The deployment has been working fine under runner-version 2.313.0.

[fritz-raphael]

This is resolved. A couple of weeks later, the deployments work fine again, the user-key attribute is interpreted fine.