Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ManagedHsmProperties

Package version

Properties of the managed HSM Pool

Hierarchy

  • ManagedHsmProperties

Index

Properties

Optional createMode

createMode: CreateMode

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

Optional enablePurgeProtection

enablePurgeProtection: undefined | false | true

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.

Optional enableSoftDelete

enableSoftDelete: undefined | false | true

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.

Optional hsmUri

hsmUri: undefined | string

The URI of the managed hsm pool for performing operations on keys. NOTE: This property will not be serialized. It can only be populated by the server.

Optional initialAdminObjectIds

initialAdminObjectIds: string[]

Array of initial administrators object ids for this managed hsm pool.

Optional networkAcls

networkAcls: MhsmNetworkRuleSet

Rules governing the accessibility of the key vault from specific network locations.

Optional privateEndpointConnections

privateEndpointConnections: MhsmPrivateEndpointConnectionItem[]

List of private endpoint connections associated with the managed hsm pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicNetworkAccess

publicNetworkAccess: PublicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

Optional scheduledPurgeDate

scheduledPurgeDate: Date

The scheduled purge date in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

Optional softDeleteRetentionInDays

softDeleteRetentionInDays: undefined | number

softDelete data retention days. It accepts >=7 and <=90.

Optional statusMessage

statusMessage: undefined | string

Resource Status Message. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string

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

Generated using TypeDoc