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, network_acls: _models.MHSMNetworkRuleSet | None = None, regions: List[_models.MHSMGeoReplicatedRegion] | None = None, public_network_access: str | _models.PublicNetworkAccess = 'Enabled', **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".
network_acls	MHSMNetworkRuleSet Rules governing the accessibility of the key vault from specific network locations.
regions	list[MHSMGeoReplicatedRegion] List of all regions associated with the managed hsm pool.
public_network_access	str or PublicNetworkAccess Control permission to the managed HSM from public networks. Known values are: "Enabled" and "Disabled". Default value: Enabled

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".
network_acls	MHSMNetworkRuleSet Rules governing the accessibility of the key vault from specific network locations.
regions	list[MHSMGeoReplicatedRegion] List of all regions associated with the managed hsm pool.
private_endpoint_connections	list[MHSMPrivateEndpointConnectionItem] List of private endpoint connections associated with the managed hsm pool.
public_network_access	str or PublicNetworkAccess Control permission to the managed HSM from public networks. Known values are: "Enabled" and "Disabled".
scheduled_purge_date	datetime The scheduled purge date in UTC.
security_domain_properties	ManagedHSMSecurityDomainProperties Managed HSM security domain properties.

Share via

ManagedHsmProperties Class

Constructor

Keyword-Only Parameters

Variables

Additional resources