ManagedHsmProperties interface

Package:

@azure/arm-keyvault

Properties of the managed HSM Pool

Properties

createMode	The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.
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.
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.
hsmUri	The URI of the managed hsm pool for performing operations on keys. NOTE: This property will not be serialized. It can only be populated by the server.
initialAdminObjectIds	Array of initial administrators object ids for this managed hsm pool.
networkAcls	Rules governing the accessibility of the key vault from specific network locations.
privateEndpointConnections	List of private endpoint connections associated with the managed hsm pool. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess	Control permission to the managed HSM from public networks.
regions	List of all regions associated with the managed hsm pool.
scheduledPurgeDate	The scheduled purge date in UTC. NOTE: This property will not be serialized. It can only be populated by the server.
securityDomainProperties	Managed HSM security domain properties. NOTE: This property will not be serialized. It can only be populated by the server.
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.
statusMessage	Resource Status Message. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId	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

CreateMode

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

MhsmNetworkRuleSet

privateEndpointConnections

List of private endpoint connections associated with the managed hsm pool. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: MhsmPrivateEndpointConnectionItem[]

Property Value

MhsmPrivateEndpointConnectionItem[]

provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

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

MhsmGeoReplicatedRegion[]

scheduledPurgeDate

The scheduled purge date in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

scheduledPurgeDate?: Date

Property Value

Date

securityDomainProperties

Managed HSM security domain properties. NOTE: This property will not be serialized. It can only be populated by the server.

securityDomainProperties?: ManagedHSMSecurityDomainProperties

Property Value

ManagedHSMSecurityDomainProperties

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. NOTE: This property will not be serialized. It can only be populated by the server.

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