diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index c4010e0b..ff6ff896 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,6 +1,6 @@ // For format details, see https://aka.ms/devcontainer.json { - "name": "Fabric Terraform Provider", + "name": "Terraform Provider", // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile // Available base images: https://mcr.microsoft.com/v2/devcontainers/base/tags/list "image": "mcr.microsoft.com/devcontainers/base:ubuntu24.04", diff --git a/.devcontainer/features/tfprovider-local-dev/install.sh b/.devcontainer/features/tfprovider-local-dev/install.sh old mode 100644 new mode 100755 diff --git a/DEVELOPER.md b/DEVELOPER.md index 69625fdc..6322a2c6 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -65,7 +65,7 @@ Once you have the prerequisites, you can follow these steps to open the repo in 1. Open VS Code and press F1 to open the command palette. Type "Remote-Containers: Open Folder in Container..." and select it. 1. Browse to the folder where you cloned or forked the repo and click "Open". 1. VS Code will reload and start building the DevContainer image. This may take a few minutes depending on your network speed and the size of the image. -1. When the DevContainer is ready, you will see "Dev Container: Fabric Terraform Provider" in the lower left corner of the VS Code status bar. You can also open a new terminal (Ctrl+Shift+`) and see that you are inside the container. +1. When the DevContainer is ready, you will see "Dev Container: Terraform Provider" in the lower left corner of the VS Code status bar. You can also open a new terminal (Ctrl+Shift+`) and see that you are inside the container. 1. You can now edit, run, debug, and test the code as if you were on your local machine. Any changes you make will be reflected in the container and in your local file system. > [!NOTE] diff --git a/README.md b/README.md index bab533ca..e3a18767 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Terraform Provider for Microsoft Fabric -The Fabric Terraform Provider allows managing environments and other resources within [Microsoft Fabric](https://fabric.microsoft.com/). +The Microsoft Fabric Terraform Provider allows managing environments and other resources within [Microsoft Fabric](https://fabric.microsoft.com/). > [!WARNING] > This code is experimental and provided solely for evaluation purposes. It is **NOT** intended for production use and may contain bugs, incomplete features, or other issues. Use at your own risk, as it may undergo significant changes without notice, and no guarantees or support are provided. By using this code, you acknowledge and agree to these conditions. Consult the documentation or contact the maintainer if you have questions or concerns. diff --git a/docs/auth/auth_app_reg_spn.md b/docs/auth/auth_app_reg_spn.md index dd18032d..41849879 100644 --- a/docs/auth/auth_app_reg_spn.md +++ b/docs/auth/auth_app_reg_spn.md @@ -37,7 +37,7 @@ currentUserObjId=$(az ad signed-in-user show --output tsv --query id) # Create a new Entra Application # See https://learn.microsoft.com/cli/azure/ad/app#az-ad-app-create) for more details. -appObjId=$(az ad app create --display-name "Fabric Terraform Provider" --sign-in-audience AzureADMyOrg --output tsv --query id) +appObjId=$(az ad app create --display-name "Microsoft Fabric Terraform Provider" --sign-in-audience AzureADMyOrg --output tsv --query id) # (optional, recommended) Add the current user as an owner of the application # See https://learn.microsoft.com/cli/azure/ad/app/owner#az-ad-app-owner-add for more details. @@ -73,7 +73,7 @@ $currentUser = (Get-EntraUser -Filter "UserPrincipalName eq '$($ctx.Account)'" - # Create a new Entra Application # See https://learn.microsoft.com/powershell/module/microsoft.graph.entra/new-entraapplication for more details. -$app = (New-EntraApplication -DisplayName 'Fabric Terraform Provider' -SigninAudience AzureADMyOrg) +$app = (New-EntraApplication -DisplayName 'Microsoft Fabric Terraform Provider' -SigninAudience AzureADMyOrg) # (optional, recommended) Add the current user as an owner of the application # See https://learn.microsoft.com/powershell/module/microsoft.graph.entra/add-entraapplicationowner for more details. diff --git a/docs/auth/auth_app_reg_user.md b/docs/auth/auth_app_reg_user.md index a26d074a..7020ee7b 100644 --- a/docs/auth/auth_app_reg_user.md +++ b/docs/auth/auth_app_reg_user.md @@ -15,7 +15,7 @@ You can follow this [guide](https://learn.microsoft.com/entra/identity-platform/ ## Set API Permissions -In the **API permissions** menu of your App Registration, add required API permissions to use with the Fabric Terraform provider: +In the **API permissions** menu of your App Registration, add required API permissions to use with the Microsoft Fabric Terraform Provider: -> Depends on your solution you may add various set of API permissions. The below one are just an example. @@ -45,10 +45,10 @@ api://fabric_terraform_provider 1. Scope name: `default` 1. Who can consent: `Admins and users` -1. Admin consent display name: `Fabric Terraform Provider` -1. Admin consent description: `Allows connection to backend services for Fabric Terraform Provider` -1. User consent display name: `Fabric Terraform Provider` -1. User consent description: `Allows connection to backend services for Fabric Terraform Provider` +1. Admin consent display name: `Microsoft Fabric Terraform Provider` +1. Admin consent description: `Allows connection to backend services for Microsoft Fabric Terraform Provider` +1. User consent display name: `Microsoft Fabric Terraform Provider` +1. User consent description: `Allows connection to backend services for Microsoft Fabric Terraform Provider` 1. State: `Enabled` - You will finally need to pre-authorize Azure CLI/Azure PowerShell and Power BI to access your exposed API permissions by adding Azure CLI/Azure PowerShell and Power BI 1st party Microsoft applications. In the `Authorized client applications` section add: diff --git a/docs/guides/getting_started.md b/docs/guides/getting_started.md index b2c95d23..52b70eb0 100644 --- a/docs/guides/getting_started.md +++ b/docs/guides/getting_started.md @@ -8,11 +8,11 @@ description: |- # Getting started [HashiCorp Terraform](https://www.terraform.io/) is a popular open source tool for creating safe and predictable cloud infrastructure across several cloud providers. -You can use the Microsoft Fabric Terraform provider to manage your Microsoft Fabric workspaces using a flexible, powerful tool. -The goal of the Microsoft Fabric Terraform provider is to support automation of the most complicated aspects of deploying and managing Microsoft Fabric. -Microsoft Fabric customers are using the Microsoft Fabric Terraform provider to deploy and manage clusters and jobs and to configure data access. +You can use the Microsoft Fabric Terraform Provider to manage your Microsoft Fabric workspaces using a flexible, powerful tool. +The goal of the Microsoft Fabric Terraform Provider is to support automation of the most complicated aspects of deploying and managing Microsoft Fabric. +Microsoft Fabric customers are using the Microsoft Fabric Terraform Provider to deploy and manage clusters and jobs and to configure data access. -In this section, you install and configure requirements to use Terraform and the Microsoft Fabric Terraform provider on your local development machine. +In this section, you install and configure requirements to use Terraform and the Microsoft Fabric Terraform Provider on your local development machine. You then configure Terraform authentication. Following this section, this article provides a sample configuration that you can experiment with to provision a Microsoft Fabric notebook and lakehouse. ## Requirements @@ -27,7 +27,7 @@ You then configure Terraform authentication. Following this section, this articl Include Terraform configurations for your project in one or more configuration files in your Terraform project. For information about the configuration file syntax, see [Terraform Language Documentation](https://developer.hashicorp.com/terraform/language) on the Terraform website. -1. You must configure authentication for your Terraform project. See [Authentication](https://improved-adventure-935np96.pages.github.io/#authentication) in the Microsoft Fabric Terraform provider documentation. +1. You must configure authentication for your Terraform project. See [Authentication](https://improved-adventure-935np96.pages.github.io/#authentication) in the Microsoft Fabric Terraform Provider documentation. 1. You must have a [Fabric Capacity](https://learn.microsoft.com/fabric/enterprise/licenses#capacity) provisioned in Azure. A capacity can be added in the [Azure Portal](https://portal.azure.com/#browse/Microsoft.Fabric%2Fcapacities). Note: Please keep the capacity name handy, as we will use it below to fetch the capacity id. ## Sample configuration @@ -146,11 +146,11 @@ Microsoft Fabric workspace. We will also add a data source to fetch the Microsof ## Troubleshooting -> Note: For Terraform-specific support, see the Latest Terraform topics on the [HashiCorp Discuss website](https://discuss.hashicorp.com/). For issues specific to the Microsoft Fabric Terraform Provider, see Issues in the [cse-labs/terraform-provider-fabric](https://github.com/cse-labs/terraform-provider-fabric) GitHub repository. +> Note: For Terraform-specific support, see the Latest Terraform topics on the [HashiCorp Discuss website](https://discuss.hashicorp.com/). For issues specific to the Microsoft Fabric Terraform Provider, see Issues in the [microsoft/terraform-provider-fabric](https://github.com/microsoft/terraform-provider-fabric) GitHub repository. ### Enable logging -The Microsoft Fabric Terraform provider outputs logs that you can enable by setting the `TF_LOG` environment variable to `DEBUG` or any other log level that Terraform supports. +The Microsoft Fabric Terraform Provider outputs logs that you can enable by setting the `TF_LOG` environment variable to `DEBUG` or any other log level that Terraform supports. By default, logs are sent to `stderr`. To send logs to a file, set the `TF_LOG_PATH` environment variable to the target file path. diff --git a/docs/index.md b/docs/index.md index 085e5596..57c3604f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,12 @@ --- -page_title: "Fabric Provider" +page_title: "Microsoft Fabric Provider" description: |- --- -# Fabric Provider +# Microsoft Fabric Provider -The Fabric provider allows managing environments and other resources within [Microsoft Fabric](https://fabric.microsoft.com/). +The Microsoft Fabric Provider allows managing environments and other resources within [Microsoft Fabric](https://fabric.microsoft.com/). !> This code is experimental and provided solely for evaluation purposes. It is **NOT** intended for production use and may contain bugs, incomplete features, or other issues. Use at your own risk, as it may undergo significant changes without notice, and no guarantees or support are provided. By using this code, you acknowledge and agree to these conditions. Consult the documentation or contact the maintainer if you have questions or concerns. diff --git a/examples/guides/auth_app_reg_spn/app_reg.ps1 b/examples/guides/auth_app_reg_spn/app_reg.ps1 index 8d7f84c8..80134819 100644 --- a/examples/guides/auth_app_reg_spn/app_reg.ps1 +++ b/examples/guides/auth_app_reg_spn/app_reg.ps1 @@ -14,7 +14,7 @@ $currentUser = (Get-EntraUser -Filter "UserPrincipalName eq '$($ctx.Account)'" - # Create a new Entra Application # See https://learn.microsoft.com/powershell/module/microsoft.graph.entra/new-entraapplication for more details. -$app = (New-EntraApplication -DisplayName 'Fabric Terraform Provider' -SigninAudience AzureADMyOrg) +$app = (New-EntraApplication -DisplayName 'Microsoft Fabric Terraform Provider' -SigninAudience AzureADMyOrg) # (optional, recommended) Add the current user as an owner of the application # See https://learn.microsoft.com/powershell/module/microsoft.graph.entra/add-entraapplicationowner for more details. diff --git a/examples/guides/auth_app_reg_spn/app_reg.sh b/examples/guides/auth_app_reg_spn/app_reg.sh index dfcafde4..65c13fb9 100644 --- a/examples/guides/auth_app_reg_spn/app_reg.sh +++ b/examples/guides/auth_app_reg_spn/app_reg.sh @@ -10,7 +10,7 @@ currentUserObjId=$(az ad signed-in-user show --output tsv --query id) # Create a new Entra Application # See https://learn.microsoft.com/cli/azure/ad/app#az-ad-app-create) for more details. -appObjId=$(az ad app create --display-name "Fabric Terraform Provider" --sign-in-audience AzureADMyOrg --output tsv --query id) +appObjId=$(az ad app create --display-name "Microsoft Fabric Terraform Provider" --sign-in-audience AzureADMyOrg --output tsv --query id) # (optional, recommended) Add the current user as an owner of the application # See https://learn.microsoft.com/cli/azure/ad/app/owner#az-ad-app-owner-add for more details. diff --git a/internal/provider/provider.go b/internal/provider/provider.go index 82d013ba..ff42fed2 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -303,7 +303,7 @@ func (p *FabricProvider) Schema(ctx context.Context, _ provider.SchemaRequest, r // } func (p *FabricProvider) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse) { - tflog.Debug(ctx, "Fabric Terraform Provider configuration started") + tflog.Debug(ctx, "Microsoft Fabric Terraform Provider configuration started") tflog.Info(ctx, "Initializing Terraform Provider for Microsoft Fabric") var config pconfig.ProviderConfigModel diff --git a/templates/auth/auth_app_reg_user.md.tmpl b/templates/auth/auth_app_reg_user.md.tmpl index 32751c83..67008ea6 100644 --- a/templates/auth/auth_app_reg_user.md.tmpl +++ b/templates/auth/auth_app_reg_user.md.tmpl @@ -15,7 +15,7 @@ You can follow this [guide](https://learn.microsoft.com/entra/identity-platform/ ## Set API Permissions -In the **API permissions** menu of your App Registration, add required API permissions to use with the Fabric Terraform provider: +In the **API permissions** menu of your App Registration, add required API permissions to use with the Microsoft Fabric Terraform Provider: -> Depends on your solution you may add various set of API permissions. The below one are just an example. @@ -45,10 +45,10 @@ api://fabric_terraform_provider 1. Scope name: `default` 1. Who can consent: `Admins and users` -1. Admin consent display name: `Fabric Terraform Provider` -1. Admin consent description: `Allows connection to backend services for Fabric Terraform Provider` -1. User consent display name: `Fabric Terraform Provider` -1. User consent description: `Allows connection to backend services for Fabric Terraform Provider` +1. Admin consent display name: `Microsoft Fabric Terraform Provider` +1. Admin consent description: `Allows connection to backend services for Microsoft Fabric Terraform Provider` +1. User consent display name: `Microsoft Fabric Terraform Provider` +1. User consent description: `Allows connection to backend services for Microsoft Fabric Terraform Provider` 1. State: `Enabled` - You will finally need to pre-authorize Azure CLI/Azure PowerShell and Power BI to access your exposed API permissions by adding Azure CLI/Azure PowerShell and Power BI 1st party Microsoft applications. In the `Authorized client applications` section add: diff --git a/templates/guides/getting_started.md.tmpl b/templates/guides/getting_started.md.tmpl index 2d0cdc4d..fd401014 100644 --- a/templates/guides/getting_started.md.tmpl +++ b/templates/guides/getting_started.md.tmpl @@ -8,11 +8,11 @@ description: |- # Getting started [HashiCorp Terraform](https://www.terraform.io/) is a popular open source tool for creating safe and predictable cloud infrastructure across several cloud providers. -You can use the Microsoft Fabric Terraform provider to manage your Microsoft Fabric workspaces using a flexible, powerful tool. -The goal of the Microsoft Fabric Terraform provider is to support automation of the most complicated aspects of deploying and managing Microsoft Fabric. -Microsoft Fabric customers are using the Microsoft Fabric Terraform provider to deploy and manage clusters and jobs and to configure data access. +You can use the Microsoft Fabric Terraform Provider to manage your Microsoft Fabric workspaces using a flexible, powerful tool. +The goal of the Microsoft Fabric Terraform Provider is to support automation of the most complicated aspects of deploying and managing Microsoft Fabric. +Microsoft Fabric customers are using the Microsoft Fabric Terraform Provider to deploy and manage clusters and jobs and to configure data access. -In this section, you install and configure requirements to use Terraform and the Microsoft Fabric Terraform provider on your local development machine. +In this section, you install and configure requirements to use Terraform and the Microsoft Fabric Terraform Provider on your local development machine. You then configure Terraform authentication. Following this section, this article provides a sample configuration that you can experiment with to provision a Microsoft Fabric notebook and lakehouse. ## Requirements @@ -27,7 +27,7 @@ You then configure Terraform authentication. Following this section, this articl Include Terraform configurations for your project in one or more configuration files in your Terraform project. For information about the configuration file syntax, see [Terraform Language Documentation](https://developer.hashicorp.com/terraform/language) on the Terraform website. -1. You must configure authentication for your Terraform project. See [Authentication](https://improved-adventure-935np96.pages.github.io/#authentication) in the Microsoft Fabric Terraform provider documentation. +1. You must configure authentication for your Terraform project. See [Authentication](https://improved-adventure-935np96.pages.github.io/#authentication) in the Microsoft Fabric Terraform Provider documentation. 1. You must have a [Fabric Capacity](https://learn.microsoft.com/fabric/enterprise/licenses#capacity) provisioned in Azure. A capacity can be added in the [Azure Portal](https://portal.azure.com/#browse/Microsoft.Fabric%2Fcapacities). Note: Please keep the capacity name handy, as we will use it below to fetch the capacity id. ## Sample configuration @@ -130,11 +130,11 @@ Microsoft Fabric workspace. We will also add a data source to fetch the Microsof ## Troubleshooting -> Note: For Terraform-specific support, see the Latest Terraform topics on the [HashiCorp Discuss website](https://discuss.hashicorp.com/). For issues specific to the Microsoft Fabric Terraform Provider, see Issues in the [cse-labs/terraform-provider-fabric](https://github.com/cse-labs/terraform-provider-fabric) GitHub repository. +> Note: For Terraform-specific support, see the Latest Terraform topics on the [HashiCorp Discuss website](https://discuss.hashicorp.com/). For issues specific to the Microsoft Fabric Terraform Provider, see Issues in the [microsoft/terraform-provider-fabric](https://github.com/microsoft/terraform-provider-fabric) GitHub repository. ### Enable logging -The Microsoft Fabric Terraform provider outputs logs that you can enable by setting the `TF_LOG` environment variable to `DEBUG` or any other log level that Terraform supports. +The Microsoft Fabric Terraform Provider outputs logs that you can enable by setting the `TF_LOG` environment variable to `DEBUG` or any other log level that Terraform supports. By default, logs are sent to `stderr`. To send logs to a file, set the `TF_LOG_PATH` environment variable to the target file path. diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 5cfd89ba..07034284 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -1,12 +1,12 @@ --- -page_title: "{{ title .ProviderShortName}} Provider" +page_title: "Microsoft Fabric Provider" description: |- {{ .Description | plainmarkdown | trimspace | prefixlines " " }} --- -# {{ title .ProviderShortName }} Provider +# Microsoft Fabric Provider -The {{ title .ProviderShortName }} provider allows managing environments and other resources within [Microsoft {{ title .ProviderShortName }}](https://fabric.microsoft.com/). +The Microsoft Fabric Provider allows managing environments and other resources within [Microsoft Fabric](https://fabric.microsoft.com/). !> This code is experimental and provided solely for evaluation purposes. It is **NOT** intended for production use and may contain bugs, incomplete features, or other issues. Use at your own risk, as it may undergo significant changes without notice, and no guarantees or support are provided. By using this code, you acknowledge and agree to these conditions. Consult the documentation or contact the maintainer if you have questions or concerns.