Skip to content

fix(domain): added informations about Service Principal permissions o…#806

Open
CatalinDabuleanu wants to merge 7 commits intomainfrom
catalindabuleanu/domain-permissions
Open

fix(domain): added informations about Service Principal permissions o…#806
CatalinDabuleanu wants to merge 7 commits intomainfrom
catalindabuleanu/domain-permissions

Conversation

@CatalinDabuleanu
Copy link
Contributor

…n fabric_domain

📥 Pull Request

❓ What are you trying to address

Added informations about creating a domain using Service Principal

@CatalinDabuleanu CatalinDabuleanu requested a review from a team as a code owner February 2, 2026 01:44
Copilot AI review requested due to automatic review settings February 2, 2026 01:44
@github-actions
Copy link

github-actions bot commented Feb 2, 2026

Changelog Preview

v1.7.1-dev - February 04, 2026

✨ Added

  • #704 Enhanced fabric_workspace_git resource by adding new allow_override_items attribute

💫 Changed

  • #801 add support for fabric_domain GA APIs, removed preview for fabric_domain

🪲 Fixed

  • #767 Fix resource fabric_spark_environment_setting update pool not working
  • #742 Added information about Service Principal permissions for fabric_domain

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances the fabric_domain resource documentation and example to clarify Service Principal permission requirements when managing Fabric Domains. It also records the change in the unreleased changelog.

Changes:

  • Added a comment to the fabric_domain example Terraform configuration describing required admin API access and Service Principal permissions.
  • Updated the fabric_domain resource documentation example with the same permission-related note.
  • Added a .changes entry documenting the fix related to Service Principal permissions for fabric_domain (Issue 742).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
examples/resources/fabric_domain/resource.tf Adds an inline comment to the example Terraform config explaining permission requirements for Service Principals.
docs/resources/domain.md Updates the fabric_domain docs example to include a note about required admin API access and Service Principal permissions.
.changes/unreleased/fixed-20260202-014133.yaml Introduces a changelog entry summarizing the documentation update and linking it to Issue 742.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@badeamarjieh badeamarjieh added this to the 2026-03 milestone Feb 3, 2026
@github-actions
Copy link

github-actions bot commented Feb 4, 2026

Code Coverage

Package Line Rate Complexity Health
github.com/microsoft/terraform-provider-fabric/internal/auth 84% 0
github.com/microsoft/terraform-provider-fabric/internal/framework/customtypes 66% 0
github.com/microsoft/terraform-provider-fabric/internal/framework/planmodifiers 53% 0
github.com/microsoft/terraform-provider-fabric/internal/framework/typeutils 50% 0
github.com/microsoft/terraform-provider-fabric/internal/framework/validators 69% 0
github.com/microsoft/terraform-provider-fabric/internal/functions 75% 0
github.com/microsoft/terraform-provider-fabric/internal/pkg/fabricitem 76% 0
github.com/microsoft/terraform-provider-fabric/internal/pkg/tftypeinfo 75% 0
github.com/microsoft/terraform-provider-fabric/internal/pkg/transforms 77% 0
github.com/microsoft/terraform-provider-fabric/internal/pkg/utils 85% 0
github.com/microsoft/terraform-provider-fabric/internal/provider/client 91% 0
github.com/microsoft/terraform-provider-fabric/internal/provider/config 100% 0
github.com/microsoft/terraform-provider-fabric/internal/provider 80% 0
github.com/microsoft/terraform-provider-fabric/internal/provider/utils 63% 0
github.com/microsoft/terraform-provider-fabric/internal/services/activator 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/apacheairflowjob 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/capacity 84% 0
github.com/microsoft/terraform-provider-fabric/internal/services/connection 72% 0
github.com/microsoft/terraform-provider-fabric/internal/services/connectionra 71% 0
github.com/microsoft/terraform-provider-fabric/internal/services/copyjob 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/dashboard 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/dataflow 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/datamart 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/datapipeline 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/deploymentpipeline 68% 0
github.com/microsoft/terraform-provider-fabric/internal/services/deploymentpipelinera 70% 0
github.com/microsoft/terraform-provider-fabric/internal/services/digitaltwinbuilder 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/domain 76% 0
github.com/microsoft/terraform-provider-fabric/internal/services/domainra 62% 0
github.com/microsoft/terraform-provider-fabric/internal/services/domainwa 71% 0
github.com/microsoft/terraform-provider-fabric/internal/services/environment 86% 0
github.com/microsoft/terraform-provider-fabric/internal/services/eventhouse 93% 0
github.com/microsoft/terraform-provider-fabric/internal/services/eventstream 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/eventstreamsourceconnection 83% 0
github.com/microsoft/terraform-provider-fabric/internal/services/folder 75% 0
github.com/microsoft/terraform-provider-fabric/internal/services/gateway 79% 0
github.com/microsoft/terraform-provider-fabric/internal/services/gatewayra 55% 0
github.com/microsoft/terraform-provider-fabric/internal/services/graphqlapi 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/itemjobscheduler 72% 0
github.com/microsoft/terraform-provider-fabric/internal/services/kqldashboard 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/kqldatabase 87% 0
github.com/microsoft/terraform-provider-fabric/internal/services/kqlqueryset 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/lakehouse 85% 0
github.com/microsoft/terraform-provider-fabric/internal/services/lakehousetable 80% 0
github.com/microsoft/terraform-provider-fabric/internal/services/mirroreddatabase 83% 0
github.com/microsoft/terraform-provider-fabric/internal/services/mirroredwarehouse 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/mlexperiment 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/mlmodel 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/mounteddatafactory 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/notebook 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/paginatedreport 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/report 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/semanticmodel 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/shortcut 78% 0
github.com/microsoft/terraform-provider-fabric/internal/services/sparkcustompool 70% 0
github.com/microsoft/terraform-provider-fabric/internal/services/sparkenvsettings 79% 0
github.com/microsoft/terraform-provider-fabric/internal/services/sparkjobdefinition 89% 0
github.com/microsoft/terraform-provider-fabric/internal/services/sparkwssettings 83% 0
github.com/microsoft/terraform-provider-fabric/internal/services/sqldatabase 90% 0
github.com/microsoft/terraform-provider-fabric/internal/services/sqlendpoint 100% 0
github.com/microsoft/terraform-provider-fabric/internal/services/variablelibrary 90% 0
github.com/microsoft/terraform-provider-fabric/internal/services/warehouse 91% 0
github.com/microsoft/terraform-provider-fabric/internal/services/warehousesnapshot 90% 0
github.com/microsoft/terraform-provider-fabric/internal/services/workspace 79% 0
github.com/microsoft/terraform-provider-fabric/internal/services/workspacegit 70% 0
github.com/microsoft/terraform-provider-fabric/internal/services/workspacempe 77% 0
github.com/microsoft/terraform-provider-fabric/internal/services/workspacera 76% 0
Summary 76% (18897 / 24814) 0

Minimum allowed line rate is 40%

Copy link
Member

@badeamarjieh badeamarjieh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we could split it into 2 notes:

  1. The first one is whether the resource/data-source uses underlying Admin APIs. if that's true, we should add a note saying The caller must be a Fabric administrator.
  2. The second one is if the resource/data-source (1) uses underlying Admin APIs, and (2) supports service principal. In that case, we should add another note to link to this documentation https://learn.microsoft.com/en-us/fabric/admin/enable-service-principal-admin-apis#enable-service-principal-authentication

so I would suggest adding one property to the base.go which specifies if the resource/data-source requires the caller to be fabric Admin. e.g., IsAdmin, and add 2 notes (if needed), one based on IsAdmin and the other based on IsAdmin and IsSPNSupported. or maybe you can use the existing note for SP support to add text to it, or if you have other suggestions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants