ManagedHsmProperties interface
Properties of the managed HSM Pool
Properties
| create |
The create mode to indicate whether the resource is being created or is being recovered from a deleted resource. |
| enable |
Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. Enabling this functionality is irreversible. |
| enable |
Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. Soft delete is enabled by default for all managed HSMs and is immutable. |
| hsm |
The URI of the managed hsm pool for performing operations on keys. |
| initial |
Array of initial administrators object ids for this managed hsm pool. |
| network |
Rules governing the accessibility of the key vault from specific network locations. |
| private |
List of private endpoint connections associated with the managed hsm pool. |
| provisioning |
Provisioning state. |
| public |
Control permission to the managed HSM from public networks. |
| regions | List of all regions associated with the managed hsm pool. |
| scheduled |
The scheduled purge date in UTC. |
| security |
Managed HSM security domain properties. |
| soft |
Soft deleted data retention days. When you delete an HSM or a key, it will remain recoverable for the configured retention period or for a default period of 90 days. It accepts values between 7 and 90. |
| status |
Resource Status Message. |
| tenant |
The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool. |
Property Details
createMode
The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.
createMode?: CreateMode
Property Value
enablePurgeProtection
Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. Enabling this functionality is irreversible.
enablePurgeProtection?: boolean
Property Value
boolean
enableSoftDelete
Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. Soft delete is enabled by default for all managed HSMs and is immutable.
enableSoftDelete?: boolean
Property Value
boolean
hsmUri
The URI of the managed hsm pool for performing operations on keys.
hsmUri?: string
Property Value
string
initialAdminObjectIds
Array of initial administrators object ids for this managed hsm pool.
initialAdminObjectIds?: string[]
Property Value
string[]
networkAcls
Rules governing the accessibility of the key vault from specific network locations.
networkAcls?: MhsmNetworkRuleSet
Property Value
privateEndpointConnections
List of private endpoint connections associated with the managed hsm pool.
privateEndpointConnections?: MhsmPrivateEndpointConnectionItem[]
Property Value
provisioningState
Provisioning state.
provisioningState?: string
Property Value
string
publicNetworkAccess
Control permission to the managed HSM from public networks.
publicNetworkAccess?: string
Property Value
string
regions
List of all regions associated with the managed hsm pool.
regions?: MhsmGeoReplicatedRegion[]
Property Value
scheduledPurgeDate
The scheduled purge date in UTC.
scheduledPurgeDate?: Date
Property Value
Date
securityDomainProperties
Managed HSM security domain properties.
securityDomainProperties?: ManagedHSMSecurityDomainProperties
Property Value
softDeleteRetentionInDays
Soft deleted data retention days. When you delete an HSM or a key, it will remain recoverable for the configured retention period or for a default period of 90 days. It accepts values between 7 and 90.
softDeleteRetentionInDays?: number
Property Value
number
statusMessage
Resource Status Message.
statusMessage?: string
Property Value
string
tenantId
The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.
tenantId?: string
Property Value
string