vscode-azureappservice
AGENTS.md119 starsChanged 10 days agoMITView on GitHub
Use .github/copilot-instructions.md for implementation, bug-fixing, testing, and review rules. Deeper subsystem guidance lives in .github/instructions. package.json contributions and package.nls.json labels -> src/commands/registerCommands.ts -> command implementation -> shared Azure Tools helpers or subscription/site client -> resource-tree refresh, activity/output, and focused tests. activateInternal -> getResourceGroupsApi -> Azure Resources host API -> @microsoft/vscode-azext-azureauth -> vscode.authentication -> VS Code's built-in Microsoft Authentication provider. Azure Resources owns accou
- Reads credentials
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repositoryOne other file it gives its agents.
- .github/copilot-instructions.mdCopilot instructions
The file
We split this AGENTS.md into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 3
Use .github/copilot-instructions.md for implementation, bug-fixing, testing, and review rules.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
App Service extension architecture
Use .github/copilot-instructions.md for implementation, bug-fixing, testing, and review rules. Deeper subsystem guidance lives in .github/instructions.
Follow a user action
package.json contributions and package.nls.json labels ->
src/commands/registerCommands.ts -> command implementation ->
shared Azure Tools helpers or subscription/site client ->
resource-tree refresh, activity/output, and focused tests.
Code ownership map
| Area | Start here | Boundary |
| Activation and dependencies | main.js, src/extension.ts, src/extensionVariables.ts, src/utils/getExtensionApi.ts | The handwritten entrypoint measures bundle load time; activation registers shared extension variables, commands, the Azure Resources resolver, and the filesystem. |
| Resource resolution and tree | src/WebAppResolver.ts, src/tree/ResolvedWebAppResource.ts, src/tree/SiteTreeItem.ts, src/tree/DeploymentSlotsTreeItem.ts | Resource Graph supplies lightweight models; ARM lazily initializes ParsedSite. SiteTreeItem delegates to the resolved resource for child/slot compatibility. |
| Authentication, Azure clients, and resource picking | src/extension.ts, src/utils/getExtensionApi.ts, src/utils/pickWebApp.ts, src/WebAppResolver.ts, src/utils/azureClients.ts | Azure Resources supplies authenticated subscription contexts; shared factories consume their credentials and cloud endpoints. Initialized sites supply slot-aware clients. |
| Create apps and slots | src/commands/createWebApp/, src/commands/createSlot.ts, src/commands/swapSlots.ts | Wizard contexts/steps coordinate runtime, OS, plan, Insights, custom locations, and slot behavior. |
| Deploy code and configure sources | src/commands/deploy/, src/commands/deployments/, src/commands/postDeploy/ | Local workspace/tasks feed shared deployment helpers; post-deploy health checks are separate from upload completion. |
| Deploy containers | src/commands/deployImage/ | Container Tools command contract, Linux creation, ACR identity/role assignment, Arc credentials, and CI/CD webhooks. |
| Settings and Code Optimizations | src/commands/appSettings/, src/commands/codeOptimizations/, src/tree/CodeOptimizationTreeItem.ts, src/utils/addProfilerUtils.ts, src/utils/fixInsightsUtils.ts, src/utils/perfIssuesUtils.ts | Shared settings tree/client abstractions; local .env transfers; Insights/profiler configuration and diagnostic results. |
| Remote operations | src/AppServiceFileSystem.ts, src/commands/showFile.ts, src/commands/remoteDebug/, src/commands/startSsh.ts, src/commands/logstream/ | Remote file ETags, language eligibility, authenticated tunnels, terminal/session cleanup, and logging. |
| Workspace configuration | src/vsCodeConfig/, src/utils/workspace.ts, src/utils/pathUtils.ts, src/utils/javaUtils.ts | Resource-scoped settings, task configuration, local path handling, and language-specific deployment preparation. |
| Extension API | src/vscode-azureappservice.api.d.ts, src/commands/api/revealTreeItem.ts, src/extension.ts | Versioned exported revealTreeItem API; container deployment is a separate registered command contract. |
| Tests | test/global.test.ts, test/remoteDebug/getRemoteDebugLanguage.test.ts, test/parseDetectorTables.test.ts, test/nightly/ | VS Code-hosted Mocha tests; Azure integration fixtures and their currently skipped resource setup. |
| Engineering | package.json, esbuild.mjs, .vscode-test.mjs, eslint.config.mjs, .github/workflows/main.yml, .config/ | Shared vscode-azext-eng tooling and vscode-azuretools pipeline templates. |
Authentication flow
activateInternal -> getResourceGroupsApi -> Azure Resources host API ->
@microsoft/vscode-azext-azureauth -> vscode.authentication ->
VS Code's built-in Microsoft Authentication provider.
Azure Resources owns account/subscription discovery and selection. App Service
consumes its picker/tree API and the ISubscriptionContext passed to
WebAppResolver.resolveResource; creation wizards inherit node.subscription.
That context carries credentials, scope-specific credential creation, tenant,
subscription, and Azure environment. src/utils/azureClients.ts delegates to
shared Azure Utils factories; ParsedSite.createClient(context) uses the site's
same subscription context for site/slot operations, not a separate sign-in.
Investigate sign-in, session, tenant, or missing-subscription problems in Azure
Resources, the auth package, and Microsoft Authentication first; investigate a
wrong client identity/cloud in the context handoff and client factories here.
Public Azure uses provider microsoft; sovereign/custom environments use
microsoft-sovereign-cloud. Azure CLI login does not establish a VS Code session.
Developer authentication is separate from the deployed app's managed identity,
registry credentials, or publishing/SCM authentication.
External ownership
@microsoft/vscode-azext-azureappserviceowns sharedParsedSite, site clients, deployment, slot, log-stream, tunnel, and many wizard/tree helpers.@microsoft/vscode-azext-azureappsettingsowns shared settings tree/client behavior.@microsoft/vscode-azext-utilsand@microsoft/vscode-azext-azureutilsown action handling, wizards, activities, client factories, and common Azure UI.- The Azure Resources extension hosts the resource explorer and picker API.
It obtains developer authentication through
@microsoft/vscode-azext-azureauth, backed by VS Code Microsoft Authentication, not the legacy Azure Account extension. Do not build a parallel account/tree implementation here. - Human review ownership is recorded in .github/CODEOWNERS.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.