├── .github └── ISSUE_TEMPLATE │ └── prompt-suggestion.yml ├── CODE_OF_CONDUCT.md ├── LICENSE ├── README.md ├── SECURITY.md └── SUPPORT.md /.github/ISSUE_TEMPLATE/prompt-suggestion.yml: -------------------------------------------------------------------------------- 1 | name: Prompt Suggestion 2 | description: Suggest a prompt related to Infrastructure as Code (IaC) 3 | title: "" 4 | labels: ["enhancement"] 5 | body: 6 | - type: checkboxes 7 | id: confirm 8 | attributes: 9 | label: Confirm 10 | description: Please confirm you have read the prompt writing guide in the [README](https://github.com/stemaMSFT/AI-IaC-Prompts/blob/main/README.md) and searched for similar issues to avoid duplication. 11 | options: 12 | - label: I have read the guide to writing a good prompt and have searched for duplicate issues. I have titled this issue with my prompt for clarity. 13 | required: true 14 | - type: input 15 | id: prompt 16 | attributes: 17 | label: Prompt 18 | description: What is the suggested prompt you're submitting? 19 | placeholder: ex. How do I deploy a virtual network? 20 | validations: 21 | required: true 22 | - type: checkboxes 23 | id: tool 24 | attributes: 25 | label: Tool 26 | description: What deployment tool(s) does this prompt apply to? 27 | options: 28 | - label: Bicep 29 | - label: Terraform 30 | - label: ARM Template 31 | - label: Other 32 | validations: 33 | required: true 34 | - type: textarea 35 | id: expected 36 | attributes: 37 | label: Expected Outputs 38 | description: Please specify what you expect to be the output of the prompt. 39 | placeholder: | 40 | "Ex: A resource definition for virtual network." 41 | validations: 42 | required: true 43 | - type: textarea 44 | id: current 45 | attributes: 46 | label: Current Outputs 47 | description: Detail what outputs you currently are getting. Screenshots are welcome. 48 | placeholder: | 49 | "Ex: The resource definition is out of date and does not include the latest features." 50 | validations: 51 | required: false 52 | - type: checkboxes 53 | id: copilot 54 | attributes: 55 | label: Copilot 56 | description: If you shared an output, please specify which copilot you used. 57 | options: 58 | - label: GitHub Copilot 59 | - label: Azure Copilot 60 | - label: ChatGPT 61 | - label: Other 62 | validations: 63 | required: false 64 | - type: textarea 65 | id: notes 66 | attributes: 67 | label: Other Notes 68 | description: Please add any other notes about the issue here. 69 | placeholder: | 70 | "Ex: My virtual network requires a dev tag as well." 71 | validations: 72 | required: false -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Microsoft Open Source Code of Conduct 2 | 3 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). 4 | 5 | Resources: 6 | 7 | - [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) 8 | - [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) 9 | - Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Microsoft Corporation. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AI-IaC-Prompts 2 | Give your feedback or thoughts on what prompts you would like to see improved by the Azure Deployments team. 3 | 4 | ## Submitting a prompt 5 | Create a new issue by using the [provided "feature request" template](https://github.com/Azure/AI-IaC-Prompts/issues/new?assignees=&labels=enhancement&projects=&template=prompt-suggestion.yml&title=%3Cinsert+prompt+here%3E). Please ensure that you have checked for any duplicate issues before creating the issue. If you are inserting a prompt with sensitive data, make sure to redact any private info before creating your issue. 6 | 7 | ### **IMPORTANT** What's a good prompt to submit to this forum? 8 | For the purposes of this forum, a good prompt meets the following criteria: 9 | - Can be run in Copilot with a specific expected result 10 | - Specific resource types should be involved at some point contextually. This can be explicit (i.e. create a VM), or implicit (i.e. create a three-tiered application) 11 | - Expected result is generic enough to apply to other customers. While specific prompts are necessary for personal Copilot use, they will likely be unapplicable to others and thus deprioritized. Improving a generic variation of the specific prompt will improve the specific output. 12 | - Action required is not trivial (user could not easily accomplish on their own) 13 | - Prompt is relevant to IaC 14 | 15 | Examples of good prompts: 16 | - Help me set up a three-tiered application 17 | - Create a role assignment with read permissions for my resource group "good-example-rg" (specific RG name is ok) 18 | - Help upgrade this existing code tied to vX.XX to vX.XX 19 | 20 | Examples of bad prompts: 21 | - Deploy for me X resources in my resource group "bad-example-rg" (too generic, no specific resource types) 22 | - Add a tag to a resource (trivial action) 23 | - Check the status of my VM (would not use IaC) 24 | - Deploy for me three VMs named "joe" "jill" and "jack", two virtual networks named "nate" and "natalie", one AKS cluster named "cluster1", and five storage accounts "one" "two "three" "four" and "five" under resource group "bad-example-rg" (overly specific/wordy and thus unlikely to apply to others, could be made good with generalization) 25 | 26 | ## Disclaimers 27 | The Azure Deployments team does NOT guarantee that they will make submitted prompts work with full confidence or functionality. Input will be taken to help make best efforts to improve your Copilot IaC experience. Issues will be closed when the team deems that the best effort has been made. 28 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Security 4 | 5 | Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin). 6 | 7 | If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below. 8 | 9 | ## Reporting Security Issues 10 | 11 | **Please do not report security vulnerabilities through public GitHub issues.** 12 | 13 | Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report). 14 | 15 | If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp). 16 | 17 | You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 18 | 19 | Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: 20 | 21 | * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) 22 | * Full paths of source file(s) related to the manifestation of the issue 23 | * The location of the affected source code (tag/branch/commit or direct URL) 24 | * Any special configuration required to reproduce the issue 25 | * Step-by-step instructions to reproduce the issue 26 | * Proof-of-concept or exploit code (if possible) 27 | * Impact of the issue, including how an attacker might exploit the issue 28 | 29 | This information will help us triage your report more quickly. 30 | 31 | If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs. 32 | 33 | ## Preferred Languages 34 | 35 | We prefer all communications to be in English. 36 | 37 | ## Policy 38 | 39 | Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd). 40 | 41 | 42 | -------------------------------------------------------------------------------- /SUPPORT.md: -------------------------------------------------------------------------------- 1 | # TODO: The maintainer of this repo has not yet edited this file 2 | 3 | **REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project? 4 | 5 | - **No CSS support:** Fill out this template with information about how to file issues and get help. 6 | - **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps. 7 | - **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide. 8 | 9 | *Then remove this first heading from this SUPPORT.MD file before publishing your repo.* 10 | 11 | # Support 12 | 13 | ## How to file issues and get help 14 | 15 | This project uses GitHub Issues to track bugs and feature requests. Please search the existing 16 | issues before filing new issues to avoid duplicates. For new issues, file your bug or 17 | feature request as a new Issue. 18 | 19 | For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE 20 | FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER 21 | CHANNEL. WHERE WILL YOU HELP PEOPLE?**. 22 | 23 | ## Microsoft Support Policy 24 | 25 | Support for this **PROJECT or PRODUCT** is limited to the resources listed above. 26 | --------------------------------------------------------------------------------