ManagedHsm Interface

Package:

com.azure.resourcemanager.keyvault.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-keyvault:2.47.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() Gets the URI of the managed hsm pool for performing operations on keys.
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() Checks whether protection against purge is enabled for this managed HSM.
abstract boolean	isSoftDeleteEnabled() Checks whether the 'soft delete' functionality is enabled for this managed HSM.
abstract Keys	keys() Gets the Key Vault key API entry point.
abstract MhsmNetworkRuleSet	networkRuleSet() Gets rules governing the accessibility of the key vault from specific network locations.
abstract PublicNetworkAccess	publicNetworkAccess() Checks whether data plane traffic coming from public networks is allowed while private endpoint is enabled.
abstract OffsetDateTime	scheduledPurgeDate() Gets the scheduled purge date in UTC.
abstract ManagedHsmSku	sku() Gets managed HSM SKU.
abstract Integer	softDeleteRetentionInDays() Gets softDelete data retention days.
abstract String	tenantId() Gets the AAD tenant ID that should be used for authenticating requests to the managed HSM.

Method Details

hsmUri

public abstract String hsmUri()

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

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()

Checks whether protection against purge is enabled for this managed HSM.

Returns:

whether protection against purge is enabled for this managed HSM

isSoftDeleteEnabled

public abstract boolean isSoftDeleteEnabled()

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

Returns:

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

keys

public abstract Keys keys()

Gets the Key Vault key API entry point.

Returns:

the Key Vault key API entry point

networkRuleSet

public abstract MhsmNetworkRuleSet networkRuleSet()

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

Returns:

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

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

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

Returns:

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

scheduledPurgeDate

public abstract OffsetDateTime scheduledPurgeDate()

Gets the scheduled purge date in UTC.

Returns:

the scheduled purge date in UTC

sku

public abstract ManagedHsmSku sku()

Gets managed HSM SKU.

Returns:

Managed HSM SKU

softDeleteRetentionInDays

public abstract Integer softDeleteRetentionInDays()

Gets softDelete data retention days.

Returns:

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

tenantId

public abstract String tenantId()

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

Returns:

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