Share via

ManagedHsmProperties Class

  • Reference
Package:
com.azure.resourcemanager.keyvault.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-keyvault:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.keyvault.models.ManagedHsmProperties

Implements

JsonSerializable<ManagedHsmProperties>

public final class ManagedHsmProperties
implements JsonSerializable<ManagedHsmProperties>

Properties of the managed HSM Pool.

Constructor Summary

Constructor Description
ManagedHsmProperties()

Creates an instance of ManagedHsmProperties class.

Method Summary

Modifier and Type Method and Description
CreateMode createMode()

Get the createMode property: The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.
Boolean enablePurgeProtection()

Get the enablePurgeProtection property: Property specifying whether protection against purge is enabled for this managed HSM pool.
Boolean enableSoftDelete()

Get the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool.
static ManagedHsmProperties fromJson(JsonReader jsonReader)

Reads an instance of ManagedHsmProperties from the JsonReader.
String hsmUri()

Get the hsmUri property: The URI of the managed hsm pool for performing operations on keys.
List<String> initialAdminObjectIds()

Get the initialAdminObjectIds property: Array of initial administrators object ids for this managed hsm pool.
MhsmNetworkRuleSet networkAcls()

Get the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.
List<MhsmPrivateEndpointConnectionItem> privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connections associated with the managed hsm pool.
ProvisioningState provisioningState()

Get the provisioningState property: Provisioning state.
PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: Control permission to the managed HSM from public networks.
List<MhsmGeoReplicatedRegionInner> regions()

Get the regions property: List of all regions associated with the managed hsm pool.
OffsetDateTime scheduledPurgeDate()

Get the scheduledPurgeDate property: The scheduled purge date in UTC.
ManagedHsmSecurityDomainProperties securityDomainProperties()

Get the securityDomainProperties property: Managed HSM security domain properties.
Integer softDeleteRetentionInDays()

Get the softDeleteRetentionInDays property: Soft deleted data retention days.
String statusMessage()

Get the statusMessage property: Resource Status Message.
UUID tenantId()

Get the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
ManagedHsmProperties withCreateMode(CreateMode createMode)

Set the createMode property: The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.
ManagedHsmProperties withEnablePurgeProtection(Boolean enablePurgeProtection)

Set the enablePurgeProtection property: Property specifying whether protection against purge is enabled for this managed HSM pool.
ManagedHsmProperties withEnableSoftDelete(Boolean enableSoftDelete)

Set the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool.
ManagedHsmProperties withInitialAdminObjectIds(List<String> initialAdminObjectIds)

Set the initialAdminObjectIds property: Array of initial administrators object ids for this managed hsm pool.
ManagedHsmProperties withNetworkAcls(MhsmNetworkRuleSet networkAcls)

Set the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.
ManagedHsmProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: Control permission to the managed HSM from public networks.
ManagedHsmProperties withRegions(List<MhsmGeoReplicatedRegionInner> regions)

Set the regions property: List of all regions associated with the managed hsm pool.
ManagedHsmProperties withSoftDeleteRetentionInDays(Integer softDeleteRetentionInDays)

Set the softDeleteRetentionInDays property: Soft deleted data retention days.
ManagedHsmProperties withTenantId(UUID tenantId)

Set the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ManagedHsmProperties

public ManagedHsmProperties()

Creates an instance of ManagedHsmProperties class.

Method Details

createMode

public CreateMode createMode()

Get the createMode property: The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.

Returns:

the createMode value.

enablePurgeProtection

public Boolean enablePurgeProtection()

Get the enablePurgeProtection property: 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.

Returns:

the enablePurgeProtection value.

enableSoftDelete

public Boolean enableSoftDelete()

Get the enableSoftDelete property: 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.

Returns:

the enableSoftDelete value.

fromJson

public static ManagedHsmProperties fromJson(JsonReader jsonReader)

Reads an instance of ManagedHsmProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ManagedHsmProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the ManagedHsmProperties.

hsmUri

public String hsmUri()

Get the hsmUri property: The URI of the managed hsm pool for performing operations on keys.

Returns:

the hsmUri value.

initialAdminObjectIds

public List initialAdminObjectIds()

Get the initialAdminObjectIds property: Array of initial administrators object ids for this managed hsm pool.

Returns:

the initialAdminObjectIds value.

networkAcls

public MhsmNetworkRuleSet networkAcls()

Get the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.

Returns:

the networkAcls value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connections associated with the managed hsm pool.

Returns:

the privateEndpointConnections value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: Provisioning state.

Returns:

the provisioningState value.

publicNetworkAccess

public PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: Control permission to the managed HSM from public networks.

Returns:

the publicNetworkAccess value.

regions

public List regions()

Get the regions property: List of all regions associated with the managed hsm pool.

Returns:

the regions value.

scheduledPurgeDate

public OffsetDateTime scheduledPurgeDate()

Get the scheduledPurgeDate property: The scheduled purge date in UTC.

Returns:

the scheduledPurgeDate value.

securityDomainProperties

public ManagedHsmSecurityDomainProperties securityDomainProperties()

Get the securityDomainProperties property: Managed HSM security domain properties.

Returns:

the securityDomainProperties value.

softDeleteRetentionInDays

public Integer softDeleteRetentionInDays()

Get the softDeleteRetentionInDays property: 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.

Returns:

the softDeleteRetentionInDays value.

statusMessage

public String statusMessage()

Get the statusMessage property: Resource Status Message.

Returns:

the statusMessage value.

tenantId

public UUID tenantId()

Get the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.

Returns:

the tenantId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withCreateMode

public ManagedHsmProperties withCreateMode(CreateMode createMode)

Set the createMode property: The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.

Parameters:

createMode - the createMode value to set.

Returns:

the ManagedHsmProperties object itself.

withEnablePurgeProtection

public ManagedHsmProperties withEnablePurgeProtection(Boolean enablePurgeProtection)

Set the enablePurgeProtection property: 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.

Parameters:

enablePurgeProtection - the enablePurgeProtection value to set.

Returns:

the ManagedHsmProperties object itself.

withEnableSoftDelete

public ManagedHsmProperties withEnableSoftDelete(Boolean enableSoftDelete)

Set the enableSoftDelete property: 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.

Parameters:

enableSoftDelete - the enableSoftDelete value to set.

Returns:

the ManagedHsmProperties object itself.

withInitialAdminObjectIds

public ManagedHsmProperties withInitialAdminObjectIds(List initialAdminObjectIds)

Set the initialAdminObjectIds property: Array of initial administrators object ids for this managed hsm pool.

Parameters:

initialAdminObjectIds - the initialAdminObjectIds value to set.

Returns:

the ManagedHsmProperties object itself.

withNetworkAcls

public ManagedHsmProperties withNetworkAcls(MhsmNetworkRuleSet networkAcls)

Set the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.

Parameters:

networkAcls - the networkAcls value to set.

Returns:

the ManagedHsmProperties object itself.

withPublicNetworkAccess

public ManagedHsmProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: Control permission to the managed HSM from public networks.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the ManagedHsmProperties object itself.

withRegions

public ManagedHsmProperties withRegions(List regions)

Set the regions property: List of all regions associated with the managed hsm pool.

Parameters:

regions - the regions value to set.

Returns:

the ManagedHsmProperties object itself.

withSoftDeleteRetentionInDays

public ManagedHsmProperties withSoftDeleteRetentionInDays(Integer softDeleteRetentionInDays)

Set the softDeleteRetentionInDays property: 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.

Parameters:

softDeleteRetentionInDays - the softDeleteRetentionInDays value to set.

Returns:

the ManagedHsmProperties object itself.

withTenantId

public ManagedHsmProperties withTenantId(UUID tenantId)

Set the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.

Parameters:

tenantId - the tenantId value to set.

Returns:

the ManagedHsmProperties object itself.

Applies to