[docs] Update documentation for Extension SDK features from 2026-03-31#15
Draft
github-actions[bot] wants to merge 1 commit into
Draft
[docs] Update documentation for Extension SDK features from 2026-03-31#15github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…nd document KeyVaultResolver
Sync docs from upstream Azure/azure-dev main and add missing documentation
for new Extension SDK helpers merged in the last 24 hours:
- Add extension-sdk-reference.md: comprehensive API reference for all
azdext SDK helpers including new sections for:
- Process Management helpers (IsProcessRunning, GetProcessInfo, etc.)
- Environment Loading helpers (LoadAzdEnvironment, ParseEnvironmentVariables)
- Project Resolution helpers (GetProjectDir, FindFileUpward)
- Security Validation helpers (ValidateServiceName, ValidateScriptName, etc.)
- SSRF Guard (NewSSRFGuard, DefaultSSRFGuard with fluent builder)
- Testing Helpers (CaptureOutput)
- Key Vault Secret Resolution (KeyVaultResolver, IsSecretReference,
ParseSecretReference, KeyVaultResolveError) -- from PR Azure#7043
- Add extension-e2e-walkthrough.md: end-to-end guide for building an
extension from scratch
- Add extension-migration-guide.md: migration guide from pre-SDK patterns
to new azdext helpers
- Update extension-framework.md: sync latest content including
allowed_locations for PromptLocation and quota-aware capacity resolution
from PR Azure#7397
Related PRs: Azure#7025, Azure#7043, Azure#7397
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
automation
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Updates - 2026-03-31
This PR updates the extension developer documentation based on features merged in the last 24 hours.
Features Documented
KeyVaultResolver for Extension SDK (from feat(azdext): Add KeyVault resolver for extension secret resolution Azure/azure-dev#7043) — Extensions can now resolve Azure Key Vault secret references without writing custom Key Vault code. Documented
KeyVaultResolver,IsSecretReference,ParseSecretReference,KeyVaultResolveError, and all three supported reference formats (akvs://,@Microsoft.KeyVault(SecretUri=...),@Microsoft.KeyVault(VaultName=...;SecretName=...)).Extension SDK helpers (from feat(azdext): Extension SDK improvements — integration, security, runtime, cleanup Azure/azure-dev#7025) — Added missing sections for helpers that shipped but were not yet documented:
IsProcessRunning,GetProcessInfo,FindProcessByName, etc.)LoadAzdEnvironment,ParseEnvironmentVariables)GetProjectDir,FindFileUpward)ValidateServiceName,ValidateScriptName,IsContainerEnvironment, etc.)NewSSRFGuard,DefaultSSRFGuardwith fluent builder API)CaptureOutput)PromptLocation
allowed_locations+ quota-aware capacity resolution (from Extension Framework - addallowed_locationstoPromptLocationand improve AI model capacity resolution Azure/azure-dev#7397) — Syncedextension-framework.mdfrom upstream which includes documentation for the newallowed_locationsfield onPromptLocationRequestand theResolveCapacityWithQuotaquota-aware fallback behavior.Changes Made
cli/azd/docs/extensions/extension-sdk-reference.md— comprehensive API reference including all new helper sections and the full Key Vault Secret Resolution sectioncli/azd/docs/extensions/extension-e2e-walkthrough.md— end-to-end guide for building an extension from scratchcli/azd/docs/extensions/extension-migration-guide.md— migration guide from pre-SDK patterns to newazdexthelperscli/azd/docs/extensions/extension-framework.md— synced from upstream to includeallowed_locationsand quota-aware AI model capacity resolutionMerged PRs Referenced
allowed_locationstoPromptLocationand improve AI model capacity resolution Azure/azure-dev#7397 — Extension Framework - addallowed_locationstoPromptLocationand improve AI model capacity resolutionNotes
The local fork was missing the new doc files added by Azure#7025 (
extension-sdk-reference.md,extension-e2e-walkthrough.md,extension-migration-guide.md) and the updatedextension-framework.md. These have been brought in from upstream and the SDK reference has been extended with theKeyVaultResolverdocumentation from Azure#7043 (which was not yet in the upstream doc).