ManagedHsmProperties Class

Properties of the managed HSM Pool.

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

Inheritance

Model

ManagedHsmProperties

Constructor

ManagedHsmProperties(*, tenant_id: Optional[str] = None, initial_admin_object_ids: Optional[List[str]] = None, enable_soft_delete: Optional[bool] = True, soft_delete_retention_in_days: Optional[int] = 90, enable_purge_protection: Optional[bool] = True, create_mode: Optional[Union[str, azure.mgmt.keyvault.v2020_04_01_preview.models._key_vault_management_client_enums.CreateMode]] = None, **kwargs)

Variables

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

soft_delete_retention_in_days

int

softDelete data retention days. It accepts >=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. The setting is effective only if soft delete is also enabled. 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. Possible values include: "recover", "default".

status_message

str

Resource Status Message.

provisioning_state

str or ProvisioningState

Provisioning state. Possible values include: "Succeeded", "Provisioning", "Failed", "Updating", "Deleting", "Activated", "SecurityDomainRestore", "Restoring".