Share via

ManagedHsmProperties Class

  • Reference

Properties of the managed HSM Pool.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.keyvault._serialization.Model
ManagedHsmProperties

Constructor

ManagedHsmProperties(*, tenant_id: str | None = None, initial_admin_object_ids: List[str] | None = None, enable_soft_delete: bool = True, soft_delete_retention_in_days: int = 90, enable_purge_protection: bool = True, create_mode: str | _models.CreateMode | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tenant_id
str

The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.
initial_admin_object_ids
list[str]

Array of initial administrators object ids for this managed hsm pool.
enable_soft_delete
bool

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.

Default value: True
soft_delete_retention_in_days
int

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.

Default value: 90
enable_purge_protection
bool

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.

Default value: True
create_mode
str or CreateMode

The create mode to indicate whether the resource is being created or is being recovered from a deleted resource. Known values are: "recover" and "default".

Variables

Name Description
tenant_id
str

The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.
initial_admin_object_ids
list[str]

Array of initial administrators object ids for this managed hsm pool.
hsm_uri
str

The URI of the managed hsm pool for performing operations on keys.
enable_soft_delete
bool

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.
soft_delete_retention_in_days
int

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.
enable_purge_protection
bool

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.
create_mode
str or CreateMode

The create mode to indicate whether the resource is being created or is being recovered from a deleted resource. Known values are: "recover" and "default".
status_message
str

Resource Status Message.
provisioning_state
str or ProvisioningState

Provisioning state. Known values are: "Succeeded", "Provisioning", "Failed", "Updating", "Deleting", "Activated", "SecurityDomainRestore", and "Restoring".