Package com.azure.resourcemanager.keyvault.models

Class ManagedHsmProperties

java.lang.Object
com.azure.resourcemanager.keyvault.models.ManagedHsmProperties
public final class ManagedHsmProperties extends Object
Properties of the managed HSM Pool.

  • Constructor Details

    • ManagedHsmProperties

      public ManagedHsmProperties()

  • Method Details

    • 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.

    • 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.

    • initialAdminObjectIds

      public List<String> initialAdminObjectIds()
      Get the initialAdminObjectIds property: Array of initial administrators object ids for this managed hsm pool.
      Returns:
      the initialAdminObjectIds value.

    • withInitialAdminObjectIds

      public ManagedHsmProperties withInitialAdminObjectIds(List<String> 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.

    • hsmUri

      public String hsmUri()
      Get the hsmUri property: The URI of the managed hsm pool for performing operations on keys.
      Returns:
      the hsmUri value.

    • enableSoftDelete

      public Boolean enableSoftDelete()
      Get the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. If it's not set to any value(true or false) when creating new managed HSM pool, it will be set to true by default. Once set to true, it cannot be reverted to false.
      Returns:
      the enableSoftDelete value.

    • 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. If it's not set to any value(true or false) when creating new managed HSM pool, it will be set to true by default. Once set to true, it cannot be reverted to false.
      Parameters:
      enableSoftDelete - the enableSoftDelete value to set.
      Returns:
      the ManagedHsmProperties object itself.

    • softDeleteRetentionInDays

      public Integer softDeleteRetentionInDays()
      Get the softDeleteRetentionInDays property: softDelete data retention days. It accepts >=7 and <=90.
      Returns:
      the softDeleteRetentionInDays value.

    • withSoftDeleteRetentionInDays

      public ManagedHsmProperties withSoftDeleteRetentionInDays(Integer softDeleteRetentionInDays)
      Set the softDeleteRetentionInDays property: softDelete data retention days. It accepts >=7 and <=90.
      Parameters:
      softDeleteRetentionInDays - the softDeleteRetentionInDays value to set.
      Returns:
      the ManagedHsmProperties object itself.

    • 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. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible.
      Returns:
      the enablePurgeProtection value.

    • 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. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible.
      Parameters:
      enablePurgeProtection - the enablePurgeProtection value to set.
      Returns:
      the ManagedHsmProperties object itself.

    • 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.

    • 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.

    • statusMessage

      public String statusMessage()
      Get the statusMessage property: Resource Status Message.
      Returns:
      the statusMessage value.

    • provisioningState

      public ProvisioningState provisioningState()
      Get the provisioningState property: Provisioning state.
      Returns:
      the provisioningState 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.

    • 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.

    • privateEndpointConnections

      public List<MhsmPrivateEndpointConnectionItem> privateEndpointConnections()
      Get the privateEndpointConnections property: List of private endpoint connections associated with the managed hsm pool.
      Returns:
      the privateEndpointConnections value.

    • publicNetworkAccess

      public PublicNetworkAccess publicNetworkAccess()
      Get the publicNetworkAccess property: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
      Returns:
      the publicNetworkAccess value.

    • withPublicNetworkAccess

      public ManagedHsmProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
      Set the publicNetworkAccess property: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
      Parameters:
      publicNetworkAccess - the publicNetworkAccess value to set.
      Returns:
      the ManagedHsmProperties object itself.

    • scheduledPurgeDate

      public OffsetDateTime scheduledPurgeDate()
      Get the scheduledPurgeDate property: The scheduled purge date in UTC.
      Returns:
      the scheduledPurgeDate value.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.