Skip to content

feat: OPT1 Extend bicep CMK schema to support managedHSM keys #2409

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

Closed
eriqua wants to merge 4 commits into from
Closed

feat: OPT1 Extend bicep CMK schema to support managedHSM keys #2409

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ff91ea
draft cmk schema1 update
eriqua Oct 24, 2025
576209d
non null update
eriqua Oct 24, 2025
1f1a930
Merge branch 'main' into users/eriqua/bcp-cmk-hsm
eriqua Oct 28, 2025
6440290
update keyIdentifier
eriqua Oct 28, 2025
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
39 changes: 33 additions & 6 deletions docs/static/includes/interfaces/bicep/int.cmk.udt.schema1.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,39 @@ import { customerManagedKeyType } from 'br/public:avm/utl/types/avm-common-types
@description('Optional. The customer managed key definition.')
param customerManagedKey customerManagedKeyType?

// ============= //
// Variables //
// ============= //

var keyVaultType = !empty(customerManagedKey.?keyVaultResourceId)
? split(customerManagedKey.?keyVaultResourceId!, '/')[7]
: ''
var isHSMKeyVault = contains(keyVaultType, 'managedHSMs')

// ============= //
// Resources //
// ============= //

resource cMKKeyVault 'Microsoft.KeyVault/vaults@2023-02-01' existing = if (!empty(customerManagedKey.?keyVaultResourceId)) {
resource cMKKeyVault 'Microsoft.KeyVault/vaults@2024-11-01' existing = if (!isHSMKeyVault && !empty(customerManagedKey.?keyVaultResourceId)) {
name: last(split((customerManagedKey.?keyVaultResourceId!), '/'))
scope: resourceGroup(
split(customerManagedKey.?keyVaultResourceId!, '/')[2],
split(customerManagedKey.?keyVaultResourceId!, '/')[4]
)

resource cMKKey 'keys@2024-11-01' existing = if (!empty(customerManagedKey.?keyVaultResourceId) && !empty(customerManagedKey.?keyName)) {
name: customerManagedKey.?keyName!
}
}

resource hSMCMKKeyVault 'Microsoft.KeyVault/managedHSMs@2024-11-01' existing = if (isHSMKeyVault && !empty(customerManagedKey.?keyVaultResourceId)) {
name: last(split((customerManagedKey.?keyVaultResourceId!), '/'))
scope: resourceGroup(
split(customerManagedKey.?keyVaultResourceId!, '/')[2],
split(customerManagedKey.?keyVaultResourceId!, '/')[4]
)

resource cMKKey 'keys@2023-02-01' existing = if (!empty(customerManagedKey.?keyVaultResourceId) && !empty(customerManagedKey.?keyName)) {
resource hSMCMKKey 'keys@2024-11-01' existing = if (!empty(customerManagedKey.?keyVaultResourceId) && !empty(customerManagedKey.?keyName)) {
name: customerManagedKey.?keyName!
}
}
Expand All @@ -38,14 +59,20 @@ resource >singularMainResourceType< '>providerNamespace</>resourceType<@>apiVers
? {
keySource: 'Microsoft.KeyVault'
keyVaultProperties: {
keyVaultUri: cMKKeyVault.properties.vaultUri
keyVaultUri: !isHSMKeyVault ? cMKKeyVault!.properties.vaultUri : hSMCMKKeyVault!.properties.hsmUri
keyName: customerManagedKey!.keyName
keyVersion: !empty(customerManagedKey.?keyVersion)
? customerManagedKey!.keyVersion!
: last(split(cMKKeyVault::cMKKey!.properties.keyUriWithVersion, '/'))
: !isHSMKeyVault
? last(split(cMKKeyVault::cMKKey!.properties.keyUriWithVersion, '/'))
: last(split(hSMCMKKeyVault::hSMCMKKey!.properties.keyUriWithVersion, '/'))
keyIdentifier: !empty(customerManagedKey.?keyVersion)
? '${cMKKeyVault::cMKKey!.properties.keyUri}/${customerManagedKey!.keyVersion!}'
: cMKKeyVault::cMKKey!.properties.keyUriWithVersion
? ( !isHSMKeyVault
? '${cMKKeyVault::cMKKey!.properties.keyUri}/${customerManagedKey!.keyVersion!}'
: '${hSMCMKKeyVault::hSMCMKKey!.properties.keyUri}/${customerManagedKey!.keyVersion!}')
: ( !isHSMKeyVault
? cMKKeyVault::cMKKey!.properties.keyUriWithVersion
: hSMCMKKeyVault::hSMCMKKey!.properties.keyUriWithVersion)
identityClientId: !empty(customerManagedKey.?userAssignedIdentityResourceId)
? cMKUserAssignedIdentity!.properties.clientId
: null
Expand Down