Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azurerm_automation_account: encryption.key_vault_key_id should be optional #20433

Closed
wants to merge 4 commits into from
Closed

azurerm_automation_account: encryption.key_vault_key_id should be optional #20433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f9ef19e
automation account encryption.key_vault_key_id should be optional
wuxu92 Feb 13, 2023
7049d4b
infere keysource from keyvaultkeyid
wuxu92 Feb 15, 2023
f8a26a5
update automation account encryption logic
wuxu92 Mar 6, 2023
35d2b7f
add GetKeyRotationPolicy permission for keyvault in acc test
wuxu92 Mar 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 21 additions & 15 deletions internal/services/automation/automation_account_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"log"
"time"

"github.com/hashicorp/go-azure-helpers/lang/pointer"
"github.com/hashicorp/go-azure-helpers/lang/response"
"github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema"
Expand Down Expand Up @@ -75,9 +76,10 @@ func resourceAutomationAccount() *pluginsdk.Resource {
},

"key_source": {
Type: pluginsdk.TypeString,
Optional: true,
Computed: true,
Type: pluginsdk.TypeString,
Optional: true,
Computed: true,
Deprecated: "`key_source` can inferred from if `key_vault_key_id` set",
ValidateFunc: validation.StringInSlice(
automationaccount.PossibleValuesForEncryptionKeySourceType(),
false,
Expand All @@ -86,7 +88,7 @@ func resourceAutomationAccount() *pluginsdk.Resource {

"key_vault_key_id": {
Type: pluginsdk.TypeString,
Required: true,
Optional: true,
ValidateFunc: keyVaultValidate.NestedItemIdWithOptionalVersion,
},
},
Expand Down Expand Up @@ -366,29 +368,33 @@ func resourceAutomationAccountDelete(d *pluginsdk.ResourceData, meta interface{}
}

func expandEncryption(encMap map[string]interface{}) (*automationaccount.EncryptionProperties, error) {
var id interface{}
id, ok := encMap["user_assigned_identity_id"].(string)
if !ok {
return nil, fmt.Errorf("read encryption user identity id error")
}
prop := &automationaccount.EncryptionProperties{
Identity: &automationaccount.EncryptionPropertiesIdentity{
UserAssignedIdentity: &id,
},
}
if val, ok := encMap["key_source"].(string); ok && val != "" {
prop.KeySource = (*automationaccount.EncryptionKeySourceType)(&val)
Identity: &automationaccount.EncryptionPropertiesIdentity{},
}
idObject, ok := encMap["user_assigned_identity_id"]
if ok {
if idStr, ok := idObject.(string); !ok {
return nil, fmt.Errorf("read encryption user identity id error")
} else if idStr != "" {
var id interface{} = idStr
prop.Identity.UserAssignedIdentity = &id
}
}

if keyIdStr := encMap["key_vault_key_id"].(string); keyIdStr != "" {
keyId, err := keyVaultParse.ParseOptionallyVersionedNestedItemID(keyIdStr)
if err != nil {
return nil, err
}

prop.KeySource = pointer.To(automationaccount.EncryptionKeySourceTypeMicrosoftPointKeyvault)
prop.KeyVaultProperties = &automationaccount.KeyVaultProperties{
KeyName: utils.String(keyId.Name),
KeyVersion: utils.String(keyId.Version),
KeyvaultUri: utils.String(keyId.KeyVaultBaseUrl),
}
} else {
prop.KeySource = pointer.To(automationaccount.EncryptionKeySourceTypeMicrosoftPointAutomation)
}
return prop, nil
}
Expand Down
38 changes: 32 additions & 6 deletions internal/services/automation/automation_account_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,26 @@ func TestAccAutomationAccount_encryption(t *testing.T) {

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.encryption(data),
Config: r.encryptionBasic(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
check.That(data.ResourceName).Key("encryption.0.key_source").HasValue("Microsoft.Automation"),
),
},
{
Config: r.encryptionKeyVault(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
check.That(data.ResourceName).Key("sku_name").HasValue("Basic"),
check.That(data.ResourceName).Key("local_authentication_enabled").HasValue("false"),
check.That(data.ResourceName).Key("encryption.0.key_source").HasValue("Microsoft.Keyvault"),
),
},
{
Config: r.encryptionBasic(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
check.That(data.ResourceName).Key("encryption.0.key_source").HasValue("Microsoft.Automation"),
),
},
data.ImportStep(),
})
}
Expand Down Expand Up @@ -275,7 +287,7 @@ resource "azurerm_automation_account" "test" {
`, data.RandomInteger, data.Locations.Primary)
}

func (AutomationAccountResource) encryption(data acceptance.TestData) string {
func (AutomationAccountResource) encryptionTemplate(data acceptance.TestData, encrypt string) string {
return fmt.Sprintf(`
provider "azurerm" {
features {
Expand Down Expand Up @@ -323,6 +335,7 @@ resource "azurerm_key_vault" "test" {
"List",
"Delete",
"Purge",
"GetRotationPolicy",
]

secret_permissions = [
Expand Down Expand Up @@ -383,13 +396,26 @@ resource "azurerm_automation_account" "test" {

local_authentication_enabled = false

%[3]s
}
`, data.RandomInteger, data.Locations.Primary, encrypt)
}

func (a AutomationAccountResource) encryptionBasic(data acceptance.TestData) string {
return a.encryptionTemplate(data, `
encryption {
}
`)
}

func (a AutomationAccountResource) encryptionKeyVault(data acceptance.TestData) string {
return a.encryptionTemplate(data, `
encryption {
key_source = "Microsoft.Keyvault"
user_assigned_identity_id = azurerm_user_assigned_identity.test.id
key_vault_key_id = azurerm_key_vault_key.test.id
}
}
`, data.RandomInteger, data.Locations.Primary)
`)
}

func (AutomationAccountResource) userAssignedIdentity(data acceptance.TestData) string {
Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/automation_account.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The following arguments are supported:

* `tags` - (Optional) A mapping of tags to assign to the resource.

* `encryption` - (Optional) An `encryption` block as defined below.
* `encryption` - (Optional) An `encryption` block as defined below. set as an empty block for `Microsoft.Automation` kind of encryption.

---

Expand All @@ -70,9 +70,9 @@ An `encryption` block supports the following:

* `user_assigned_identity_id` - (Optional) The User Assigned Managed Identity ID to be used for accessing the Customer Managed Key for encryption.

* `key_source` - (Optional) The source of the encryption key. Possible values are `Microsoft.Automation` and `Microsoft.Keyvault`.
* `key_source` - (Optional **Deprecated**) The source of the encryption key. Possible values are `Microsoft.Automation` and `Microsoft.Keyvault`. This field will be set to `Microsoft.Keyvault` when `key_vault_key_id` is set. otherwise it will be `Microsoft.Automation`.

* `key_vault_key_id` - (Required) The ID of the Key Vault Key which should be used to Encrypt the data in this Automation Account.
* `key_vault_key_id` - (Optional) The ID of the Key Vault Key which should be used to Encrypt the data in this Automation Account.

---

Expand Down