Docs for ArmDeploymentProperties.Parameters are not specific enough

[JoshLove-msft]

The generated docs seem to be the same for all BinaryData properties, but for Parameters, the "value" in the key value pair needs to itself be a JSON object, so the example should have:

BinaryData.FromObjectAsJson(new { parameterName = { value = "parameterValue" })

As opposed to what it currently has:

BinaryData.FromObjectAsJson(new { key = "value" })

I know this is generated, but it would be good to improve this.

[abatishchev]

hi @jsquire, can you please help to triage and address the issue? I agree, the doc is confusing (insufficient).

If I use just this:

var parameters = new
{
    accountName = "contoso"
};

instead of this:

var parameters = new
{
    accountName = new
    {
        value = "contoso"
    }
};

I'm getting a cryptic error:

Azure.RequestFailedException: The request content was invalid and could not be deserialized: 'Error converting value "contoso" to type 'Azure.Deployments.Core.Definitions.DeploymentParameterDefinition'. Path 'properties.parameters.accountName'

[jsquire]

//cc: @ArthurMa1978

[jsquire]

@abatishchev - Thanks for the heads-up. Looks like this didn't get assigned when opened; its been routed to the folks who own the resource manager libraries for follow-up.

[HarveyLink]

@jsquire This issue was opened by Josh, looks like it is a feature improvement issue for the SDK comment doc.
@abatishchev We'll consider improve the comment text in the furture.