Skip to content

Add Bicep JSON output sample to documentation #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 20, 2025

This PR adds documentation for using the --jsonOutput flag with Bicep files, which was missing from the documentation.

The change adds a new section titled "JSON Output with Bicep" to the display-options.MD file, showing how to use the --jsonOutput flag with a Bicep file. This makes it consistent with the existing documentation for ARM templates and provides users with a clear example of how to get JSON output when working with Bicep files.

Changes made:

  • Added a new section "JSON Output with Bicep" in the display-options.MD file
  • Included a complete example showing the command and expected output
  • Used consistent formatting and style with the existing documentation
  • Used the existing aks-private-subnet.bicep sample to demonstrate the feature

Fixes #87.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: maniSbindra <6338721+maniSbindra@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Add more bicep samples Add Bicep JSON output sample to documentation May 20, 2025
@Copilot Copilot AI requested a review from maniSbindra May 20, 2025 16:44
Copilot finished work on behalf of maniSbindra May 20, 2025 16:44
@maniSbindra
Copy link
Contributor

maniSbindra commented May 20, 2025

@copilot Please have a look at the bicep tests under https://github.com/Azure/mpf/tree/main/e2eTests. This will give you an idea of the different flags which can be passed to the utility when executing for bicep, based on which you can perhaps add more samples

Co-authored-by: maniSbindra <6338721+maniSbindra@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented May 20, 2025

@copilot Please have a look at the bicep tests under https://github.com/Azure/mpf/tree/main/e2eTests. This will give you an idea of the different flags which can be passed to the utility when executi...

I've added more Bicep examples to the documentation based on the e2eTests. The updates include:

  1. Detailed output with Bicep (--showDetailedOutput flag)
  2. Verbose logging with Bicep (--verbose flag)

These additions complement the existing JSON output example, providing users with a more comprehensive view of the different output options available when using Bicep files.

All examples use the same aks-private-subnet.bicep sample for consistency. The changes are in commit 3ac8e93.

Copilot finished work on behalf of maniSbindra May 20, 2025 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add more bicep samples
2 participants