Skip to content

Add quoting examples for containerapp secret set with special characters - #34093

Open
Alabi Toluwaleke (fvlga) wants to merge 1 commit into
Azure:devfrom
fvlga:docs-containerapp-secret-special-chars
Open

Alabi Toluwaleke (fvlga) wants to merge 1 commit into
Azure:devfrom
fvlga:docs-containerapp-secret-special-chars

Conversation

@fvlga

Copy link
Copy Markdown

Related command

az containerapp secret set

Description

Addressing #32658.

The examples for az containerapp secret set only showed a trivial secret value, with no guidance on handling values that contain spaces, colons, semicolons, double quotes, or apostrophes — characters commonly found in connection strings and generated passwords. This adds two new examples:

  1. A value with spaces, colons, and semicolons, demonstrating that the whole key=value pair should be single-quoted.
  2. A value containing an apostrophe, demonstrating that double-quoting the whole key=value pair avoids needing to escape the apostrophe.

A previous attempt at this (#32720) was opened and closed without merging; this addresses the same issue.

Testing Guide

Ran python -m py_compile on the modified _help.py to confirm it's still valid Python, and confirmed az containerapp secret set --help renders both new examples correctly. No functional change — help text only.

History Notes

N/A


This checklist is used to make sure that common guidelines for a pull request are followed.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

@microsoft-github-policy-service microsoft-github-policy-service Bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Sep 16, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

Thank you for your contribution Alabi Toluwaleke (@fvlga)! We will review the pull request and get back to you soon.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No unresolved issues were identified.

Pull request overview

Adds shell-quoting examples for az containerapp secret set values containing special characters.

Changes:

  • Added single-quoted example for spaces and punctuation.
  • Added double-quoted example for apostrophes.
File summaries
File Description
src/azure-cli/azure/cli/command_modules/containerapp/_help.py Extends secret-setting help examples.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@yonzhan

Copy link
Copy Markdown
Collaborator

containerapp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

act-observability-squad Auto-Assign Auto assign by bot ContainerApp customer-reported Issues that are reported by GitHub users external to the Azure organization.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants