Skip to content

Commit 754f7a0

Browse files
mattdotgithub-actions[bot]mawasile
authored
Updates to documentation (#511)
* Refactor provider configuration and remove deprecated release notes templates * Refactor provider configuration and remove deprecated release notes templates --------- Co-authored-by: github-actions[bot] <tfmod442916@users.noreply.github.com> Co-authored-by: mawasile <50197777+mawasile@users.noreply.github.com>
1 parent ba421a2 commit 754f7a0

15 files changed

+278
-247
lines changed

.changes/3.2.0.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## 3.2.0 - 2024-10-29
2+
3+
### ✨ Added
4+
5+
* [#423](https://github.com/microsoft/terraform-provider-power-platform/issues/423) adding powerplatform_environment_group_rule_set. **Currently not supported when using service principal authentication**
6+
7+
### 🪲 Fixed
8+
9+
* [#499](https://github.com/microsoft/terraform-provider-power-platform/issues/499) Fixing issue that dlp policies does not apply all connectors and require reapply
10+
* [#502](https://github.com/microsoft/terraform-provider-power-platform/issues/502) powerplatform_environment fixed error during environment update when a custom domain is set
11+
12+
### 📚 Documentation
13+
14+
* [#414](https://github.com/microsoft/terraform-provider-power-platform/issues/414) Improved documentation of `data_record` with examples for app users, business units, teams, and roles

.changes/unreleased/added-20241022-103532.yaml

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changes/unreleased/documentation-20241010-194509.yaml

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changes/unreleased/fixed-20241023-150045.yaml

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changes/unreleased/fixed-20241024-142026.yaml

Lines changed: 0 additions & 5 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
77
and is generated by [Changie](https://github.com/miniscruff/changie).
88

99

10+
## 3.2.0 - 2024-10-29
11+
12+
### ✨ Added
13+
14+
* [#423](https://github.com/microsoft/terraform-provider-power-platform/issues/423) adding powerplatform_environment_group_rule_set. **Currently not supported when using service principal authentication**
15+
16+
### 🪲 Fixed
17+
18+
* [#499](https://github.com/microsoft/terraform-provider-power-platform/issues/499) Fixing issue that dlp policies does not apply all connectors and require reapply
19+
* [#502](https://github.com/microsoft/terraform-provider-power-platform/issues/502) powerplatform_environment fixed error during environment update when a custom domain is set
20+
21+
### 📚 Documentation
22+
23+
* [#414](https://github.com/microsoft/terraform-provider-power-platform/issues/414) Improved documentation of `data_record` with examples for app users, business units, teams, and roles
24+
1025
## 3.1.0 - 2024-10-02
1126

1227
### ✨ Added

docs/guides/app_registration.md

Lines changed: 27 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ description: |-
77

88
# Creating an App Registration to use the Power Platform Provider
99

10-
You can follow this [guide](https://learn.microsoft.com/entra/identity-platform/quickstart-register-app#register-an-application) to create an app registration.
10+
The following steps will guide you through the process of manually creating an App Registration in Azure Active Directory to use the Power Platform Provider, but if you would like a script to run, see the [bootstrap scripts in the Power Platform QuickStarts](https://github.com/microsoft/power-platform-terraform-quickstarts/blob/main/bootstrap/tenant-configuration/main.tf)
11+
12+
## Register an Application
13+
14+
[The basics of how to create an app registration in Entra](https://learn.microsoft.com/entra/identity-platform/quickstart-register-app#register-an-application) are covered in Entra documentation. Familiarize yourself with the process and then follow the steps below to create an app registration for the Power Platform Provider.
1115

1216
## API Permissions
1317

@@ -23,87 +27,40 @@ Following API permissions are required to use the Terraform Power Platform provi
2327
- Licensing.Allocations.ReadWrite
2428
- Licensing.BillingPolicies.Read
2529
- Licensing.BillingPolicies.ReadWrite
26-
- Licensing.IsvContracts.Read
27-
- Licensing.IsvContracts.ReadWrite
30+
- PowerApps.Apps.Play
31+
- PowerApps.Apps.Read
32+
- EnvironmentManagement.Environments.Read
33+
- EnvironmentManagement.Groups.Read
34+
- EnvironmentManagement.Groups.ReadWrite
35+
- EnvironmentManagement.Settings.Read
36+
- EnvironmentManagement.Settings.ReadWrite
2837

2938
- PowerApps Service
3039
- User
3140

32-
Or you can add them directly into your App Registration manifest:
33-
34-
```json
35-
"requiredResourceAccess": [
36-
{
37-
"resourceAppId": "8578e004-a5c6-46e7-913e-12f58912df43",
38-
"resourceAccess": [
39-
{
40-
"id": "61bfce59-bddc-493f-b20c-32af5e904b83",
41-
"type": "Scope"
42-
},
43-
{
44-
"id": "9dafb9c1-c236-48b1-b142-20dcaab58675",
45-
"type": "Scope"
46-
},
47-
{
48-
"id": "048eb363-c1da-41d5-9edf-423b605ff23e",
49-
"type": "Scope"
50-
},
51-
{
52-
"id": "73cf5c38-5257-4f28-8bbb-f78acf3290a4",
53-
"type": "Scope"
54-
},
55-
{
56-
"id": "25223ba4-e810-4f08-9803-cde4b2057a13",
57-
"type": "Scope"
58-
},
59-
{
60-
"id": "a8f422ae-8922-45d4-a8f1-275a6bd43077",
61-
"type": "Scope"
62-
},
63-
{
64-
"id": "adef0bc0-3a5b-457a-834c-cabd82f0a6d2",
65-
"type": "Scope"
66-
},
67-
{
68-
"id": "3f4998a4-cbb8-4e1e-9ea0-fd7fc110bb74",
69-
"type": "Scope"
70-
}
71-
]
72-
},
73-
{
74-
"resourceAppId": "475226c6-020e-4fb2-8a90-7a972cbfc1d4",
75-
"resourceAccess": [
76-
{
77-
"id": "0eb56b90-a7b5-43b5-9402-8137a8083e90",
78-
"type": "Scope"
79-
}
80-
]
81-
},
82-
{
83-
"resourceAppId": "00000007-0000-0000-c000-000000000000",
84-
"resourceAccess": [
85-
{
86-
"id": "78ce3f0f-a1ce-49c2-8cde-64b5c0896db4",
87-
"type": "Scope"
88-
}
89-
]
90-
}
91-
]
41+
!> Note: If you don't see Power Platform API showing up in the list when searching by GUID, it's possible that you still have access to it but the visibility isn't refreshed. To force a refresh run the below PowerShell script:
42+
43+
```powershell
44+
#Install the Microsoft Entra the module
45+
Install-Module AzureAD
46+
47+
Connect-AzureAD
48+
New-AzureADServicePrincipal -AppId 8578e004-a5c6-46e7-913e-12f58912df43 -DisplayName "Power Platform API"
9249
```
9350

94-
>! Note: The `resourceAppId` values are the application IDs of the services in the Public cloud. If you are using a sovereign cloud, you will need to use the appropriate application IDs for those services.
51+
!> Note: The `resourceAppId` values are the application IDs of the services in the Public cloud. If you are [using a sovereign cloud](./nonpublic_clouds.md) the IDs will be different and you will need to use the appropriate application IDs for those services.
9552

9653
## Expose API
9754

98-
In "Expose API" menu of your App Registration, you need to define your application ID URI:
55+
In "Expose an API" menu of your App Registration, you need to define your application ID URI:
9956

10057
- Application ID URI: `api://<client_id>`, for example:
10158

10259
```plaintext
10360
api://powerplatform_provider_terraform
10461
```
10562

106-
- Add required scope:
63+
### Define scopes
10764

10865
1. Scope Name: `access`
10966
1. Who can consent: `Admins and users`
@@ -113,39 +70,9 @@ api://powerplatform_provider_terraform
11370
1. User consent description: `Allows connection to backend services of Power Platform Terraform Provider`
11471
1. State: `Enabled`
11572

116-
Or you can add them directly into your App Registration manifest:
117-
118-
```json
119-
"oauth2Permissions": [
120-
{
121-
"adminConsentDescription": "Allows connection to backend services of Power Platform Terraform Provider",
122-
"adminConsentDisplayName": "Work with Power Platform Terraform Provider",
123-
"id": "2aedce72-ddc7-431d-920c-a321297ffdc2",
124-
"isEnabled": true,
125-
"lang": null,
126-
"origin": "Application",
127-
"type": "User",
128-
"userConsentDescription": "Allows connection to backend services of Power Platform Terraform Provider",
129-
"userConsentDisplayName": "Work with Power Platform Terraform Provider",
130-
"value": "access"
131-
}
132-
],
133-
```
73+
### Authorizing client applications
13474

135-
- You will finially need to preuthorize Azure CLI to access your API by adding client application `04b07795-8ddb-461a-bbee-02f9e1bf7b46`
136-
137-
Or you can add them directly into your App Registration manifest:
138-
139-
```json
140-
"preAuthorizedApplications": [
141-
{
142-
"appId": "04b07795-8ddb-461a-bbee-02f9e1bf7b46",
143-
"permissionIds": [
144-
"2aedce72-ddc7-431d-920c-a321297ffdc2"
145-
]
146-
}
147-
]
148-
```
75+
You will finially need to preuthorize Azure CLI to access your API by adding client application `04b07795-8ddb-461a-bbee-02f9e1bf7b46`
14976

15077
## Usage
15178

@@ -154,3 +81,5 @@ After above steps you should be able to authenticate using Azure CLI:
15481
```bash
15582
az login --scope api://powerplatform_provider_terraform/.default
15683
```
84+
85+
If your tenant doesn't have any Azure subscriptions, you can use the `--allow-no-subscriptions` flag to login. If you are working in a web-based devcontainer and you need more control over the interactive login process you can use the `--use-device-code` flag.

docs/guides/release_notes.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ terraform {
2323
required_providers {
2424
powerplatform = {
2525
source = "microsoft/power-platform"
26-
version = "~> 1.0" # Replace with the latest version
26+
version = "~> 3.1" # Replace with the latest version
2727
}
2828
}
2929
}
@@ -176,7 +176,7 @@ In addition to the authentication options, the following options are also suppor
176176
177177
| Name | Description | Default Value |
178178
|------|-------------|---------------|
179-
| `telemetry_optout` | Opting out of telemetry will remove the hostheader from the requests made to the Power Platform service. There is no other telemetry data collected by the provider. This may affect the ability to identify and troubleshoot issues with the provider. | `false` |
179+
| `telemetry_optout` | Opting out of telemetry will remove the hostheader and session id headers from the requests made to the Power Platform service. There is no other telemetry data collected by the provider. This may affect the ability to identify and troubleshoot issues with the provider. | `false` |
180180
181181
## Resources and Data Sources
182182
@@ -188,6 +188,11 @@ Use the navigation to the left to read about the available resources and data so
188188

189189
More detailed examples can be found in the [Power Platform Terraform Quickstarts](https://github.com/microsoft/power-platform-terraform-quickstarts) repo. This repo contains a number of examples for using the Power Platform provider to manage environments and other resources within Power Platform along with Azure and Entra.
190190

191+
## Releases
192+
193+
A full list of released versions of the Power Platform Terraform Provider can be found [here](https://github.com/microsoft/terraform-provider-power-platform/releases). Starting from v3.0.0, a summary of the changes to the provider in each release are documented the [CHANGELOG.md file in the GitHub repository](https://github.com/microsoft/terraform-provider-power-platform/blob/main/CHANGELOG.md). This provider follows Semantic Versioning for releases. The provider version is incremented based on the type of changes included in the release.
194+
195+
191196
## Contributing
192197

193198
Contributions to this provider are always welcome! Please see the [Contribution Guidelines](https://github.com/microsoft/terraform-provider-power-platform/)

0 commit comments

Comments
 (0)