Skip to content

azurerm_databricks_workspace_root_dbfs_customer_managed_key - fix panics, allow managed hsm, and allow versionless keys#31336

Merged
sreallymatt merged 2 commits intomainfrom
mp/ipl-8802
Dec 11, 2025
Merged

azurerm_databricks_workspace_root_dbfs_customer_managed_key - fix panics, allow managed hsm, and allow versionless keys#31336
sreallymatt merged 2 commits intomainfrom
mp/ipl-8802

Conversation

@sreallymatt
Copy link
Collaborator

@sreallymatt sreallymatt commented Dec 10, 2025

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

PR resolves some bugs and adds additional functionality:

  • resolves panics in the event the CMK is removed from the azurerm_databricks_workspace
  • fixes the delete timeout (it was using the read timeout value, which is too short in many cases)
  • adds support for keys from a managed HSM vault
  • adds support for versionless keys

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

Changes to existing Resource / Data Source

  • I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
  • I have written new tests for my resource or datasource changes & updated any relevant documentation.
  • I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
  • (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

  • My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

2 failures:
image

basicAltSubscription was ignoring the wrong field during the ImportStep, fixed and reran:

--- PASS: TestAccDatabricksWorkspaceRootDbfsCustomerManagedKey_basicAltSubscription (1127.01s)

basicManagedHSM seems to have failed due to a timing issue regarding the permissions allocated to the SP running Terraform. Transient error, succeeded on rerun:

--- PASS: TestAccDatabricksWorkspaceRootDbfsCustomerManagedKey_basicManagedHSM (3352.33s)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

  • azurerm_resource - support for the thing1 property [GH-00000]

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Related Issue(s)

Fixes #25896
Fixes #27739

AI Assistance Disclosure

  • AI Assisted - This contribution was made by, or with the assistance of, AI/LLMs

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the provider.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

…te resource to prevent panics, allow managed hsm, and allow versionless keys
catriona-m
catriona-m previously approved these changes Dec 11, 2025
Copy link
Member

@catriona-m catriona-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sreallymatt LGTM! Left one comment on your //todo but we don't necessarily have to fix that in this pr.

// Only throw the import error if the keysource value has been set to something other than default...
if params.Encryption != nil && params.Encryption.Value != nil && keySource != workspaces.KeySourceDefault {
return tf.ImportAsExistsError("azurerm_databricks_workspace_root_dbfs_customer_managed_key", id.ID())
// TODO: consider removing this check and deprecating the `key_vault_id` property.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that we should probably remove these checks from the create/update. We don't typically check this in other customer_managed_key resources and there doesn't seem to be any particular reason it was added in this one in the first place?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No particular reason I was able to find, I'll add an issue internally to resolve this TODO

@sreallymatt sreallymatt merged commit 1245ba0 into main Dec 11, 2025
56 of 58 checks passed
@sreallymatt sreallymatt deleted the mp/ipl-8802 branch December 11, 2025 17:50
@github-actions github-actions bot added this to the v4.56.0 milestone Dec 11, 2025
sreallymatt added a commit that referenced this pull request Dec 11, 2025
sreallymatt added a commit that referenced this pull request Dec 11, 2025
@github-actions
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 11, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

2 participants