Rename Set-FabricApiHeaders to Connect-FabricAccount and update docs#587
Open
SQLDBAWithABeard wants to merge 10 commits into
Open
Rename Set-FabricApiHeaders to Connect-FabricAccount and update docs#587SQLDBAWithABeard wants to merge 10 commits into
SQLDBAWithABeard wants to merge 10 commits into
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
…ding test Addresses non-blocking findings from final whole-branch review. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
This commit introduces the `Connect-FabricAccount` function as the primary method for authenticating to Microsoft Fabric. It replaces the previous `Set-FabricApiHeaders` function, which is now deprecated. The new function supports multiple authentication methods, including User Principal, Service Principal, and Managed Identity, providing a more flexible and user-friendly approach to managing authentication. Additionally, updates to the changelog and release notes reflect these changes, ensuring that users are informed of the new authentication process. Thank you!
Bump built module from 1.0.9 to 1.0.10 and promote the Unreleased
changelog entries (Connect-FabricAccount, New-Fabric{SemanticModel,Report}
-FolderId, Set-FabricApiHeaders deprecation) to the 1.0.10 release.
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Contributor
Author
|
next one for @MarkPryceMaherMSFT |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR renames the MicrosoftFabricMgmt module’s primary authentication cmdlet from Set-FabricApiHeaders to Connect-FabricAccount, keeping Set-FabricApiHeaders as a backward-compatible wrapper that emits a one-time-per-session deprecation warning, and updates module exports + docs accordingly.
Changes:
- Added
Connect-FabricAccountas the primary authentication implementation and introduced/updated tests for it. - Reworked
Set-FabricApiHeadersinto a wrapper that warns once per session and forwards toConnect-FabricAccount. - Updated module manifest exports and documentation/changelogs to reflect the new primary cmdlet name.
Reviewed changes
Copilot reviewed 17 out of 19 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/MicrosoftFabricMgmt/tests/Unit/Set-FabricApiHeaders.Tests.ps1 | Updates unit tests to validate wrapper behavior and parameter forwarding. |
| tools/MicrosoftFabricMgmt/tests/Unit/Connect-FabricAccount.Tests.ps1 | Adds unit tests for the new primary authentication cmdlet. |
| tools/MicrosoftFabricMgmt/source/Public/Utils/Set-FabricApiHeaders.ps1 | Replaces old implementation with deprecation-warning wrapper that forwards to Connect-FabricAccount. |
| tools/MicrosoftFabricMgmt/source/Public/Utils/Connect-FabricAccount.ps1 | Introduces the primary authentication implementation under the new cmdlet name. |
| tools/MicrosoftFabricMgmt/source/prefix.ps1 | Updates module startup/breaking-change notice to reference the new cmdlet. |
| tools/MicrosoftFabricMgmt/source/MicrosoftFabricMgmt.psd1 | Exports Connect-FabricAccount in addition to Set-FabricApiHeaders. |
| tools/MicrosoftFabricMgmt/README.md | Updates user-facing documentation and examples to use Connect-FabricAccount. |
| tools/MicrosoftFabricMgmt/output/ReleaseNotes.md | Bumps release notes entry and documents the new cmdlet + deprecation. |
| tools/MicrosoftFabricMgmt/output/module/MicrosoftFabricMgmt/1.0.10/MicrosoftFabricMgmt.psm1 | Updates built module output to include the new cmdlet and wrapper implementation. |
| tools/MicrosoftFabricMgmt/output/module/MicrosoftFabricMgmt/1.0.10/MicrosoftFabricMgmt.psd1 | Updates built manifest version/exports/release notes for the packaged module. |
| tools/MicrosoftFabricMgmt/output/module/MicrosoftFabricMgmt/1.0.10/MicrosoftFabricMgmt.Format.ps1xml | Adds formatting configuration to the built module output. |
| tools/MicrosoftFabricMgmt/output/CHANGELOG.md | Updates the generated changelog entry for the new version and deprecation. |
| tools/MicrosoftFabricMgmt/docs/superpowers/specs/2026-06-21-connect-fabricaccount-rename-design.md | Adds design spec documenting the rename and wrapper approach. |
| tools/MicrosoftFabricMgmt/docs/superpowers/plans/2026-06-21-connect-fabricaccount-rename.md | Adds an implementation plan for the rename + verification steps. |
| tools/MicrosoftFabricMgmt/docs/Set-FabricApiHeaders.md | Marks the old cmdlet doc as deprecated and points to the new cmdlet. |
| tools/MicrosoftFabricMgmt/docs/index.md | Updates docs index and examples to prefer Connect-FabricAccount. |
| tools/MicrosoftFabricMgmt/docs/Connect-FabricAccount.md | Adds a dedicated help page for the new cmdlet. |
| tools/MicrosoftFabricMgmt/CHANGELOG.md | Adds unreleased changelog entries for the new cmdlet and deprecation. |
| .gitignore | Ignores a presentation prompt file under the module directory. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Pull Request
This pull request makes
Connect-FabricAccountthe new primary authentication command for the MicrosoftFabricMgmt PowerShell module, replacingSet-FabricApiHeaders. The old command is now a backward-compatible wrapper that emits a deprecation warning once per session but remains fully supported. All documentation, changelogs, and references have been updated to reflect this change, and a new help file forConnect-FabricAccounthas been added.Authentication command rename and deprecation:
Connect-FabricAccountas the main authentication cmdlet, mirroring theConnect-AzAccountconvention. (CHANGELOG.md,ReleaseNotes.md, module manifest, documentation) [1] [2] [3] [4] [5]Set-FabricApiHeaders, making it a backward-compatible wrapper forConnect-FabricAccountthat emits a one-time-per-session warning. All parameters and behavior are preserved. (CHANGELOG.md,ReleaseNotes.md, documentation, design spec) [1] [2] [3] [4] [5]Documentation updates:
README.md,docs/index.md, and usage examples to useConnect-FabricAccountinstead ofSet-FabricApiHeaders, with notes about the deprecation and wrapper behavior. [1] [2] [3] [4] [5] [6]Connect-FabricAccountand updated theSet-FabricApiHeadershelp page to indicate its deprecated status and point users to the new command. [1] [2]These changes ensure a smoother, more standard authentication experience for users while maintaining backward compatibility for existing scripts.
Task list
build.ps1 -ResolveDependency -Tasks build, test).