Package version:

Interface ManagedHsmProperties

Properties of the managed HSM Pool

interface ManagedHsmProperties {
    createMode?: CreateMode;
    enablePurgeProtection?: boolean;
    enableSoftDelete?: boolean;
    hsmUri?: string;
    initialAdminObjectIds?: string[];
    networkAcls?: MhsmNetworkRuleSet;
    privateEndpointConnections?: MhsmPrivateEndpointConnectionItem[];
    provisioningState?: string;
    publicNetworkAccess?: string;
    regions?: MhsmGeoReplicatedRegion[];
    scheduledPurgeDate?: any;
    securityDomainProperties?: ManagedHSMSecurityDomainProperties;
    softDeleteRetentionInDays?: number;
    statusMessage?: string;
    tenantId?: string;
}

Properties

createMode? enablePurgeProtection? enableSoftDelete? hsmUri? initialAdminObjectIds? networkAcls? privateEndpointConnections? provisioningState? publicNetworkAccess? regions? scheduledPurgeDate? securityDomainProperties? softDeleteRetentionInDays? statusMessage? tenantId?

Properties

OptionalcreateMode

createMode?: CreateMode

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

OptionalenablePurgeProtection

enablePurgeProtection?: boolean

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.

OptionalenableSoftDelete

enableSoftDelete?: boolean

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.

Optional ReadonlyhsmUri

hsmUri?: 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.

OptionalinitialAdminObjectIds

initialAdminObjectIds?: string[]

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

OptionalnetworkAcls

networkAcls?: MhsmNetworkRuleSet

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

Optional ReadonlyprivateEndpointConnections

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 ReadonlyprovisioningState

provisioningState?: string

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

OptionalpublicNetworkAccess

publicNetworkAccess?: string

Control permission to the managed HSM from public networks.

Optionalregions

regions?: MhsmGeoReplicatedRegion[]

List of all regions associated with the managed hsm pool.

Optional ReadonlyscheduledPurgeDate

scheduledPurgeDate?: any

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

Optional ReadonlysecurityDomainProperties

securityDomainProperties?: ManagedHSMSecurityDomainProperties

Managed HSM security domain properties. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalsoftDeleteRetentionInDays

softDeleteRetentionInDays?: number

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.

Optional ReadonlystatusMessage

statusMessage?: string

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

OptionaltenantId

tenantId?: string

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

Settings

Member Visibility