Sample applications
Each App Service Builder sample has its own Azure-Samples repository. Fork the repository to your GitHub account to adapt one build shape at a time. You can also start from a Portal template to create the fork during app creation. If you already have a fork, keep it and choose Use my repository.
Confirm access, location, and runtime support with your preview contact before deploying.
At a glance
- Each sample has a root-level
builder.yamlin its own repository. - Fork the selected repository and use safe configuration values.
- Wait for deployment success and verify the app URL.
- Follow the repository README for local checks and customization.
Choose a sample
For a first deployment without browsing the catalog, start with Portal or Builder CLI. Both quickstarts recommend the minimal Node.js HTTP sample and let you keep an alternative you have already selected.
To choose another sample, start with the app shape, then choose the source language below. Use Node.js, Python, .NET, PHP, or static HTML/Vite tutorials for runtime-specific settings and verification. Each tutorial includes Portal and Builder CLI deployment steps and cleanup. Static samples serve browser assets without a compute process; web samples run an HTTP process. TypeScript in the Vite sample produces static browser assets, not a separately supported compute platform.
The JavaScript web samples include a stateless HTTP MCP server and a bounded model-backed agent API. See hosting an MCP server and hosting an AI agent API for their protocol, dependency, and security requirements. These are applications you deploy, not Builder-managed MCP or agent services.
8 of 8 samples
Static sites
Publish browser-ready files or build frontend assets. No server process is deployed.
Static HTML
Browser-ready HTML served directly from public, without a build or compute process.
Confirm access, location, and runtime support before deploying.
View repository on GitHubVite TypeScript
A Vite and TypeScript app built into static dist assets.
Confirm access, location, and runtime support before deploying.
View repository on GitHub
Web apps and HTTP APIs
Run a request-driven application with a public endpoint and an explicit health check.
Node.js HTTP
A dependency-free Node.js HTTP server with a public greeting and health endpoint.
Confirm access, location, and runtime support before deploying.
View repository on GitHubPython HTTP
A standard-library Python HTTP server with a public greeting and health endpoint.
Confirm access, location, and runtime support before deploying.
View repository on GitHubASP.NET HTTP
A minimal .NET 10 HTTP app with a public greeting and health endpoint.
Confirm access, location, and runtime support before deploying.
View repository on GitHubPHP HTTP
A PHP 8.5 app using default nginx/PHP-FPM startup, with a public greeting and health endpoint.
Confirm access, location, and runtime support before deploying.
View repository on GitHubHTTP MCP server
A stateless JSON-response MCP endpoint with a bounded read-only text tool.
Confirm access, location, and runtime support before deploying.
View repository on GitHubAI assistant HTTP API
A bounded, single-turn assistant using an explicitly configured external model service.
Confirm access, location, and runtime support before deploying.
View repository on GitHub
Repository links open GitHub.
For PHP, keep default nginx/PHP-FPM startup with no run.start; follow the PHP tutorial.
Next.js has no supported sample here and is not offered as runnable source.
Deploy your copy
- Review Private Preview guidance: development/test only; do not deploy production workloads. Obtain your preview environment details and, for CLI use, install the published CLI package.
- Open the selected Azure-Samples repository and choose Fork to create your own repository.
- Review its README, runtime requirements, and root
builder.yaml. Clone the fork if you want to make local changes or deploy with Builder CLI. Portal can deploy the committed fork without local tools. - If you change the application, commit and push to the intended branch in your fork.
- Authorize GitHub source access to your fork, not the upstream sample repository.
Each repository contains one sample, so use its repository root as the app source root (rootDirectory: "." in ARM).
Keep builder.yaml at that root.
If you later move your app into a larger repository, configure its source root explicitly.
Keep the fork, branch, and root builder.yaml you prepared above.
Builder deploys committed GitHub source, not uncommitted local files.
- Portal
- Builder CLI
Open the App Service Builder Portal.
Your Azure account needs permission to create and deploy Microsoft.Web/builderApps resources.
Creating a resource group also requires permission to create groups in the selected subscription.
- Sign in to the Portal with the Microsoft account authorized for your subscription.
- Select the subscription and choose Create.
- In Connect GitHub, sign in to GitHub and authorize the OAuth App. Keep Use my repository selected to deploy the fork you prepared above. Choose the account or organization that owns your fork, then select that repository and branch. Use Change account if you need a different GitHub account, or Refresh access after changing repository permissions. Select Next.
- In Choose approach, confirm the selected repository and branch. Keep Let Builder handle it selected. The App Service Builder GitHub App needs access to this repository to read your code, build it, and deploy your app. Signing in to GitHub alone does not grant this access. If prompted, select Install GitHub App and grant access to your selected repository, or add it to an existing installation. Close the GitHub window to refresh access, or select Refresh access after approval. Select Next when Builder is connected and GitHub App access confirmed are shown.
- In App details, enter an app name and select the subscription, resource group, and offered location. To create a resource group, select Create new, enter its name, and choose Resource group region. Select Add. The group appears as (new) and is created when you submit. Its region stores the resource group's metadata and does not change the app's region. Select Next.
- On Review and create, confirm the app, repository, branch, subscription, resource group, and app region. Select Create and deploy.
- Open the app's Deployments page and wait for the deployment to succeed. In Versions, inspect the source revision, component results, and build logs. Select Deploying to open an in-progress deployment's steps and logs. On Overview, use Browse to open the app URL.
Already prepared a fork? Keep Use my repository selected so you deploy that source, not a second copy. To start with a new sample instead, follow Create from a Portal template. Use GitHub Actions is marked Coming soon; use the Builder-managed approach for this preview.
If group creation fails, app creation does not start. If the group was created before a later failure, it remains in Azure; cancelling does not delete it. Check the existing group and app before retrying, and inspect a group's contents before deleting it separately.
See GitHub authorization requirements for organization approvals and SSO. If app creation succeeds but deployment cannot start, read the error and retry deployment on the existing app rather than creating a duplicate. For “Source revision does not contain builder.yaml”, push the missing manifest before retrying.
Choose a browser or terminal download.
Download in your browser: download Builder CLI 0.0.2 (azure-builder-cli-0.0.2.tgz) from the Private Preview release. Choose the CLI archive, not GitHub's automatic Source code ZIP or tarball.
Download from your terminal: with GitHub CLI installed, run this command in the directory where you want to save the archive:
gh release download builder-cli-v0.0.2-preview.1 --repo microsoft/azure-app-service-builder --pattern "azure-builder-cli-0.0.2.tgz"
The command downloads the CLI archive into the current directory.
It refuses to overwrite an existing file; choose another directory if the archive is already present.
Release archives use the name azure-builder-cli-<version>.tgz.
Use the same portable npm archive on Windows, Linux, and macOS; there is no separate OS/CPU-specific CLI download.
Install Node.js 22 or later, including npm.
Install or upgrade using your downloaded archive directly:
npm install --global "<path-to-downloaded-file.tgz>"
builder --version
builder --version should report 0.0.2.
Replace <path-to-downloaded-file.tgz> with the local path to your downloaded azure-builder-cli-0.0.2.tgz.
For the terminal download above, use ./azure-builder-cli-0.0.2.tgz while in the same directory.
Obtain preview access and confirm your approved subscription and location with your preview contact.
Do not extract the archive.
npm registry access is still required for JavaScript dependencies; access to Builder's private source repository is not required.
Installing the CLI does not grant preview access or install the separately distributed agent skills plugin.
The .NET runtime is needed only for local builder manifest commands.
You can install Builder and run builder login, builder init, and
builder app deploy without .NET.
The archive includes the local manifest analyzer and its dependencies, but not the .NET runtime.
For optional local manifest validation, install a compatible .NET 10 runtime and keep dotnet on PATH.
The analyzer requires Microsoft.NETCore.App 10.0.0 or a compatible runtime.
A .NET SDK is not required to use Builder; an existing compatible SDK's included runtime is sufficient.
Check installed runtimes with:
dotnet --list-runtimes
Use your installed Builder CLI and GitHub CLI (gh) to connect your source.
The App Service Builder GitHub App must have access to your selected repository so Builder can read, build, and deploy its code.
See GitHub authorization requirements if access has not been granted.
Reuse a resource group, or create one first with Azure CLI:
az login
az group create --subscription "<subscription-id>" \
--name "<resource-group>" --location "eastus2"
Replace the subscription and resource-group placeholders with your values.
You can use westus2 instead of eastus2.
Only this optional resource-group creation step requires Azure CLI and permission to create resource groups.
Builder CLI uses the group you select; it does not create it.
If you have not already cloned your prepared fork, copy its HTTPS clone URL from GitHub and run:
git clone "<your-fork-https-url>"
cd "<local-repository-directory>"
Run builder init from inside an initialized Git worktree.
GitHub sign-in does not select a local repository.
If your terminal is in your home directory, open your cloned app folder or change to it first.
Do not initialize Git in your home directory to get past the worktree error.
Run these commands from your app's checkout:
builder --help
builder login
builder account show
builder source login github
builder init
Follow the prompts and confirm the app name, Azure subscription, resource group, approved location, and GitHub source.
Select your prepared fork and its pushed branch.
Keep the app name, subscription ID, and resource group for the deployment commands below.
Initialization creates or reuses the app and connects source; it does not deploy or upload local changes.
For explicit automation, see non-interactive setup.
builder init does not automatically analyze or modify builder.yaml.
Deployment requires builder.yaml at the selected source root.
Review your manifest, then commit and push any changes you want to deploy.
Optionally validate the prepared manifest locally without changing files or running repository code. This step requires the separate .NET runtime described in the installation instructions; login, setup, and deployment do not:
builder manifest validate
Request deployment and read the app:
builder app deploy --name "<app-name>" \
--subscription "<subscription-id>" --resource-group "<resource-group>"
builder app show --name "<app-name>" \
--subscription "<subscription-id>" --resource-group "<resource-group>"
Deployment waits by default.
After success, use the runtime URL returned by app show for the checks below.
For a failure, inspect build and deployment diagnostics.
The CLI reference lists selectors, diagnostics, and flags.
For API automation, use the ARM API deployment guide with this same fork, branch, and source root ".".
ARM and Bicep infrastructure templates provision the resource; separately authorize and connect this source, then deploy it through CLI or ARM.
Verify the hosted sample
After deployment succeeds, open the returned app URL and perform the response checks from the selected repository's README. Check the active version and source revision as well as the endpoint. For MCP or model-backed samples, verify a real authenticated protocol or model request; process health alone does not establish that the integration works.
Clean up resources
Delete only the test app you created when you no longer need it. App deletion does not remove your GitHub repository, resource group, or separately owned services and user-assigned identities.
- Portal
- Builder CLI
Return to the app inventory and choose Delete from the test app's actions. Alternatively, open the app's Settings and select Delete under Danger zone. Confirm the selected app and follow deletion to completion. Deleting from Settings returns you to the home inventory after the deletion request is accepted.
builder app delete --name "<app-name>" \
--subscription "<subscription-id>" --resource-group "<resource-group>"
The command asks for confirmation and waits for deletion unless --no-wait is supplied.
If you choose not to wait, track the returned operation before treating cleanup as complete.
Combine static and web outputs
Builder can combine one static output and one public web output in an app. The current catalog contains focused static and web samples, not a combined full-stack sample. The manifest guide explains composition and build/output paths. Runtimes explains supported languages and framework limitations, and authentication adds visitor sign-in after the app is deployed.