Tell us about your PDF experience.

GitHub Copilot for Azure Preview

Use AI to add cloud features and deploy your app to Azure

Get Started

ｅ OVERVIEW

Overview

Get Started with GitHub Copilot for Azure Preview

Quickstart - Building, Deploying and Improving your application with GitHub Copilot for Azure
Preview

Prompts for Azure

ｅ OVERVIEW

Learn about Azure and your application

Design and develop your app

Deploy your app

Troubleshoot your app

Optimize your app

What is GitHub Copilot for Azure
Preview?
Article • 11/18/2024

GitHub Copilot for Azure Preview is a GitHub Copilot extension that enables developers
to use natural language to:

Learn about Azure features.

Deploy Azure resources.
Get information about Azure resources.
Diagnose and troubleshoot problems with Azure resources.

GitHub Copilot for Azure is currently available for Visual Studio Code. You must have
access to an Azure subscription and be subscribed to GitHub Copilot.

GitHub Copilot is designed to help developers, including those who are new to Azure, to
be more productive as quickly as possible. For experienced Azure users, GitHub Copilot
for Azure saves time because they can access Azure functionality without needing to
look up commands and arguments, and without needing to sign in and browse through
the Azure portal.

Primary scenarios
GitHub Copilot for Azure Preview currently enables four primary scenarios:

ﾉ Expand table

Category Explanation Examples

Learn Learn about Azure services and "@azure What Azure services should I
tools from the latest Microsoft use with my app?"
Learn documentation. "@azure What are the available types of
Azure OpenAI models?"
"@azure What is Azure AI Search and
why should I use it?"
"@azure How does pricing work for
Azure SQL?"

Design and Ask for guidance and help "@azure Can you help me build a RAG
develop when building apps for the application with Python?"
cloud. "@azure Use azd to undeploy my
project."
 Category Explanation Examples

"@azure We are a pizza company and

want to create an online customized
pizza delivery solution. Create an API to
accept pizza orders."

Deploy Create Azure resources and "@azure Can you help me deploy my
deploy apps. application?"
"@azure I need a CI/CD pipeline so I can
get my app deployed."
"@azure Use azd to undeploy my
project."

Troubleshoot Diagnose and troubleshoot "@azure What is using up my GPT-4o

application and resource model quota?"
problems. "@azure Find out why my store-service-
prod Kubernetes cluster is running
slow."
"@azure Why am I seeing 500 errors
when opening my website?"

Optimize Answer questions about "@azure How many Azure OpenAI

resources, including locations, deployments do I have?"
settings, and resource health. "@azure Give me a count of storage
accounts in eastus by subscription,
sorted from largest to smallest."

The documentation provides a quickstart and example prompts to help you start using
GitHub Copilot for Azure as quickly as possible.

How it works
GitHub Copilot for Azure Preview is built on a foundational large language model (LLM)
like GPT-4o. It supplements the LLM's general knowledge with continuously updated
knowledge from Microsoft Learn. Its intelligent agents interact with Azure services,
systems, and Azure Resource Graph to carry out specific tasks on your behalf.

The GitHub Copilot Chat extension delivers the chat experience. You can open the chat
extension as a pane in Visual Studio Code by selecting the Chat icon on the Activity Bar.
In the chat pane, you can create a new chat, access a history of chat sessions, open a
chat session in a full editor window, and more.
Best practices
Using copilots can increase developer productivity by answering questions, executing
tasks, and generating code. However, remember these vital rules:

Review all AI-generated responses. Validate their correctness, applicability,

potential outcomes (such as costs and security) before taking action based on
those responses.
Never save application secrets or credentials in source code.
Never submit application secrets or credentials in questions or in code when you
ask questions.

When you're working with any tool that's based on large language models, use good
prompt engineering techniques for the best results. The following tips come from the
article Write effective prompts for Microsoft Copilot in Azure, which provides advice for
prompt engineering in the context of Azure.

Be clear and specific

Set expectations
Add context about your scenario
Break down your requests
Customize your code
Use Azure terminology
Use the feedback loop

Related content
Get started with GitHub Copilot for Azure by installing the software and writing
your first prompt.
Follow the quickstart to understand how to include GitHub Copilot for Azure
Preview in your software development workflow. The quickstart describes how to
deploy services to Azure, monitor their status, and troubleshoot problems.
See example prompts for learning more about Azure and understanding your
Azure account, subscription, and resources.
See example prompts for designing and developing applications for Azure.
See example prompts for deploying your application to Azure.
See example prompts for optimizing your applications in Azure.
See example prompts for troubleshooting your Azure resources.

Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support

Get started with GitHub Copilot for Azure
Preview
Article • 04/18/2025

Get started with GitHub Copilot for Azure Preview to streamline your development workflow
and enhance your productivity on the Azure platform. This guide walks you through the
prerequisites and installation of the GitHub Copilot for Azure extension in Visual Studio Code,
so you can write your first prompt.

Prerequisites
To complete the steps in this article, make sure that you have:

An Azure account and access to an Azure subscription. For details on how to set them up,
see the pricing page for Azure accounts .

A GitHub account and a GitHub Copilot subscription. For details on how to set them up,
see Creating an account on GitHub and Quickstart for GitHub Copilot , respectively.

Visual Studio Code. For details on how to download and install it, see Setting up Visual
Studio Code .

The GitHub Copilot extension and the GitHub Copilot Chat extension. For instructions on
how to install these extensions, see Set up GitHub Copilot in VS Code and Getting
started with GitHub Copilot Chat in VS Code , respectively.

） Important

GitHub Copilot isn't included in Visual Studio Subscriptions and is a separate subscription
managed by GitHub. For questions regarding GitHub Copilot subscriptions and Support,
see Individual Subscriptions or Business subscriptions .

Install GitHub Copilot for Azure Preview

1. In Visual Studio Code, select the Extensions icon.
2. In the Extensions Marketplace, search for GitHub Copilot for Azure. When the GitHub
Copilot for Azure extension appears, select Install.
3. If you're prompted, sign in to your Azure account.
Write your first prompt
1. Ensure that the extension is installed, that you're properly authenticated, and that the
extension is working correctly.

2. If the Chat window isn't already open, make sure it's open by either selecting the Toggle
Chat button in the menu bar, or select the dropdown next to the Toggle Chat button and
select Open Chat (Ctrl+Alt+I).

3. In the chat text area at the bottom of the chat pane, enter the following prompt:

prompt

@azure Do I have any resources currently running?

By default, GitHub Copilot uses ask mode. Ask mode provides answers to your prompts in the
chat pane. Agent mode enables GitHub Copilot to take action in your workspace.

In ask mode, the @azure part indicates that you want to include the Azure chat participant in
the conversation. It scopes your prompt to a specific domain, namely, your Azure account.

The answer to your question depends on what's currently running in Azure in your
subscription.

Agent mode
Beginning in Visual Studio Code version 1.99, GitHub Copilot introduced agent mode , an
agentic experience that can perform tasks across your entire Visual Studio Code workspace,
making edits, executing terminal commands, and so on.

GitHub Copilot for Azure provides "tools" to GitHub copilot to enhance the agentic experience
through deep integration with Azure.

In agent mode, you don't need to instruct GitHub Copilot to use GitHub Copilot for Azure with
the @azure prefix.

Enable agent mode

You might need to enable agent mode.

1. In Visual Studio Code, open Settings using the Manage icon (gear).

2. In the Settings' Search bar, search for chat.agent.enabled .

3. Check the box next to Chat > Agent: Enabled.

Use agent mode
There are three modes: ask (default), edit and agent. To use agent mode, you must select it in
the chat pane.

1. In the chat pane, in the chat prompt, select the mode dropdown and choose Agent.

2. The chat pane confirms that you're currently in agent mode.

3. To see agent mode working, use the following prompt:

What are your tools?

The completion response displays a list of GitHub Copilot for Azure specific tools
available to GitHub Copilot. The response provides a good overview of the kinds of
functionality now available to you:

I can assist you with various tasks using a range of tools. Here are the main
tools I have available:

1. Search and Navigation

Semantic search for code or documentation
 File search using glob patterns
Text search (grep)
List directory contents
Read file contents
List code usages/references

2. Code Editing and Analysis

Insert edits into files
Get errors in code files
Test search (find test files)

3. Terminal and Git Operations

Run commands in terminal
Get terminal output
Get Git diffs and changed files

4. Project Creation
Create new workspaces
Get project setup information
Install VS Code extensions
Create new Jupyter Notebooks

5. Web and API Tools

Fetch webpage content
Get VS Code API references

6. Azure Tools
Azure development best practices
Microsoft Learn documentation
Azure resource management
Azure authentication tools
AI model deployment and management
Azure Bicep schemas
Service configuration and deployment
Azure Developer CLI tools

Would you like me to explain any specific tool in more detail or help you
with a particular task?

4. The last entry, Azure Developer CLI tools , could be employed with the following prompt:

What is the az command to list all my storage accounts ordered by location?

The completion to that prompt might generate:

I'll help you generate the Azure CLI command to list all your storage
 accounts ordered by location. Let me use the Azure CLI generator tool to get
the correct syntax for this command.

To list all your storage accounts ordered by location in Azure, you can use
the following Azure CLI command:

az storage account list --query "sort_by(@, &location)"

This command will:

1. Retrieve all storage accounts you have access to in your Azure

subscription
2. Sort the results based on the location (Azure region) of each storage
account
3. Display the full details of each storage account in the sorted order

If you'd prefer a more concise output focusing on specific fields, you could
modify the query. For example, to show only the name and location in a table
format:

az storage account list --query "sort_by(@, &location)[].[name,location]" -o

table

Make sure you're logged into the Azure CLI before running this command. If
you're not logged in yet, you can do so with az login.

Enable and disable tools in agent mode

You might want to disable or re-enable certain tools available by GitHub Copilot for Azure.

1. Select the tool icon in the chat pane.

2. Use the checkbox next to the list of tools to enable / disable tools (or groups of tools).
Best practices for working in agent mode
To get better agentic results, consider the following best practices.

When prompted, add the copilot-instructions.md file to your workspace.

Keep your prompts as granular as possible. Instead of a prompt like Generate a Python
web application and deploy it to Azure , you should break that up into a few prompts

each with a smaller scope of responsibility.

Allow GitHub Copilot to do work (instead of doing it yourself). Occasionally, GitHub

Copilot asks for permission to perform a task with a "Continue" button. While it's possible
for you to perform that task outside of the Chat window, you should allow GitHub Copilot
to perform the task instead. This allows GitHub Copilot to retain the context of the
current state of its larger plan.
 Allow GitHub Copilot to repeat itself. Occasionally, GitHub Copilot asks for permission to
perform a task repeatedly. It does this to better understand the state of the project files
and what it should do next. You should allow GitHub Copilot to repeat tasks it needs to
perform.

Express your preferences. If GitHub Copilot wants to perform an action but you would
prefer it to take a different action, you can instruct it to do it your preferred way. For
example, if it wants to create a folder to contain bicep files called \.azure , you could
intervene and ask it to use a different folder with a prompt such as:

Instead of naming the folder `.azure`, please name it `infra`

Optional: Set your default tenant

If you have multiple Microsoft Entra ID tenants, You can set a default tenant using the following
prompt:

prompt

@azure /changeTenant

Select from a list of your available tenants in the top center drop-down.

You can also set the default tenant in the extension settings:

1. In Visual Studio Code, on the Activity Bar, select Extensions. Then scroll down to GitHub
Copilot for Azure.
2. Select the gear icon in the corner of the extension's entry, and then select Settings from
the pop-up menu.

3. On the Settings tab, set the Azure Resource Graph tenant to your Microsoft Entra tenant
ID. You can find your Microsoft Entra tenant ID in the Azure portal.
Related content
Understand what GitHub Copilot for Azure Preview is and how it works.
Follow the quickstart to understand how to include GitHub Copilot for Azure in your
software development workflow. The quickstart describes how to deploy services to
Azure, monitor their status, and troubleshoot problems.
See example prompts for learning more about Azure and understanding your Azure
account, subscription, and resources.
See example prompts for designing and developing applications for Azure.
See example prompts for deploying your application to Azure.
See example prompts for optimizing your applications in Azure.
See example prompts for troubleshooting your Azure resources.
Quickstart: Build and deploy your
application with GitHub Copilot for
Azure Preview
Article • 11/18/2024

This quickstart guides you in using GitHub Copilot for Azure Preview to create and
deploy a new website in Azure. It demonstrates one way to integrate GitHub Copilot for
Azure into your development and deployment workflow.

Prerequisites
For complete setup instructions, see the Get started article. Make sure that you have the
following items:

A GitHub Copilot account.

The GitHub Copilot Chat extension for Visual Studio Code.
The GitHub Copilot for Azure Preview extension for Visual Studio Code.
An Azure subscription. If you don't have one, GitHub Copilot for Azure can help.

Create and deploy a website by using GitHub

Copilot for Azure Preview
1. Create a new folder on your local computer where you can create a local clone of a
GitHub repository.

2. In Visual Studio Code, select View > Terminal. On the terminal pane, go to the new
folder.

3. On the Title Bar, select the Open Chat icon (the GitHub Copilot logo) to open the
chat pane in the Secondary side bar.
 To start a new chat session, select the plus icon (+) on the pane's title bar.

） Important

If you get unexpected results, re-start using a new chat session.

4. In the chat text box at the bottom of the pane, type the following prompt after
@azure . Then select Send (paper airplane icon) or select Enter on your keyboard.

prompt

Could you help me create and deploy a simple Flask website by using an
azd template?
 After a moment, GitHub Copilot for Azure likely suggests an azd template to use.

） Important

You may need to authenticate to your Azure account before continuing to

follow GitHub Copilot for Azure's instructions. Follow the authentication
instructions to continue.

You might see a response like the following example.

） Important

The exact wording of the response is different each time GitHub Copilot for
Azure answers, due to how large language models generate responses.

5. If the answer provides a command that begins with azd init in a code fence,
hover over the code fence to reveal a small pop-up action menu.
 Select Insert into Terminal to insert the command into the terminal.

6. Before you run the azd init command, you might have questions about how it
affects your local computer and your Azure subscription.

Use the following prompt:

prompt

@azure Before I execute azd init, what does it do?

You might see a response that resembles the following screenshot.

7. Use the following prompt to learn more about the azd template:

prompt

@azure What resources are created with this template?

You might see a response that resembles the following screenshot.

 8. Ask questions about the services that the template uses with a prompt like:

prompt

@azure What is the purpose of a virtual network?

You might see a response that resembles the following screenshot.

9. When you're satisfied, run the azd init command in the terminal. Answer its
prompts. If you're unsure what to answer for a prompt, ask GitHub Copilot for
Azure for help.

10. After the new project is initialized, use azd up to deploy the application to your
subscription. In the terminal, run the command according to the instructions in the
original prompt's reply.

Windows Command Prompt

azd up

11. The azd up command asks for information about your subscription, where to
deploy the resources, and more.
 If you're uncertain how to answer, you can ask GitHub Copilot for Azure for help.
For example, you might ask:

prompt

@azure azd up is asking me what location I want to deploy the website

into. How should I respond?

You might see a response that resembles the following screenshot.

12. Continue to answer prompts from azd up . Ask GitHub Copilot for Azure questions
as needed.

Depending on the azd template that you're deploying and the location that you
selected, the template might take 20 to 40 minutes (or more) to deploy.

13. If azd up experiences an error, ask GitHub Copilot for Azure about the error and
how you can resolve it.

 Tip

For an easy way to attach the last terminal command results, use the paperclip icon
at the bottom left of the chat pane. GitHub Copilot for Azure doesn't know the
terminal command results unless they are copypasted or attached via the paperclip.
 14. After a successful deployment, you should be able to go to the new website in a
web browser. Use the Azure portal to view the resources that you created.

Clean up resources
You can ask GitHub Copilot for Azure how to remove all of the resources that you
created in the previous steps:

prompt

@azure How do I undeploy this website?

You might see a response that resembles the following screenshot.

Use azd down to remove the website and all resources that you deployed to your Azure
subscription.

Related content
Understand what GitHub Copilot for Azure Preview is and how it works.
Get started with GitHub Copilot for Azure by installing the software and writing
your first prompt.
See example prompts for learning more about Azure and understanding your
Azure account, subscription, and resources.
See example prompts for designing and developing applications for Azure.
See example prompts for deploying your application to Azure.
See example prompts for optimizing your applications in Azure.
See example prompts for troubleshooting your Azure resources.
Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support

Quickstart: Deploy your existing project
to Azure with GitHub Copilot for Azure
Preview
Article • 01/06/2025

This quickstart guides you in using GitHub Copilot for Azure Preview to bring your
existing application to Azure. It demonstrates how GitHub Copilot for Azure helps you
create Azure infrastructure with Bicep and deploy your application to Azure.

Prerequisites
For complete setup instructions, see the Get started article. Make sure that you have the
following items:

A GitHub Copilot account.

The GitHub Copilot Chat extension for Visual Studio Code.
The GitHub Copilot for Azure Preview extension for Visual Studio Code.
An Azure subscription. If you don't have one, GitHub Copilot for Azure can help.

Create Bicep for your existing application and

deploy it to Azure by using GitHub Copilot for
Azure Preview
1. Open your existing application in Visual Studio Code.

If you want to follow along with this tutorial, you can clone the following repo from
GitHub to your local computer:

Bash

git clone https://github.com/Azure-Samples/azure-sql-db-django

2. In Visual Studio Code, on the Title Bar, select the Open Chat icon (the GitHub
Copilot logo) to open the chat pane in the Secondary side bar.
 To start a new chat session, select the plus icon (+) on the pane's title bar.

） Important

If you get unexpected results, re-start using a new chat session.

3. In the chat text box at the bottom of the pane, type the following prompt after
@azure . Then select Send (paper airplane icon) or select Enter on your keyboard.

prompt

@azure Please recommend Azure services for my project.

After a moment, GitHub Copilot for Azure will recommend suitable Azure services,
bindings, and environment variables based on your project. You might see a
response like the following example.
 Under "Resource bindings", you can see a table with "Default Key" and "Custom
key". GitHub Copilot for Azure uses "Default Key" as necessary environment
variable by default to make the bindings work. "Custom key" is the developer
customized key in application code.

4. If the recommendations don’t have the support you need, you can provide
information to get new recommendations. For example, you can try the following
prompt:

prompt

@azure Please use Azure App Service instead of Azure Container App for
my project.

After a moment, GitHub Copilot for Azure will provide updated recommendations.
You might see a response like the following example.
5. Once you’re satisfied with the recommendations, select the Generate button and
GitHub Copilot for Azure generates Bicep files and an azure.yaml file in your
 workspace.

The generated files might look like the following example.

6. You can use the generated Bicep files to provision the infrastructure on Azure with
your favorite tool like the Azure CLI, or you can run azd up in the terminal to
provision infrastructure and deploy your application.

Related content
Understand what GitHub Copilot for Azure Preview is and how it works.
 Get started with GitHub Copilot for Azure by installing the software and writing
your first prompt.
See example prompts for learning more about Azure and understanding your
Azure account, subscription, and resources.
See example prompts for designing and developing applications for Azure.
See example prompts for deploying your application to Azure.
See example prompts for optimizing your applications in Azure.
See example prompts for troubleshooting your Azure resources.

Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support

Example prompts for learning about
Azure and your application with GitHub
Copilot for Azure Preview
Article • 11/18/2024

If you're unfamiliar with Azure and how you can use it for your application, you can ask
GitHub Copilot for Azure Preview to help you. Use best practices to achieve the best
results.

Example prompts to learn about Azure

If you want to use GitHub Copilot for Azure Preview to learn about how to use Azure for
your application, you can start with an open-ended question or request. Then, add
details like specific services and technologies for better results. Try the following
example prompts.

Learn about system architecture on Azure

Use GitHub Copilot to recommend Azure services to use for your project.

"@azure What Azure services should I use with my app?"

"@azure Please recommend Azure services for my project"

When asked to recommend an Azure service, GitHub Copilot for Azure scans the current
application in the workspace and provides recommendations for Azure services and
service bindings.

You can work in an iterative manner asking GitHub Copilot for Azure to update the
recommendations to use a different Azure service or change the bindings information.
Example prompts:

"@azure I'd like to use App Service instead of Azure Container App for my api
project"
"@azure Add a Cosmos DB to my project"
"@azure The SERVICE_URL value should be bing.com"
"@azure Add an environment variable STAGE=dev to my project"

You can follow-up by asking more detailed questions based on GitHub Copilot for
Azure's recommendations. Here are some example detailed questions to help you
understand the types of prompts you can use.
 "@azure How can I create a highly available architecture in Azure?"
"@azure Explain the Azure Well-Architected Framework."
"@azure What types of app hosting solutions does Azure have?"
"@azure Help me orchestrate and automate my data processing workflows."
"@azure How can I integrate SignalR with Azure Application Gateway and Azure
API Management?"
"@azure How many units do you recommend?"
"@azure What are the benefits and applications of using Terraform?"

Learn about AI on Azure

"@azure I want to build an AI application. What services can I use?"

Learn about web and application hosting on Azure

"@azure Which Azure service is best for hosting a scalable web application?"
"@azure Which service should I use to create a website?"
"@azure How can I use Azure to build a scalable web application?"
"@azure For what scenarios is Azure Functions better than Web Apps?"

Learn about containers on Azure

"@azure What types of containerized applications does Azure support?"
"@azure What are the options for managing containers in Azure?"
"@azure When should I use Azure Kubernetes Service instead of Azure Container
Apps?"
"@azure What's the difference between Azure Container Apps and AKS?"
"@azure Why would I choose Azure Container Apps over AKS?"

Learn how to use Azure services for your app

ﾉ Expand table

Service or Learn prompt examples

technology

Azure AI "@azure What is Azure AI Search and why should I use it?"
Search "@azure How does pricing work for Azure AI Search?"
"@azure How is Azure AI Search integrated with Azure OpenAI?"
"@azure How is Azure AI Search integrated with Azure Machine Learning?"
"@azure When should I use hybrid search or vector search versus semantic ranker
in Azure AI Search?"
Service or Learn prompt examples
technology

"@azure Is Azure AI Search a vector database? How does Azure AI Search ensure
the accuracy and relevance of vector search results?"
"@azure What support do you have for high-scale multitenant applications in
Azure AI Search?"
"@azure What is the integrated vectorization feature in Azure AI Search? From
which data sources can I extract data and use integrated vectorization?"
"@azure What is AI enrichment in Azure AI Search? How does AI enrichment work?
What are the benefits of using AI enrichment?"
"@azure What is the semantic ranker in Azure AI Search? How is it different from
vector search?"
"@azure What are top recommended code samples or solution accelerators for
Azure AI Search?"
"@azure What are some real-world examples of businesses using Azure AI Search?"

Azure API "@azure What are the benefits and applications of Azure API Management?"
Management

Azure App "@azure How do I deploy a web app in Azure?"

Service "@azure How do I create an App Service app and deploy code to a staging
environment by using the CLI?"
"@azure Create a script to deploy a web app that will run in Python."
"@azure What database options does Azure have for web apps?"
"@azure What serverless options does Azure have for web apps?"
"@azure Create a guide for maximizing Azure App Service."

Azure Cache "@azure Demonstrate how to configure a Redis cache in Azure for high availability
for Redis and disaster recovery."

Azure "@azure What is the Azure Container Apps service?"

Container "@azure Tell me the difference between a container app and a container app
Apps environment."

Azure "@azure Why would I use Azure Cosmos DB instead of Azure SQL?"
Cosmos DB "@azure I want to use Azure Cosmos DB to store my data."
"@azure Why would I use an Azure Cosmos DB account over a SQL database?"

Azure Data "@azure How do I create data pipelines with Azure Data Factory?"
Factory

Azure "@azure Do you have example deployment models for Azure? SaaS, PaaS, etc."
Developer "@azure What is the best infrastructure for my application?"
CLI ( azd ) "@azure How do I set up my Azure environment?"
"@azure What are Azure Resource Manager templates and how do I use them?"
"@azure How do I manage environments with the Azure Developer CLI?"
Service or Learn prompt examples
technology

"@azure What is the Azure Developer CLI?"

"@azure What is the difference between Bicep and ARM templates?"
"@azure How do I make sure my environments have the best security patterns?"
"@azure How do I deploy by using my CI/CD pipeline?"

Azure "@azure How do I create a new Azure function?"

Functions "@azure What is the difference between Azure Functions and Azure Logic Apps?"
"@azure Create a guide for integrating Azure Logic Apps with Azure Functions."
"@azure I want to create an Azure function in Node.js."

Azure Key "@azure Explain how and why I should use Azure key vaults."
Vault

Azure "@azure How do I get the status of all nodes in my AKS cluster?"
Kubernetes "@azure What's the command to set a context for my AKS cluster?"
Service (AKS)

Azure "@azure Generate a PowerShell script to create a new Azure Machine Learning
Machine workspace."
Learning "@azure What is the difference between Azure AI services and Azure Machine
Learning?"

Azure "@azure Create a guide for using Azure Logic Apps to automate responses to
Monitor Azure Monitor alerts."

Azure Virtual "@azure How do I balance inbound network traffic to my application?"

Network

Azure "@azure What services does Azure OpenAI provide?"

OpenAI "@azure Where is GPT-4o mini available?"
Service "@azure What are the prerequisites for integrating Azure OpenAI?"
"@azure Create a guide for creating and using Azure OpenAI resources."
"@azure What are the available types of Azure OpenAI models?"

Azure SDK "@azure Can I use Azure SDKs in the browser?"

"@azure Does the C# storage SDK support chunked blob uploads and downloads?"

Azure "@azure How do I host and scale SignalR on multiple servers?"

SignalR "@azure How do I do real-time communication in .NET?"
Service "@azure How do I push real-time updates to clients?"
"@azure How do I synchronize data across clients?"
"@azure How do I stream data to clients?"
"@azure How do I manage and scale WebSocket connections?"
"@azure How do I host and scale Socket.IO?"
Service or Learn prompt examples
technology

"@azure What do I need to do to configure my SignalR code to work with Azure

SignalR Service?"
"@azure Evaluate my use of SignalR. Is it following the best security practices?"
"@azure How do I stress test SignalR?"
"@azure How do I configure networking in Azure SignalR Service?"
"@azure How do I configure an Azure Web PubSub event handler?"

Azure SQL "@azure Create a Terraform configuration to deploy an Azure SQL database."
"@azure Design a strategy for migrating on-premises SQL Server databases to
Azure SQL Managed Instance."

Azure Static "@azure Do static web apps support static IP addresses?"

Web Apps

Azure "@azure Why would I use a blob storage?"

Storage "@azure How do I pull data from a storage blob in React?"
"@azure Outline steps to secure Azure Blob Storage with private endpoints and
Azure Private Link."
"@azure Generate an Azure CLI script to create a new storage account."
"@azure Give me the code to create a new storage account with a CLI."
"@azure Can you help me choose the right Azure storage solution?"

Azure Web "@azure How do I authenticate with Web PubSub?"

PubSub "@azure What do I need to do to host my Socket.IO app on Azure?"
"@azure How do I stress test Web PubSub?"

Related content
Understand what GitHub Copilot for Azure Preview is and how it works.
Get started with GitHub Copilot for Azure by installing the software and writing
your first prompt.
Follow the quickstart to understand how to include GitHub Copilot for Azure
Preview in your software development workflow. The quickstart describes how to
deploy services to Azure, monitor their status, and troubleshoot problems.
See example prompts for designing and developing applications for Azure.
See example prompts for deploying your application to Azure.
See example prompts for optimizing your applications in Azure.
See example prompts for troubleshooting your Azure resources.
Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support

Example prompts for designing and
developing your application with
GitHub Copilot for Azure Preview
Article • 11/18/2024

If you're unfamiliar with Azure or you just want the tooling and AI to do most of the
work, you can ask GitHub Copilot for Azure Preview to help you design and develop
web and API applications to be deployed to your Azure account. Use best practices to
achieve the best results.

Example prompts to create an entire sample

app
If you want to use GitHub Copilot for Azure Preview for help with building your
application, you can start with an open-ended question or request. Then, add details like
specific programming languages, frameworks, services and technologies for better
results. Try the following example prompts.

"@azure Could you help me create and deploy a simple Flask website by using
Python?"
"@azure Can you help me build a RAG application with Python?"

Prompts to design APIs

You can now leverage GitHub Copilot for Azure for a variety of API-related tasks which
utilizes the Azure API Center plugin:

Generating API Specifications: Describe your requirements in natural language,

and GitHub Copilot for Azure will create new API specifications tailored to your
needs. It can also help you register these APIs into the API Center swiftly.
Designing Compliant APIs: Design API specifications that comply with API Center
governance. The AI assistance ensures that your APIs are designed according to
best practices and standards.

Examples:

"@azure Generate OpenAPI spec: Accept purchase orders for specialized coffee
bean purchases through an API"
 "@azure Generate OpenAPI spec: We are a pizza company and want to create an
online customized pizza delivery solution. Create an API to accept the pizza
orders."

Related content
Understand what GitHub Copilot for Azure Preview is and how it works.
Get started with GitHub Copilot for Azure by installing the software and writing
your first prompt.
Follow the quickstart to understand how to include GitHub Copilot for Azure
Preview in your software development workflow. The quickstart describes how to
deploy services to Azure, monitor their status, and troubleshoot problems.
See example prompts for learning more about Azure and understanding your
Azure account, subscription, and resources.
See example prompts for deploying your application to Azure.
See example prompts for troubleshooting your Azure resources.

Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support

Example prompts for deploying your
application with GitHub Copilot for
Azure Preview
Article • 11/18/2024

If you're unfamiliar with Azure or you just want the tooling and AI to do most of the
work, you can ask GitHub Copilot for Azure Preview to help you deploy your application.
Use best practices to achieve the best results.

Example prompts for deploying an app

If you want to use GitHub Copilot for Azure Preview for help with deploying your
application, you can start with an open-ended question or request like one of these
examples:

"@azure Help me deploy my application to Azure."

"@azure How can I deploy this app?"
"@azure Deploy this project to Azure."
"@azure Run this app on Azure."

Then, add more detail for better results. Here are some example prompts:

ﾉ Expand table

Service or Deploy prompt examples

technology

Azure "@azure Can you help me create a new deployment in my AKS cluster?"
Kubernetes "@azure What is the command to scale a deployment to 5 replicas?"
Service (AKS) "@azure Can you provide the command to expose a deployment as a
service?"

Azure App "@azure How many web app plans using the free tier do I have
Service deployed, grouped by region in my <placeholder> subscription?"
"@azure How many web apps do I have deployed in eastus?"

Azure Container "@azure How can I deploy my container app to Azure?"

Apps

Azure "@azure Use azd to deploy my project."

Developer CLI
 Service or Deploy prompt examples
technology

( azd ) "@azure I want to use azd to create a deployment pipeline for my

application."
"@azure Initialize my project with the Azure Developer CLI."
"@azure Please start an azd pipeline."

Azure DevOps "@azure Create a deployment pipeline for this project."

"@azure I don't want to deploy my app from my local machine.
Can you set up a remote solution instead?"
"@azure I need a CI/CD pipeline so I can get my app deployed."
"@azure I need help with
setting up a pipeline to deploy my app to Azure."
"@azure Please help me create an automated deployment pipeline for
my app."
"@azure This project is ready for automated deployment. Set that up."

Azure OpenAI "@azure Create an OpenAI deployment with the gpt-3.5-turbo model by
Service using a Terraform template. Set the version of the model to 0613."

GitHub Actions "@azure Let's use GitHub to deploy my app to Azure."

"@azure Set up a GitHub Actions pipeline to deploy my app to Azure."

In many cases, when you ask GitHub Copilot for Azure to choose Azure services and
deploy your application to Azure, it will create Bicep templates and give you the option
to use azd to begin deployment.

） Important

You should always inspect the Bicep templates to ensure you understand what
GitHub Copilot for Azure is recommending. Furthermore, the templates are
intended to be a starting point. You should plan on editing the templates to suit
your needs.

GitHub Copilot for Azure to deploy models to

Azure OpenAI Service
In addition to the example prompts for deploying to Azure OpenAI Service, GitHub
Copilot for Azure has the following capabilities:
 Given an existing OpenAI resource, user can deploy a model and optionally input a
name for model to deploy.
Given the name of an existing resource group, and optionally location, user can
deploy a model, and @azure will deploy a new OpenAI resource. User needs to
input the name of the new OpenAI resource to create.
Given the location, user can deploy a model, and @azure will deploy a new
resource group and OpenAI resource. User needs to input the name of the new
resource group and OpenAI resource to create.
If there is insufficient quota error, the user will be asked to choose a different
region.

Example prompts for Azure Kubernetes Service

(AKS)
GitHub Copilot for Azure enables users to perform a robust set of tasks related to Azure
Kubernetes Service (AKS) directly from the GitHub Copilot Chat view. These skills include
creating an AKS cluster, deploying a manifest to an AKS cluster, and generating Kubectl
commands.

Create an AKS Cluster

Users can quickly set up an AKS cluster using simple, natural language prompts. GitHub
Copilot for Azure reduces the complexity and time required to manually configure and
deploy a Kubernetes cluster.

You can create an AKS cluster using the following prompts:

[@azure] can you help me create a Kubernetes cluster

[@azure] can you set up an AKS cluster for me?
[@azure] I have a containerized application, can you help me create an AKS cluster
to host it?
[@azure] create AKS cluster
[@azure] Help me create a Kubernetes cluster to host my application

Deploy a Manifest to an AKS Cluster

Users can deploy their application manifests to an AKS cluster directly from the GitHub
Copilot Chat view. This simplifies the deployment process and ensures consistency. Use
these predefined prompts to reduce the risk of errors during deployment, leading to
more reliable and stable deployments.
To deploy a manifest file to an AKS cluster, you can use these prompts:

[@azure] help me deploy my manifest file

[@azure] can you deploy my manifest to my AKS cluster?
[@azure] can you deploy my manifest to my Kubernetes cluster?
[@azure] deploy my application manifest to an AKS cluster
[@azure] deploy manifest for AKS cluster

Generate Kubectl Command

Users can generate various Kubectl commands to manage their AKS clusters without
needing to remember complex command syntax. Using GitHub Copilot for Azure makes
cluster management more accessible and efficient, especially for users who aren't
Kubernetes experts.

You can generate various Kubectl commands for your AKS cluster using these prompts:

[@azure] list all services for my AKS cluster

[@azure] kubectl command to get deployments with at least 2 replicas in AKS
cluster
[@azure] get me all services in my AKS cluster with external IPs
[@azure] what is the kubectl command to get pod info for my AKS cluster?
[@azure] Can you get kubectl command for getting all API resources

Example prompts for undeploying an app

If you deployed your application with azd , you can ask GitHub Copilot for Azure Preview
for undeploying assistance. As a Visual Studio Code extension, it has context about
where and how you deployed your application to Azure.

Example prompts:

"@azure Undeploy my project with the Azure Developer CLI."

"@azure Use azd to undeploy my project."
"@azure Undeploy this project from Azure."
"@azure Stop this app on Azure."
"@azure Remove this code from running on Azure."

７ Note
 Currently, GitHub Copilot for Azure Preview can only undeploy an app if it was
originally deployed with AZD.

Related content
Understand what GitHub Copilot for Azure Preview is and how it works.
Get started with GitHub Copilot for Azure by installing the software and writing
your first prompt.
Follow the quickstart to understand how to include GitHub Copilot for Azure
Preview in your software development workflow. The quickstart describes how to
deploy services to Azure, monitor their status, and troubleshoot problems.
See example prompts for designing and developing applications for Azure.
See example prompts for learning more about Azure and understanding your
Azure account, subscription, and resources.
See example prompts for optimizing your applications in Azure.
See example prompts for troubleshooting your Azure resources.

Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support

Example prompts for troubleshooting
your application with GitHub Copilot for
Azure Preview
Article • 11/18/2024

If you're unfamiliar with Azure or you just want the tooling and AI to do most of the
work, you can ask GitHub Copilot for Azure Preview to help you troubleshoot problems
with your application.

Example prompts for troubleshooting your app

If you want to use GitHub Copilot for Azure Preview for help with troubleshooting your
application, you can start with an open-ended question or request. Then, add details for
better results. Use best practices to achieve the best results.

Open-ended prompts
"@azure Where can I find metrics and logs?"
"@azure I want to see all the error messages in the logs."
"@azure I'm seeing errors with my app. Look at the logs to find out why."
"@azure Why are my clients being disconnected so often?"
"@azure Why did my last deployment fail?"
"@azure Help me analyze my app for high CPU usage."
"@azure Why is my application slow?"
"@azure Take a memory dump of my app."

Prompts about specific timeframes

"@azure Grab all the errors in the logs between yesterday and today."
"@azure Diagnose my app to show me what problems it encountered."
"@azure Tell me what goes wrong with my app 'myAppName'."
"@azure Troubleshoot my app for any possible issues in the last 3 hours."
"@azure What errors did my app 'myAppName' have in the last 24 hours?"

Prompts about specific errors

"@azure Is there any 501 error in my app logs?"
"@azure Why am I seeing a 500 error when opening my website?"
 "@azure I'm getting an xxx error code. What could be the reasons?"
"@azure Show me all the 4xx errors in the logs in the last 6 hours."
"@azure Find error messages in the logs that might correlate to 500 errors."

Prompts about specific services and technologies

ﾉ Expand table

Service or technology Troubleshoot prompt examples

Azure Container Apps "@azure My container app won't start."

"@azure My users are reporting errors with my container app."
"@azure Can you look at my energy-api-1 container app's logs
for any 404 errors?"
"@azure Have my container app's system console logs
contained any warnings recently?"

Azure Kubernetes "@azure Help me troubleshoot my AKS cluster."

Service (AKS) "@azure How do I troubleshoot Azure Kubernetes Service
(AKS)?"
"@azure How can I get the logs of a specific pod?"
"@azure Do my kube-apiserver logs show the last time a restart
occurred?"
"@azure My assistant-orchestrator AKS cluster is having
performance problems."
"@azure Find out why my store-service-prod Kubernetes cluster
is running slow."
"@azure I'd like to investigate performance problems with my
Kubernetes cluster."

Azure App Service "@azure How can I improve my Azure web app's performance?"
"@azure How do I improve my app's CPU usage?"
"@azure How can I improve the performance of my Azure web
app?"
"@azure Diagnose high CPU usage in Azure App Service."
"@azure Show me how to detect slow performance issues in my
App Service web app."
"@azure Investigate high CPU usage for App Service."
"@azure What's causing latency in my Azure web app?"
"@azure Can you help me diagnose high CPU usage in Azure
App Service?"
"@azure Why am I seeing high memory usage in App Service?"
"@azure Help me analyze my web app downtime."
"@azure Help me diagnose slow performance in my Azure web
app."
"@azure Help me collect a memory dump from Azure App
Service."
Service or technology Troubleshoot prompt examples

"@azure My App Service container won't start."

"@azure Is there anything wrong with my bakery-api web app?"
"@azure Look into if my web app is having any downtime."
"@azure Troubleshoot why my web app is not responding."

Azure Developer CLI "@azure I'm getting this error. What does it mean?"
( azd )

Azure SDK "@azure The npm Azure Resource Manager SDK is failing to
install. What should I do?"

Azure Event Hubs "@azure My application needs help with processing real-time
events."

Azure OpenAI Service "@azure What is using up my GPT4o model quota?"

Azure SignalR Service "@azure My SignalR client is not receiving messages. Why?"
"@azure Why are my SignalR clients being disconnected so
often?"
"@azure Where can I find metrics and logs for my SignalR app?"

Azure Storage "@azure Can you help me choose the right Azure storage
solution?"
"@azure What are some ways to secure my Azure storage
account?"
"@azure I got an error 403, unauthorized blob listing."

Azure Web PubSub "@azure My Web PubSub client is not receiving messages.
Why?"

Related content
Understand what GitHub Copilot for Azure Preview is and how it works.
Get started with GitHub Copilot for Azure by installing the software and writing
your first prompt.
Follow the quickstart to understand how to include GitHub Copilot for Azure
Preview in your software development workflow. The quickstart describes how to
deploy services to Azure, monitor their status, and troubleshoot problems.
See example prompts for learning more about Azure and understanding your
Azure account, subscription, and resources.
 See example prompts for designing and developing applications for Azure.
See example prompts for deploying your application to Azure.
See example prompts for optimizing your applications in Azure.

Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support

Example prompts for optimizing your
application with GitHub Copilot for
Azure Preview
Article • 11/19/2024

If you're unfamiliar with Azure or you just want the tooling and AI to do most of the
work, you can ask GitHub Copilot for Azure Preview to help you optimize the
performance of your Azure resources. Use best practices to achieve the best results.

Example prompts to optimize your app

If you want to use GitHub Copilot for Azure Preview for help with optimizing your
application, you can start with an open-ended question or request. Then, add details like
specific services and technologies for better results. Try the following example prompts.

ﾉ Expand table

Service Optimize prompt examples

Azure App "@azure Are any app code optimizations available?"

Service "@azure Show me how to optimize CPU usage for Azure App Service."
"@azure How do I optimize code for Azure App Service?"
"@azure What are the best practices for security in Azure?"

Azure SQL "@azure How can I optimize my Azure SQL database for better
performance?"

Prompts to evaluate AI models

The Online Experimentation GitHub Copilot extension plugin is a powerful tool designed
to streamline the process of online A/B model evaluation for AI application developers.
This plugin is part of a broader initiative to enhance the developer experience by
integrating experimentation capabilities directly into the development workflow.

This includes two components:

An experimentation copilot plugin for the @azure extension. This chatbot assists
with experimentation, generates feature flag code and metric, helps evaluate and
summarize experiment results, and more.
 A GitHub action that can be invoked as part of the AI development workflow in
GitHub to start experiments and refresh and link to experiment results.

The goal of this project is to provide a seamless and efficient way for developers to
conduct experiments and analyze results without leaving their development
environment. It supports the creation and management of experiments and metrics,
leveraging Azure services such as Azure App Config for configuration delivery and Azure
AI for model monitoring metrics.

The preview of this plugin includes a code-first user experience in partnership with
Azure App Config, enabling streamlined evaluation and experimentation in GitHub. This
includes out-of-the-box model monitoring metrics and custom metrics. The public
preview will evolve this into a full streamline integration and easy-to-use user
experience in both App Config and AI Studio.

Azure AI evaluation is already publicly available, but if you are interested in trying out
our online experimentation feature please sign up for our preview to learn more.

Optimize code level performance

If you use Applications Insights Profiler for .NET, you can perform code-level
performance optimizations with GitHub Coplit. This feature is under development, so at
this time a separate @Code_Optimization (instead of @azure ) extension needs to be used
for optimizing code-level performance. For details on installing and using Code
Optimizations, see Code Optimizations extensions for Visual Studio and Visual Studio
Code (preview) - Azure Monitor.

Related content
Understand what GitHub Copilot for Azure Preview is and how it works.
Get started with GitHub Copilot for Azure by installing the software and writing
your first prompt.
Follow the quickstart to understand how to include GitHub Copilot for Azure
Preview in your software development workflow. The quickstart describes how to
deploy services to Azure, monitor their status, and troubleshoot problems.
See example prompts for learning more about Azure and understanding your
Azure account, subscription, and resources.
See example prompts for designing and developing applications for Azure.
See example prompts for deploying your application to Azure.
See example prompts for troubleshooting your Azure resources.
Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support

Generate Bicep files using GitHub
Copilot for Azure
Article • 03/28/2025

There are many ways to create new resources on Azure. Bicep files provide a declarative,
modular, and reusable approach to defining Azure resources. Bicep templates offer
improved readability, maintainability, and native integration with Azure Resource
Manager (ARM) compared to JSON-based ARM templates or imperative scripting
methods like PowerShell and Azure CLI. GitHub Copilot for Azure can help you create
Bicep files.

Generate Bicep files

Getting started with Bicep files might require some learning if you're new to the syntax,
but tools like GitHub Copilot for Azure can help.

Example scenario
Suppose you want an easy way to create a repeatable, automated process for creating a
Blob container and file share. You might be familiar with how to create a Blob container
and file share using the Azure portal, but unsure how to use Bicep files to accomplish
the same task.

Example prompt
Create a New Chat (Ctrl + L), then copy and paste the following prompt into GitHub
Copilot's chat pane.

@azure Show me a Bicep file that creates an Azure Storage account with a
blob container and a file share.

Example response

７ Note
 The following response is an example. GitHub Copilot for Azure responses are
nondeterministic, so you might get a different response from the one shown here.

GitHub Copilot for Azure generates a Bicep file similar to the following.

@description('Specifies the name of the Azure Storage account.')

param storageAccountName string

@description('Specifies the name of the blob container to create.')

param blobContainerName string

@description('Specifies the name of the file share to create.')

param fileShareName string

@description('Specifies the location in which the Azure Storage resources

should be deployed.')
param location string = resourceGroup().location

resource sa 'Microsoft.Storage/storageAccounts@2023-01-01' = {
name: storageAccountName
location: location
sku: {
name: 'Standard_LRS'
}
kind: 'StorageV2'
properties: {
accessTier: 'Hot'
}
}

resource blobServices 'Microsoft.Storage/storageAccounts/blobServices@2023-

01-01' = {
parent: sa
name: 'default'
}

resource blobContainer
'Microsoft.Storage/storageAccounts/blobServices/containers@2023-01-01' = {
parent: blobServices
name: blobContainerName
properties: {
publicAccess: 'None'
}
}

resource fileServices 'Microsoft.Storage/storageAccounts/fileServices@2023-

01-01' = {
parent: sa
name: 'default'
}
 resource fileShare
'Microsoft.Storage/storageAccounts/fileServices/shares@2023-01-01' = {
parent: fileServices
name: fileShareName
properties: {
shareQuota: 100 // Quota in MB
}
}

Create a new main.bicep file, then copy the response from GitHub Copilot for Azure and
paste into the new file.

When using the Azure CLI to execute the Bicep file, you can set the params declared as
storageAccountName , blobContainerName , and fileShareName .

Alternatively, you can edit the Bicep file initializing the storageAccountName param to
your desired value.

param storageAccountName string = '<your-storage-account-name>'

Refine the response

However, if you're new to Bicep files, you might need more information. Continue
prompting in the same chat session to understand next steps.

For example, you might ask where this Bicep file should be created in your VS Code
workspace.

@azure Where in my workspace should I create the Bicep file and what should
I call it?

It might respond by suggesting a folder and file name for your new Bicep file. For
example, infra/storageAccount.bicep .

Finally, if you're unsure about how to deploy the Bicep file, you can create a prompt that
asks for instructions.

@azure How do I execute the Bicep file?

You might receive a response similar to the following.

To execute the Bicep file, you can use the Azure CLI with the following
steps:

1. **Install Azure CLI and Bicep CLI**: Ensure you have the Azure CLI and
Bicep CLI installed. You can install Bicep using the Azure CLI with the
command:

az bicep install

2. **Log in to Azure**: Use the Azure CLI to log in to your Azure account:

az login

3. **Deploy the Bicep file**: Use the `az deployment group create` command
to deploy the Bicep file to a resource group. Replace `<resource-group-
name>` with your resource group name and `<location>` with your desired
Azure region:

az deployment group create --resource-group <resource-group-name> --

template-file infra/storageAccount.bicep --parameters storageAccountName=
<your-storage-account-name> containerName=<your-container-name>
fileShareName=<your-file-share-name> location=<location>

This command will deploy the resources defined in your Bicep file to the
specified resource group in Azure.

While following these instructions, if you get stuck or encounter a problem, continue
asking GitHub Copilot questions creating prompts with the prefix @azure in the chat
pane.

Related content
Bicep overview
What is GitHub Copilot for Azure Preview?
Get started with GitHub Copilot for Azure Preview

Feedback
Was this page helpful?  Yes  No

Provide product feedback | Get product support