Edsanche/431 add retention policy duration to powerplatform environment settings (#527)

* adding auditretentionperiodv2

* Updating to use auditretentionperiodv2

* Fixing go lint errors.

* Updating changes from PR comments.

* try TestAccTestEnvironmentSettingsResource_Validate_Read on test.

* Adding line to triger the test.

* Remove log_retention_period_in_days attribute from environment settings schema and update related tests

* Change AuditRetentionPeriodV2 type from int64 to int32 in environment settings DTO and model

* Change AuditRetentionPeriodV2 type from int64 to int32 in environment settings DTO and model

* Add log_retention_period_in_days attribute to environment settings documentation and schema

* fixing auditretentionperiodv2 json name

* updating prop validation

* Update log retention period handling and test validations

* Update documentation and schema for log retention period in environment settings

---------

Co-authored-by: github-actions[bot] <tfmod442916@users.noreply.github.com>
Co-authored-by: mawasile <50197777+mawasile@users.noreply.github.com>

Author: 3 people

.changes/unreleased/added-20241126-185401.yaml

@@ -0,0 +1,5 @@
+kind: added
+body: powerplatform_environment_settings adding log_retention_period_in_days.
+time: 2024-11-26T18:54:01.884697624Z
+custom:
+    Issue: "431"

docs/data-sources/environment_settings.md

@@ -42,6 +42,7 @@ Optional:
 - `is_audit_enabled` (Boolean) Is audit enabled
 - `is_read_audit_enabled` (Boolean) Is read audit enabled
 - `is_user_access_audit_enabled` (Boolean) Is user access audit enabled
+- `log_retention_period_in_days` (Number) Retain these logs for. See [Start/stop auditing for an environment and set retention policy](https://learn.microsoft.com/power-platform/admin/manage-dataverse-auditing#startstop-auditing-for-an-environment-and-set-retention-policy) You can set a retention period for how long audit logs are kept in an environment. Under Retain these logs for, choose the period of time you wish to retain the logs.
 
 
 

docs/resources/environment_settings.md

@@ -45,6 +45,7 @@ resource "powerplatform_environment_settings" "settings" {
       is_audit_enabled             = true
       is_user_access_audit_enabled = true
       is_read_audit_enabled        = true
+      log_retention_period_in_days = -1 //Forever
     }
   }
   email = {
@@ -97,6 +98,7 @@ Optional:
 - `is_audit_enabled` (Boolean) Is audit enabled
 - `is_read_audit_enabled` (Boolean) Is read audit enabled
 - `is_user_access_audit_enabled` (Boolean) Is user access audit enabled
+- `log_retention_period_in_days` (Number) Retain these logs for a value between 31 days and 24855 days, value of '-1' means logs will be retained forever. See [Start/stop auditing for an environment and set retention policy](https://learn.microsoft.com/power-platform/admin/manage-dataverse-auditing#startstop-auditing-for-an-environment-and-set-retention-policy) You can set a retention period for how long audit logs are kept in an environment. Under Retain these logs for, choose the period of time you wish to retain the logs.
 
 
 

examples/resources/powerplatform_environment_settings/resource.tf

@@ -30,6 +30,7 @@ resource "powerplatform_environment_settings" "settings" {
       is_audit_enabled             = true
       is_user_access_audit_enabled = true
       is_read_audit_enabled        = true
+      log_retention_period_in_days = -1 //Forever
     }
   }
   email = {

internal/services/environment_settings/datasource_environment_settings.go

@@ -110,59 +110,53 @@ func (d *EnvironmentSettingsDataSource) Schema(ctx context.Context, req datasour
 				Read:   false,
 			}),
 			"environment_id": schema.StringAttribute{
-				Description:         "Unique environment id (guid)",
 				MarkdownDescription: "Unique environment id (guid)",
 				Required:            true,
 			},
 			"audit_and_logs": schema.SingleNestedAttribute{
-				Description:         "Audit and Logs",
 				MarkdownDescription: "Audit and Logs",
 				Optional:            true,
 				Attributes: map[string]schema.Attribute{
 					"plugin_trace_log_setting": schema.StringAttribute{
-						Description:         "Plugin trace log setting. Available options: Off, Exception, All",
 						MarkdownDescription: "Plugin trace log setting. Available options: Off, Exception, All. See [Plugin Trace Log Settings Overview](https://learn.microsoft.com/power-apps/developer/data-platform/logging-tracing) for more details.",
 						Optional:            true,
 						Validators: []validator.String{
 							stringvalidator.OneOf("Off", "Exception", "All"),
 						},
 					},
 					"audit_settings": schema.SingleNestedAttribute{
-						Description:         "Audit Settings",
 						MarkdownDescription: "Audit Settings. See [Audit Settings Overview](https://learn.microsoft.com/power-platform/admin/system-settings-dialog-box-auditing-tab) for more details.",
 						Optional:            true,
 						Attributes: map[string]schema.Attribute{
 							"is_audit_enabled": schema.BoolAttribute{
-								Description:         "Is audit enabled",
 								MarkdownDescription: "Is audit enabled",
 								Optional:            true,
 							},
 							"is_user_access_audit_enabled": schema.BoolAttribute{
-								Description:         "Is user access audit enabled",
 								MarkdownDescription: "Is user access audit enabled",
 								Optional:            true,
 							},
 							"is_read_audit_enabled": schema.BoolAttribute{
-								Description:         "Is read audit enabled",
 								MarkdownDescription: "Is read audit enabled",
 								Optional:            true,
 							},
+							"log_retention_period_in_days": schema.Int32Attribute{
+								MarkdownDescription: "Retain these logs for. See [Start/stop auditing for an environment and set retention policy](https://learn.microsoft.com/power-platform/admin/manage-dataverse-auditing#startstop-auditing-for-an-environment-and-set-retention-policy) You can set a retention period for how long audit logs are kept in an environment. Under Retain these logs for, choose the period of time you wish to retain the logs.",
+								Optional:            true,
+							},
 						},
 					},
 				},
 			},
 			"email": schema.SingleNestedAttribute{
-				Description:         "Email",
 				MarkdownDescription: "Email",
 				Optional:            true,
 				Attributes: map[string]schema.Attribute{
 					"email_settings": schema.SingleNestedAttribute{
-						Description:         "Email Settings",
 						MarkdownDescription: "Email Settings. See [Email Settings Overview](https://learn.microsoft.com/power-platform/admin/settings-email) for more details.",
 						Optional:            true,
 						Attributes: map[string]schema.Attribute{
 							"max_upload_file_size_in_bytes": schema.Int64Attribute{
-								Description:         "Maximum file size that can be uploaded to the environment",
 								MarkdownDescription: "Maximum file size that can be uploaded to the environment",
 								Optional:            true,
 							},
@@ -171,24 +165,20 @@ func (d *EnvironmentSettingsDataSource) Schema(ctx context.Context, req datasour
 				},
 			},
 			"product": schema.SingleNestedAttribute{
-				Description:         "Product",
 				MarkdownDescription: "Product",
 				Optional:            true,
 				Attributes: map[string]schema.Attribute{
 					"behavior_settings": schema.SingleNestedAttribute{
-						Description:         "Behavior Settings",
 						MarkdownDescription: "Behavior Settings.See [Behavior Settings Overview](https://learn.microsoft.com/power-platform/admin/settings-behavior) for more details.",
 						Optional:            true,
 						Attributes: map[string]schema.Attribute{
 							"show_dashboard_cards_in_expanded_state": schema.BoolAttribute{
-								Description:         "Show dashboard cards in expanded state",
 								MarkdownDescription: "Show dashboard cards in expanded state",
 								Optional:            true,
 							},
 						},
 					},
 					"features": schema.SingleNestedAttribute{
-						Description:         "Features",
 						MarkdownDescription: "Features. See [Features Overview](https://learn.microsoft.com/power-platform/admin/settings-features) for more details.",
 						Optional:            true,
 						Attributes: map[string]schema.Attribute{

internal/services/environment_settings/datasource_environment_settings_test.go

@@ -40,6 +40,7 @@ func TestAccTestEnvironmentSettingsDataSource_Validate_Read(t *testing.T) {
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_audit_enabled", "false"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_read_audit_enabled", "false"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_user_access_audit_enabled", "false"),
+					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.log_retention_period_in_days", "-1"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "email.email_settings.max_upload_file_size_in_bytes", "5242880"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.plugin_trace_log_setting", "Off"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "product.behavior_settings.show_dashboard_cards_in_expanded_state", "false"),
@@ -78,6 +79,7 @@ func TestUnitTestEnvironmentSettingsDataSource_Validate_Read(t *testing.T) {
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_audit_enabled", "false"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_read_audit_enabled", "true"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_user_access_audit_enabled", "true"),
+					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.log_retention_period_in_days", "-1"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "email.email_settings.max_upload_file_size_in_bytes", "5242880"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "audit_and_logs.plugin_trace_log_setting", "Off"),
 					resource.TestCheckResourceAttr("data.powerplatform_environment_settings.settings", "product.behavior_settings.show_dashboard_cards_in_expanded_state", "true"),

internal/services/environment_settings/dto.go

@@ -13,6 +13,7 @@ type environmentSettingsDto struct {
 	IsAuditEnabled                           *bool   `json:"isauditenabled,omitempty"`
 	IsUserAccessAuditEnabled                 *bool   `json:"isuseraccessauditenabled,omitempty"`
 	IsReadAuditEnabled                       *bool   `json:"isreadauditenabled,omitempty"`
+	AuditRetentionPeriodV2                   *int32  `json:"auditretentionperiodv2,omitempty"`
 	BoundDashboardDefaultCardExpanded        *bool   `json:"bounddashboarddefaultcardexpanded,omitempty"`
 	OrganizationId                           *string `json:"organizationid,omitempty"`
 	PowerAppsComponentFrameworkForCanvasApps *bool   `json:"iscustomcontrolsincanvasappsenabled,omitempty"`

internal/services/environment_settings/models.go

@@ -47,9 +47,10 @@ type AuditAndLogsSourceModel struct {
 }
 
 type AuditSettingsSourceModel struct {
-	IsAuditEnabled           types.Bool `tfsdk:"is_audit_enabled"`
-	IsUserAccessAuditEnabled types.Bool `tfsdk:"is_user_access_audit_enabled"`
-	IsReadAuditEnabled       types.Bool `tfsdk:"is_read_audit_enabled"`
+	IsAuditEnabled           types.Bool  `tfsdk:"is_audit_enabled"`
+	IsUserAccessAuditEnabled types.Bool  `tfsdk:"is_user_access_audit_enabled"`
+	IsReadAuditEnabled       types.Bool  `tfsdk:"is_read_audit_enabled"`
+	AuditRetentionPeriodV2   types.Int32 `tfsdk:"log_retention_period_in_days"`
 }
 
 type EmailSourceModel struct {
@@ -89,6 +90,9 @@ func convertFromEnvironmentSettingsModel(ctx context.Context, environmentSetting
 		if !auditAndLogsSourceModel.IsReadAuditEnabled.IsNull() && !auditAndLogsSourceModel.IsReadAuditEnabled.IsUnknown() {
 			environmentSettingsDto.IsReadAuditEnabled = auditAndLogsSourceModel.IsReadAuditEnabled.ValueBoolPointer()
 		}
+		if !auditAndLogsSourceModel.AuditRetentionPeriodV2.IsNull() && !auditAndLogsSourceModel.AuditRetentionPeriodV2.IsUnknown() {
+			environmentSettingsDto.AuditRetentionPeriodV2 = auditAndLogsSourceModel.AuditRetentionPeriodV2.ValueInt32Pointer()
+		}
 
 		pluginSettings := environmentSettings.AuditAndLogs.Attributes()["plugin_trace_log_setting"]
 		if pluginSettings != nil && !pluginSettings.IsNull() && !pluginSettings.IsUnknown() {
@@ -165,16 +169,23 @@ func convertFromEnvironmentSettingsDto[T EnvironmentSettingsResourceModel | Envi
 		}
 	}
 
+	logRetentionPeriodTypeValue := types.Int32Value(-1)
+	if environmentSettingsDto.AuditRetentionPeriodV2 != nil {
+		logRetentionPeriodTypeValue = types.Int32Value(*environmentSettingsDto.AuditRetentionPeriodV2)
+	}
+
 	attrValuesAuditSettingsProperties := map[string]attr.Value{
 		"is_audit_enabled":             types.BoolValue(*environmentSettingsDto.IsAuditEnabled),
 		"is_user_access_audit_enabled": types.BoolValue(*environmentSettingsDto.IsUserAccessAuditEnabled),
 		"is_read_audit_enabled":        types.BoolValue(*environmentSettingsDto.IsReadAuditEnabled),
+		"log_retention_period_in_days": logRetentionPeriodTypeValue,
 	}
 
 	attrAuditSettingsObject := map[string]attr.Type{
 		"is_audit_enabled":             types.BoolType,
 		"is_user_access_audit_enabled": types.BoolType,
 		"is_read_audit_enabled":        types.BoolType,
+		"log_retention_period_in_days": types.Int32Type,
 	}
 
 	attrTypesAuditAndLogsObject := map[string]attr.Type{

internal/services/environment_settings/resource_environment_settings_test.go

@@ -61,6 +61,7 @@ func TestAccTestEnvironmentSettingsResource_Validate_Read(t *testing.T) {
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_audit_enabled", "true"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_read_audit_enabled", "true"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_user_access_audit_enabled", "true"),
+					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.log_retention_period_in_days", "-1"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "email.email_settings.max_upload_file_size_in_bytes", "100"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.plugin_trace_log_setting", "All"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "product.behavior_settings.show_dashboard_cards_in_expanded_state", "true"),
@@ -172,6 +173,7 @@ func TestUnitTestEnvironmentSettingsResource_Validate_Read(t *testing.T) {
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_audit_enabled", "true"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_read_audit_enabled", "true"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.is_user_access_audit_enabled", "true"),
+					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.audit_settings.log_retention_period_in_days", "-1"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "email.email_settings.max_upload_file_size_in_bytes", "100"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "audit_and_logs.plugin_trace_log_setting", "All"),
 					resource.TestCheckResourceAttr("powerplatform_environment_settings.settings", "product.behavior_settings.show_dashboard_cards_in_expanded_state", "true"),