new resource azurerm_api_management_workspace_policy_fragment

Author: sinbai

internal/services/apimanagement/api_management_workspace_policy_fragment_resource.go

@@ -0,0 +1,250 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package apimanagement
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/hashicorp/go-azure-helpers/lang/pointer"
+	"github.com/hashicorp/go-azure-helpers/lang/response"
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/policyfragment"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/workspace"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/services/apimanagement/schemaz"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/validation"
+)
+
+type ApiManagementWorkspacePolicyFragmentModel struct {
+	Name                     string `tfschema:"name"`
+	ApiManagementWorkspaceId string `tfschema:"api_management_workspace_id"`
+	Description              string `tfschema:"description"`
+	Format                   string `tfschema:"format"`
+	Value                    string `tfschema:"value"`
+}
+
+type ApiManagementWorkspacePolicyFragmentResource struct{}
+
+var _ sdk.ResourceWithUpdate = ApiManagementWorkspacePolicyFragmentResource{}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) ResourceType() string {
+	return "azurerm_api_management_workspace_policy_fragment"
+}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) ModelObject() interface{} {
+	return &ApiManagementWorkspacePolicyFragmentModel{}
+}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) IDValidationFunc() pluginsdk.SchemaValidateFunc {
+	return policyfragment.ValidateWorkspacePolicyFragmentID
+}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) Arguments() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{
+		"name": schemaz.SchemaApiManagementChildName(),
+
+		"api_management_workspace_id": commonschema.ResourceIDReferenceRequiredForceNew(&workspace.WorkspaceId{}),
+
+		"value": {
+			Type:             pluginsdk.TypeString,
+			Required:         true,
+			DiffSuppressFunc: XmlWhitespaceDiffSuppress,
+		},
+
+		"format": {
+			Type:     pluginsdk.TypeString,
+			Optional: true,
+			Default:  string(policyfragment.PolicyFragmentContentFormatXml),
+			ValidateFunc: validation.StringInSlice([]string{
+				string(policyfragment.PolicyFragmentContentFormatRawxml),
+				string(policyfragment.PolicyFragmentContentFormatXml),
+			}, false),
+		},
+
+		"description": {
+			Type:         pluginsdk.TypeString,
+			Optional:     true,
+			ValidateFunc: validation.StringIsNotEmpty,
+		},
+	}
+}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) Attributes() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{}
+}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) Create() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 30 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.ApiManagement.PolicyFragmentClient_v2024_05_01
+
+			var model ApiManagementWorkspacePolicyFragmentModel
+			if err := metadata.Decode(&model); err != nil {
+				return fmt.Errorf("decoding: %+v", err)
+			}
+
+			workspaceId, err := workspace.ParseWorkspaceID(model.ApiManagementWorkspaceId)
+			if err != nil {
+				return err
+			}
+
+			id := policyfragment.NewWorkspacePolicyFragmentID(workspaceId.SubscriptionId, workspaceId.ResourceGroupName, workspaceId.ServiceName, workspaceId.WorkspaceId, model.Name)
+			existing, err := client.WorkspacePolicyFragmentGet(ctx, id, policyfragment.WorkspacePolicyFragmentGetOperationOptions{
+				Format: pointer.To(policyfragment.PolicyFragmentContentFormat(model.Format)),
+			})
+			if err != nil && !response.WasNotFound(existing.HttpResponse) {
+				return fmt.Errorf("checking for presence of existing %s: %+v", id, err)
+			}
+
+			if !response.WasNotFound(existing.HttpResponse) {
+				return metadata.ResourceRequiresImport(r.ResourceType(), id)
+			}
+
+			parameters := policyfragment.PolicyFragmentContract{
+				Properties: &policyfragment.PolicyFragmentContractProperties{
+					Format: pointer.To(policyfragment.PolicyFragmentContentFormat(model.Format)),
+					Value:  model.Value,
+				},
+			}
+
+			if model.Description != "" {
+				parameters.Properties.Description = pointer.To(model.Description)
+			}
+
+			if err := client.WorkspacePolicyFragmentCreateOrUpdateThenPoll(ctx, id, parameters, policyfragment.WorkspacePolicyFragmentCreateOrUpdateOperationOptions{}); err != nil {
+				return fmt.Errorf("creating %s: %+v", id, err)
+			}
+
+			metadata.SetID(id)
+			return nil
+		},
+	}
+}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) Update() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 30 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.ApiManagement.PolicyFragmentClient_v2024_05_01
+
+			var model ApiManagementWorkspacePolicyFragmentModel
+			if err := metadata.Decode(&model); err != nil {
+				return fmt.Errorf("decoding: %+v", err)
+			}
+
+			id, err := policyfragment.ParseWorkspacePolicyFragmentID(metadata.ResourceData.Id())
+			if err != nil {
+				return err
+			}
+
+			resp, err := client.WorkspacePolicyFragmentGet(ctx, *id, policyfragment.WorkspacePolicyFragmentGetOperationOptions{
+				Format: pointer.To(policyfragment.PolicyFragmentContentFormat(model.Format)),
+			})
+			if err != nil {
+				return fmt.Errorf("retrieving %s: %+v", *id, err)
+			}
+
+			if resp.Model == nil {
+				return fmt.Errorf("retrieving %s: `model` was nil", *id)
+			}
+
+			if resp.Model.Properties == nil {
+				return fmt.Errorf("retrieving %s: `properties` was nil", *id)
+			}
+
+			payload := resp.Model
+			if metadata.ResourceData.HasChange("description") {
+				payload.Properties.Description = pointer.To(model.Description)
+			}
+
+			if metadata.ResourceData.HasChange("value") {
+				payload.Properties.Value = model.Value
+			}
+
+			if metadata.ResourceData.HasChange("format") {
+				payload.Properties.Format = pointer.To(policyfragment.PolicyFragmentContentFormat(model.Format))
+			}
+
+			if err := client.WorkspacePolicyFragmentCreateOrUpdateThenPoll(ctx, *id, *payload, policyfragment.WorkspacePolicyFragmentCreateOrUpdateOperationOptions{}); err != nil {
+				return fmt.Errorf("updating %s: %+v", *id, err)
+			}
+
+			return nil
+		},
+	}
+}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) Read() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 5 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.ApiManagement.PolicyFragmentClient_v2024_05_01
+
+			id, err := policyfragment.ParseWorkspacePolicyFragmentID(metadata.ResourceData.Id())
+			if err != nil {
+				return err
+			}
+
+			format := metadata.ResourceData.Get("format").(string)
+			if format == "" {
+				format = string(policyfragment.PolicyFragmentContentFormatXml)
+			}
+			resp, err := client.WorkspacePolicyFragmentGet(ctx, *id, policyfragment.WorkspacePolicyFragmentGetOperationOptions{
+				Format: pointer.To(policyfragment.PolicyFragmentContentFormat(format)),
+			})
+			if err != nil {
+				if response.WasNotFound(resp.HttpResponse) {
+					return metadata.MarkAsGone(*id)
+				}
+
+				return fmt.Errorf("retrieving %s: %+v", *id, err)
+			}
+
+			state := ApiManagementWorkspacePolicyFragmentModel{
+				Name:                     id.PolicyFragmentName,
+				ApiManagementWorkspaceId: workspace.NewWorkspaceID(id.SubscriptionId, id.ResourceGroupName, id.ServiceName, id.WorkspaceId).ID(),
+			}
+
+			if model := resp.Model; model != nil {
+				if props := model.Properties; props != nil {
+					state.Description = pointer.From(props.Description)
+					state.Value = props.Value
+
+					// The API only returns `format` when set to "rawxml"; the default "xml" is intentionally never returned.
+					format := policyfragment.PolicyFragmentContentFormatXml
+					if props.Format != nil {
+						format = pointer.From(props.Format)
+					}
+					state.Format = string(format)
+				}
+			}
+
+			return metadata.Encode(&state)
+		},
+	}
+}
+
+func (r ApiManagementWorkspacePolicyFragmentResource) Delete() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 30 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.ApiManagement.PolicyFragmentClient_v2024_05_01
+
+			id, err := policyfragment.ParseWorkspacePolicyFragmentID(metadata.ResourceData.Id())
+			if err != nil {
+				return err
+			}
+
+			if _, err := client.WorkspacePolicyFragmentDelete(ctx, *id, policyfragment.WorkspacePolicyFragmentDeleteOperationOptions{}); err != nil {
+				return fmt.Errorf("deleting %s: %+v", *id, err)
+			}
+
+			return nil
+		},
+	}
+}