[BUG] Clarification on Handling Escape Characters in Azure Key Vault Secrets about azure-sdk-for-net HOT 3 CLOSED

Hi @bchr02. Thanks for reaching out and we regret that you're experiencing difficulties. The KeyVault service API is based on JSON payloads. The data sent and received by the client library is encoded to JSON or decoded from JSON using the System.Text.Json. Your secret is otherwise treated as an opaque value with no escaping or other inspection/alteration performed.

For example, following the KeyVault serialization logic shows that serialization/deserialization of a multi-line string value does not inject any escape characters or alter the form:

var multiLineValue = @"test
multi-line
thing

one more";

using var stream = new MemoryStream();
using var writer = new Utf8JsonWriter(stream);
        
writer.WriteStartObject();
writer.WriteString(JsonEncodedText.Encode("value"), multiLineValue);
writer.WriteEndObject();
writer.Flush();
    
using var doc = JsonDocument.Parse(Encoding.UTF8.GetString(stream.ToArray()));
var prop = (JsonProperty)doc.RootElement.EnumerateObject().First();

Console.WriteLine($"[{prop.Value.GetString()}]");   

If you are seeing changes made to your payload while not in transit, they are being made by something other than the Azure SDK client, such as by another tool within the Azure Container Apps secret feature or within the KeyVault service itself. This is not something that the Azure SDK package has insight into nor influence over and the maintainers of the library are unable to assist in troubleshooting them.

Your best path forward to find a root cause would be to open an Azure support request for Container Apps or inquire on the Microsoft Q&A site.

from azure-sdk-for-net.

Hi @bchr02. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.

from azure-sdk-for-net.

Hi @bchr02, since you haven’t asked that we /unresolve the issue, we’ll close this out. If you believe further discussion is needed, please add a comment /unresolve to reopen the issue.

from azure-sdk-for-net.