Share via


ManagedHsmProperties Class

Definition

Properties of the managed HSM Pool.

public class ManagedHsmProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.KeyVault.Models.ManagedHsmProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.KeyVault.Models.ManagedHsmProperties>
public class ManagedHsmProperties
type ManagedHsmProperties = class
    interface IJsonModel<ManagedHsmProperties>
    interface IPersistableModel<ManagedHsmProperties>
type ManagedHsmProperties = class
Public Class ManagedHsmProperties
Implements IJsonModel(Of ManagedHsmProperties), IPersistableModel(Of ManagedHsmProperties)
Public Class ManagedHsmProperties
Inheritance
ManagedHsmProperties
Implements

Constructors

ManagedHsmProperties()

Initializes a new instance of ManagedHsmProperties.

Properties

CreateMode

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

EnablePurgeProtection

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.

EnableSoftDelete

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.

HsmUri

The URI of the managed hsm pool for performing operations on keys.

InitialAdminObjectIds

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

NetworkRuleSet

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

PrivateEndpointConnections

List of private endpoint connections associated with the managed hsm pool.

ProvisioningState

Provisioning state.

PublicNetworkAccess

Control permission to the managed HSM from public networks.

Regions

List of all regions associated with the managed hsm pool.

ScheduledPurgeOn

The scheduled purge date in UTC.

SecurityDomainProperties

Managed HSM security domain properties.

SoftDeleteRetentionInDays

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.

StatusMessage

Resource Status Message.

TenantId

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

Explicit Interface Implementations

IJsonModel<ManagedHsmProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ManagedHsmProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ManagedHsmProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ManagedHsmProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ManagedHsmProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to