Share via

ManagedHsm Interface

  • Reference
Package:
com.azure.resourcemanager.keyvault.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-keyvault:2.44.0

Implements

GroupableResource<KeyVaultManager,ManagedHsmInner> SupportsListingPrivateLinkResource SupportsUpdatingPrivateEndpointConnection Refreshable<ManagedHsm>

public interface ManagedHsm
extends GroupableResource<KeyVaultManager,ManagedHsmInner>, Refreshable<ManagedHsm>, SupportsListingPrivateLinkResource, SupportsUpdatingPrivateEndpointConnection

An immutable client-side representation of an Azure Managed Hardware Security Module.

Method Summary

Modifier and Type Method and Description
abstract String hsmUri()
abstract List<String> initialAdminObjectIds()

When a managed HSM is created, the requestor also provides a list of data plane administrators (all security principals are supported).
abstract boolean isPurgeProtectionEnabled()
abstract boolean isSoftDeleteEnabled()
abstract Keys keys()
abstract MhsmNetworkRuleSet networkRuleSet()
abstract PublicNetworkAccess publicNetworkAccess()
abstract OffsetDateTime scheduledPurgeDate()
abstract ManagedHsmSku sku()
abstract Integer softDeleteRetentionInDays()
abstract String tenantId()

Method Details

hsmUri

public abstract String hsmUri()

Returns:

the URI of the managed hsm pool for performing operations on keys

initialAdminObjectIds

public abstract List initialAdminObjectIds()

When a managed HSM is created, the requestor also provides a list of data plane administrators (all security principals are supported). Only these administrators are able to access the managed HSM data plane to perform key operations and manage data plane role assignments (Managed HSM local RBAC).

Returns:

initial administrators object ids for this managed hsm pool

isPurgeProtectionEnabled

public abstract boolean isPurgeProtectionEnabled()

Returns:

whether protection against purge is enabled for this managed HSM

isSoftDeleteEnabled

public abstract boolean isSoftDeleteEnabled()

Returns:

whether the 'soft delete' functionality is enabled for this managed HSM

keys

public abstract Keys keys()

Returns:

the Key Vault key API entry point

networkRuleSet

public abstract MhsmNetworkRuleSet networkRuleSet()

Returns:

rules governing the accessibility of the key vault from specific network locations

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Returns:

whether data plane traffic coming from public networks is allowed while private endpoint is enabled

scheduledPurgeDate

public abstract OffsetDateTime scheduledPurgeDate()

Returns:

the scheduled purge date in UTC

sku

public abstract ManagedHsmSku sku()

Returns:

Managed HSM SKU

softDeleteRetentionInDays

public abstract Integer softDeleteRetentionInDays()

Returns:

softDelete data retention days. It accepts value between 7 and 90 (both included)

tenantId

public abstract String tenantId()

Returns:

the AAD tenant ID that should be used for authenticating requests to the managed HSM

Applies to