Closes #903 Retire DefaultAzureCredential phase 1 (awareness)#899
Open
shirasassoon wants to merge 71 commits intomicrosoft:mainfrom
Open
Closes #903 Retire DefaultAzureCredential phase 1 (awareness)#899shirasassoon wants to merge 71 commits intomicrosoft:mainfrom
shirasassoon wants to merge 71 commits intomicrosoft:mainfrom
Conversation
…irasassoon/fabric-cicd into retire_defaultazurecredential
Contributor
There was a problem hiding this comment.
Pull request overview
This PR begins deprecating DefaultAzureCredential as the implicit authentication mechanism by adding a runtime warning and updating docs/examples to prefer explicit token_credential providers across environments.
Changes:
- Added a deprecation warning when
FabricWorkspacefalls back toDefaultAzureCredential. - Reworked authentication documentation and troubleshooting guidance with explicit credential examples (CLI, PowerShell, managed identity, client secret).
- Updated devtools scripts and added a changelog entry reflecting the deprecation guidance.
Reviewed changes
Copilot reviewed 7 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/fabric_cicd/fabric_workspace.py | Emits a warning when code falls back to DefaultAzureCredential. |
| docs/how_to/troubleshooting.md | Updates troubleshooting guidance and marks explicit credentials as required in tables/examples. |
| docs/how_to/getting_started.md | Adds deprecation notice and a basic explicit-credential example. |
| docs/example/release_pipeline.md | Updates pipeline narrative to explicit credential flows and fixes an ADO variable reference. |
| docs/example/deployment_variable.md | Updates variable-injection examples to use explicit credentials and adds deprecation notice. |
| docs/example/authentication.md | Major rewrite of auth examples by credential type and environment, adds Fabric Notebook section. |
| devtools/debug_trace_deployment.py | Uses AzureCliCredential and passes token_credential explicitly. |
| devtools/debug_local.py | Adds explicit credential options and always passes token_credential. |
| devtools/debug_local config.py | Adds explicit credential options and passes token_credential. |
| devtools/debug_api.py | Removes DefaultAzureCredential fallback and uses validated explicit credentials. |
| .changes/unreleased/optimization-20260325-161506.yaml | Adds a changelog entry for the deprecation warning/migration guidance. |
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.
This pull request updates the authentication documentation for
fabric-cicdto deprecate the use ofDefaultAzureCredentialand provide clear migration guidance to explicit credential methods. It introduces a deprecation warning, reorganizes and clarifies authentication examples, and adds guidance for using explicit credential flows including Azure CLI, Azure PowerShell, and Managed Identity. The changes emphasize security best practices and provide updated code samples for different environments.Deprecation and migration guidance:
DefaultAzureCredential, advising users to migrate to explicit credential methods and providing migration guidance in the documentation. (.changes/unreleased/optimization-20260325-161506.yaml)token_credentialparameters should be used in all scenarios except Fabric Notebook runtime. (docs/example/authentication.md)Expanded and improved credential examples:
AzureCliCredential), Azure PowerShell (AzurePowerShellCredential), and Managed Identity (ManagedIdentityCredential) authentication flows, including updated guidance and environment-specific instructions for local, Azure DevOps, and GitHub Actions scenarios. (docs/example/authentication.md) [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]Security and best practices:
docs/example/authentication.md)These changes ensure users follow security best practices and have clear, up-to-date examples for authenticating with
fabric-cicdin a variety of environments.