Skip to main content

managed_hsms

Overview

Namemanaged_hsms
TypeResource
Idazure.key_vault.managed_hsms

Fields

NameDatatypeDescription
idstringThe Azure Resource Manager resource ID for the managed HSM Pool.
namestringThe name of the managed HSM Pool.
identityobjectManaged service identity (system assigned and/or user assigned identities)
locationstringThe supported Azure location where the managed HSM Pool should be created.
propertiesobjectProperties of the managed HSM Pool
skuobjectSKU details
systemDataobjectMetadata pertaining to creation and last modification of the key vault resource.
tagsobjectResource tags
typestringThe resource type of the managed HSM Pool.

Methods

NameAccessible byRequired ParamsDescription
getSELECTname, resourceGroupName, subscriptionIdGets the specified managed HSM Pool.
list_by_resource_groupSELECTresourceGroupName, subscriptionIdThe List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.
list_by_subscriptionSELECTsubscriptionIdThe List operation gets information about the managed HSM Pools associated with the subscription.
create_or_updateINSERTname, resourceGroupName, subscriptionIdCreate or update a managed HSM Pool in the specified subscription.
deleteDELETEname, resourceGroupName, subscriptionIdDeletes the specified managed HSM Pool.
_list_by_resource_groupEXECresourceGroupName, subscriptionIdThe List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.
_list_by_subscriptionEXECsubscriptionIdThe List operation gets information about the managed HSM Pools associated with the subscription.
check_mhsm_name_availabilityEXECsubscriptionId, data__nameChecks that the managed hsm name is valid and is not already in use.
purge_deletedEXEClocation, name, subscriptionIdPermanently deletes the specified managed HSM.
updateEXECname, resourceGroupName, subscriptionIdUpdate a managed HSM Pool in the specified subscription.