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. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible.
enableSoftDelete	Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. If it's not set to any value(true or false) when creating new managed HSM pool, it will be set to true by default. Once set to true, it cannot be reverted to false.
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 for data plane traffic coming from public networks while private endpoint is enabled.
scheduledPurgeDate	The scheduled purge date in UTC. NOTE: This property will not be serialized. It can only be populated by the server.
softDeleteRetentionInDays	softDelete data retention days. It accepts >=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. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible.

enablePurgeProtection?: undefined | false | true

Property Value

undefined | false | true

enableSoftDelete

Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. If it's not set to any value(true or false) when creating new managed HSM pool, it will be set to true by default. Once set to true, it cannot be reverted to false.

enableSoftDelete?: undefined | false | true

Property Value

undefined | false | true

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?: undefined | string

Property Value

undefined | 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?: ProvisioningState

Property Value

ProvisioningState

publicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

publicNetworkAccess?: PublicNetworkAccess

Property Value

PublicNetworkAccess

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

softDeleteRetentionInDays

softDelete data retention days. It accepts >=7 and <=90.

softDeleteRetentionInDays?: undefined | number

Property Value

undefined | number

statusMessage

Resource Status Message. NOTE: This property will not be serialized. It can only be populated by the server.

statusMessage?: undefined | string

Property Value

undefined | string

tenantId

The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.

tenantId?: undefined | string

Property Value

undefined | string