/
policy_set_definition_resource.go
384 lines (315 loc) · 11.8 KB
/
policy_set_definition_resource.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
package policy
import (
"context"
"encoding/json"
"fmt"
"log"
"reflect"
"regexp"
"strconv"
"strings"
"time"
"github.com/Azure/azure-sdk-for-go/services/resources/mgmt/2019-09-01/policy"
"github.com/Azure/go-autorest/autorest"
"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/helper/structure"
"github.com/hashicorp/terraform-plugin-sdk/helper/validation"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/helpers/tf"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/clients"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/features"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/policy/parse"
azSchema "github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/tf/schema"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/timeouts"
"github.com/terraform-providers/terraform-provider-azurerm/azurerm/utils"
)
func resourceArmPolicySetDefinition() *schema.Resource {
return &schema.Resource{
Create: resourceArmPolicySetDefinitionCreateUpdate,
Update: resourceArmPolicySetDefinitionCreateUpdate,
Read: resourceArmPolicySetDefinitionRead,
Delete: resourceArmPolicySetDefinitionDelete,
Importer: azSchema.ValidateResourceIDPriorToImport(func(id string) error {
_, err := parse.PolicySetDefinitionID(id)
return err
}),
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(30 * time.Minute),
Read: schema.DefaultTimeout(5 * time.Minute),
Update: schema.DefaultTimeout(30 * time.Minute),
Delete: schema.DefaultTimeout(30 * time.Minute),
},
Schema: map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
ValidateFunc: validation.StringIsNotEmpty,
},
"policy_type": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{
string(policy.BuiltIn),
string(policy.Custom),
string(policy.NotSpecified),
string(policy.Static),
}, false),
},
"management_group_id": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
},
"display_name": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringIsNotEmpty,
},
"description": {
Type: schema.TypeString,
Optional: true,
},
"metadata": {
Type: schema.TypeString,
Optional: true,
Computed: true,
ValidateFunc: validation.StringIsJSON,
DiffSuppressFunc: policySetDefinitionsMetadataDiffSuppressFunc,
},
"parameters": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validation.StringIsJSON,
DiffSuppressFunc: structure.SuppressJsonDiff,
},
"policy_definitions": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validation.StringIsJSON,
DiffSuppressFunc: policyDefinitionsDiffSuppressFunc,
},
},
}
}
func policySetDefinitionsMetadataDiffSuppressFunc(_, old, new string, _ *schema.ResourceData) bool {
var oldPolicySetDefinitionsMetadata map[string]interface{}
errOld := json.Unmarshal([]byte(old), &oldPolicySetDefinitionsMetadata)
if errOld != nil {
return false
}
var newPolicySetDefinitionsMetadata map[string]interface{}
errNew := json.Unmarshal([]byte(new), &newPolicySetDefinitionsMetadata)
if errNew != nil {
return false
}
// Ignore the following keys if they're found in the metadata JSON
ignoreKeys := [4]string{"createdBy", "createdOn", "updatedBy", "updatedOn"}
for _, key := range ignoreKeys {
delete(oldPolicySetDefinitionsMetadata, key)
delete(newPolicySetDefinitionsMetadata, key)
}
return reflect.DeepEqual(oldPolicySetDefinitionsMetadata, newPolicySetDefinitionsMetadata)
}
func policyDefinitionsDiffSuppressFunc(_, old, new string, _ *schema.ResourceData) bool {
var oldPolicyDefinitions []policy.DefinitionReference
errOld := json.Unmarshal([]byte(old), &oldPolicyDefinitions)
if errOld != nil {
return false
}
var newPolicyDefinitions []policy.DefinitionReference
errNew := json.Unmarshal([]byte(new), &newPolicyDefinitions)
if errNew != nil {
return false
}
for i := range newPolicyDefinitions {
newPolicyDefinitions[i].PolicyDefinitionReferenceID = nil
}
for i := range oldPolicyDefinitions {
oldPolicyDefinitions[i].PolicyDefinitionReferenceID = nil
}
return reflect.DeepEqual(oldPolicyDefinitions, newPolicyDefinitions)
}
func resourceArmPolicySetDefinitionCreateUpdate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*clients.Client).Policy.SetDefinitionsClient
ctx, cancel := timeouts.ForCreateUpdate(meta.(*clients.Client).StopContext, d)
defer cancel()
name := d.Get("name").(string)
policyType := d.Get("policy_type").(string)
displayName := d.Get("display_name").(string)
description := d.Get("description").(string)
managementGroupID := d.Get("management_group_id").(string)
if features.ShouldResourcesBeImported() && d.IsNewResource() {
existing, err := getPolicySetDefinitionByName(ctx, client, name, managementGroupID)
if err != nil {
if !utils.ResponseWasNotFound(existing.Response) {
return fmt.Errorf("Error checking for presence of existing Policy Set Definition %q: %s", name, err)
}
}
if existing.ID != nil && *existing.ID != "" {
return tf.ImportAsExistsError("azurerm_policy_set_definition", *existing.ID)
}
}
properties := policy.SetDefinitionProperties{
PolicyType: policy.Type(policyType),
DisplayName: utils.String(displayName),
Description: utils.String(description),
}
if metaDataString := d.Get("metadata").(string); metaDataString != "" {
metaData, err := structure.ExpandJsonFromString(metaDataString)
if err != nil {
return fmt.Errorf("unable to expand metadata json: %s", err)
}
properties.Metadata = &metaData
}
if parametersString := d.Get("parameters").(string); parametersString != "" {
parameters, err := expandParameterDefinitionsValueFromString(parametersString)
if err != nil {
return fmt.Errorf("unable to expand parameters json: %s", err)
}
properties.Parameters = parameters
}
if policyDefinitionsString := d.Get("policy_definitions").(string); policyDefinitionsString != "" {
var policyDefinitions []policy.DefinitionReference
err := json.Unmarshal([]byte(policyDefinitionsString), &policyDefinitions)
if err != nil {
return fmt.Errorf("unable to expand parameters json: %s", err)
}
properties.PolicyDefinitions = &policyDefinitions
}
definition := policy.SetDefinition{
Name: utils.String(name),
SetDefinitionProperties: &properties,
}
var err error
if managementGroupID == "" {
_, err = client.CreateOrUpdate(ctx, name, definition)
} else {
_, err = client.CreateOrUpdateAtManagementGroup(ctx, name, definition, managementGroupID)
}
if err != nil {
return fmt.Errorf("Error creating/updating Policy Set Definition %q: %s", name, err)
}
// Policy Definitions are eventually consistent; wait for them to stabilize
log.Printf("[DEBUG] Waiting for Policy Set Definition %q to become available", name)
stateConf := &resource.StateChangeConf{
Pending: []string{"404"},
Target: []string{"200"},
Refresh: policySetDefinitionRefreshFunc(ctx, client, name, managementGroupID),
MinTimeout: 10 * time.Second,
ContinuousTargetOccurence: 10,
}
if d.IsNewResource() {
stateConf.Timeout = d.Timeout(schema.TimeoutCreate)
} else {
stateConf.Timeout = d.Timeout(schema.TimeoutUpdate)
}
if _, err = stateConf.WaitForState(); err != nil {
return fmt.Errorf("Error waiting for Policy Set Definition %q to become available: %s", name, err)
}
var resp policy.SetDefinition
resp, err = getPolicySetDefinitionByName(ctx, client, name, managementGroupID)
if err != nil {
return fmt.Errorf("Error retrieving Policy Set Definition %q: %s", name, err)
}
d.SetId(*resp.ID)
return resourceArmPolicySetDefinitionRead(d, meta)
}
func resourceArmPolicySetDefinitionRead(d *schema.ResourceData, meta interface{}) error {
client := meta.(*clients.Client).Policy.SetDefinitionsClient
ctx, cancel := timeouts.ForRead(meta.(*clients.Client).StopContext, d)
defer cancel()
name, err := parsePolicySetDefinitionNameFromId(d.Id())
if err != nil {
return err
}
managementGroupID := parseManagementGroupIdFromPolicySetId(d.Id())
resp, err := getPolicySetDefinitionByName(ctx, client, name, managementGroupID)
if err != nil {
if utils.ResponseWasNotFound(resp.Response) {
log.Printf("[INFO] Error reading Policy Set Definition %q - removing from state", d.Id())
d.SetId("")
return nil
}
return fmt.Errorf("Error reading Policy Set Definition %+v", err)
}
d.Set("name", resp.Name)
d.Set("management_group_id", managementGroupID)
if props := resp.SetDefinitionProperties; props != nil {
d.Set("policy_type", string(props.PolicyType))
d.Set("display_name", props.DisplayName)
d.Set("description", props.Description)
if metadata := props.Metadata; metadata != nil {
metadataVal := metadata.(map[string]interface{})
metadataStr, err := structure.FlattenJsonToString(metadataVal)
if err != nil {
return fmt.Errorf("unable to flatten JSON for `metadata`: %s", err)
}
d.Set("metadata", metadataStr)
}
if props.Parameters != nil {
parametersStr, err := flattenParameterDefintionsValueToString(props.Parameters)
if err != nil {
return fmt.Errorf("unable to flatten JSON for `parameters`: %s", err)
}
d.Set("parameters", parametersStr)
}
if policyDefinitions := props.PolicyDefinitions; policyDefinitions != nil {
policyDefinitionsRes, err := json.Marshal(policyDefinitions)
if err != nil {
return fmt.Errorf("unable to flatten JSON for `policy_defintions`: %s", err)
}
policyDefinitionsStr := string(policyDefinitionsRes)
d.Set("policy_definitions", policyDefinitionsStr)
}
}
return nil
}
func resourceArmPolicySetDefinitionDelete(d *schema.ResourceData, meta interface{}) error {
client := meta.(*clients.Client).Policy.SetDefinitionsClient
ctx, cancel := timeouts.ForDelete(meta.(*clients.Client).StopContext, d)
defer cancel()
name, err := parsePolicySetDefinitionNameFromId(d.Id())
if err != nil {
return err
}
managementGroupID := parseManagementGroupIdFromPolicySetId(d.Id())
var resp autorest.Response
if managementGroupID == "" {
resp, err = client.Delete(ctx, name)
} else {
resp, err = client.DeleteAtManagementGroup(ctx, name, managementGroupID)
}
if err != nil {
if utils.ResponseWasNotFound(resp) {
return nil
}
return fmt.Errorf("Error deleting Policy Set Definition %q: %+v", name, err)
}
return nil
}
func parsePolicySetDefinitionNameFromId(id string) (string, error) {
components := strings.Split(id, "/")
if len(components) == 0 {
return "", fmt.Errorf("Azure Policy Set Definition Id is empty or not formatted correctly: %s", id)
}
return components[len(components)-1], nil
}
func parseManagementGroupIdFromPolicySetId(id string) string {
r := regexp.MustCompile("managementgroups/(.+)/providers/.*$")
if r.MatchString(id) {
matches := r.FindAllStringSubmatch(id, -1)[0]
return matches[1]
}
return ""
}
func policySetDefinitionRefreshFunc(ctx context.Context, client *policy.SetDefinitionsClient, name string, managementGroupId string) resource.StateRefreshFunc {
return func() (interface{}, string, error) {
res, err := getPolicySetDefinitionByName(ctx, client, name, managementGroupId)
if err != nil {
return nil, strconv.Itoa(res.StatusCode), fmt.Errorf("Error issuing read request in policySetDefinitionRefreshFunc for Policy Set Definition %q: %s", name, err)
}
return res, strconv.Itoa(res.StatusCode), nil
}
}