Skip to main content

ManagedHsmRoleDefinition

Properties

PropertyTypeAttributesDescription
namestringRequired, IdentifierThe name of the role definition. Must be a GUID.
scopestringRequired, IdentifierThe scope the role definition applies to, e.g. '/' or '/keys'.
assignableScopesstring[]The scopes the role can be assigned at. Defaults to the role definition's own scope.
descriptionstringA description of the role.
idstringRead-onlyThe fully qualified ID of the role definition.
managedHsmUristringIdentifierThe URI of the Managed HSM. Defaults to the 'managedHsmUri' supplied in the extension configuration.
permissionsManagedHsmPermission[]The permissions granted by the role.
roleNamestringThe display name of the role.
roleTypestringRead-onlyThe type of the role. Either 'AKVBuiltInRole' or 'CustomRole'.

ManagedHsmPermission

PropertyTypeAttributesDescription
actionsstring[]Control plane actions allowed by the role.
dataActionsstring[]Data plane actions allowed by the role, e.g. 'Microsoft.KeyVault/managedHsm/keys/read/action'.
notActionsstring[]Control plane actions denied by the role.
notDataActionsstring[]Data plane actions denied by the role.