Package com.azure.resourcemanager.keyvault.models

Interface ManagedHsm

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<KeyVaultManager,ManagedHsmInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<ManagedHsmInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<KeyVaultManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<ManagedHsm>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection
public interface ManagedHsm extends com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<KeyVaultManager,ManagedHsmInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<ManagedHsm>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection
An immutable client-side representation of an Azure Managed Hardware Security Module.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource

    com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource.DefinitionStages

    Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    hsmUri()
    Gets the URI of the managed hsm pool for performing operations on keys.
    List<String>
    initialAdminObjectIds()
    When a managed HSM is created, the requestor also provides a list of data plane administrators (all security principals are supported).
    boolean
    isPurgeProtectionEnabled()
    Checks whether protection against purge is enabled for this managed HSM.
    boolean
    isSoftDeleteEnabled()
    Checks whether the 'soft delete' functionality is enabled for this managed HSM.
    Keys
    keys()
    Gets the Key Vault key API entry point.
    MhsmNetworkRuleSet
    networkRuleSet()
    Gets rules governing the accessibility of the key vault from specific network locations.
    PublicNetworkAccess
    publicNetworkAccess()
    Checks whether data plane traffic coming from public networks is allowed while private endpoint is enabled.
    OffsetDateTime
    scheduledPurgeDate()
    Gets the scheduled purge date in UTC.
    ManagedHsmSku
    sku()
    Gets managed HSM SKU.
    Integer
    softDeleteRetentionInDays()
    Gets softDelete data retention days.
    String
    tenantId()
    Gets the AAD tenant ID that should be used for authenticating requests to the managed HSM.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

    resourceGroupName

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

    refresh, refreshAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    region, regionName, tags, type

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource

    listPrivateLinkResources, listPrivateLinkResourcesAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection

    approvePrivateEndpointConnection, approvePrivateEndpointConnectionAsync, rejectPrivateEndpointConnection, rejectPrivateEndpointConnectionAsync

  • Method Details

    • tenantId

      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

    • sku

      ManagedHsmSku sku()
      Gets managed HSM SKU.
      Returns:
      Managed HSM SKU

    • initialAdminObjectIds

      List<String> 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

    • hsmUri

      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

    • isSoftDeleteEnabled

      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

    • softDeleteRetentionInDays

      Integer softDeleteRetentionInDays()
      Gets softDelete data retention days.
      Returns:
      softDelete data retention days. It accepts value between 7 and 90 (both included)

    • isPurgeProtectionEnabled

      boolean isPurgeProtectionEnabled()
      Checks whether protection against purge is enabled for this managed HSM.
      Returns:
      whether protection against purge is enabled for this managed HSM

    • networkRuleSet

      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

    • keys

      Keys keys()
      Gets the Key Vault key API entry point.
      Returns:
      the Key Vault key API entry point

    • scheduledPurgeDate

      OffsetDateTime scheduledPurgeDate()
      Gets the scheduled purge date in UTC.
      Returns:
      the scheduled purge date in UTC

    • publicNetworkAccess

      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