Share via


ManagedHsmProperties Class

Definition

Properties of the managed HSM Pool

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.ManagedHsmPropertiesTypeConverter))]
public class ManagedHsmProperties : Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.IManagedHsmProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.ManagedHsmPropertiesTypeConverter))>]
type ManagedHsmProperties = class
    interface IManagedHsmProperties
    interface IJsonSerializable
Public Class ManagedHsmProperties
Implements IManagedHsmProperties
Inheritance
ManagedHsmProperties
Attributes
Implements

Constructors

ManagedHsmProperties()

Creates an new ManagedHsmProperties instance.

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.

InitialAdminObjectId

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

NetworkAclsBypass

Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.

NetworkAclsDefaultAction

The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.

NetworkAclsIPRule

The list of IP address rules.

NetworkAclsVirtualNetworkRule

The list of virtual network rules.

PrivateEndpointConnection

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

ProvisioningState

Provisioning state.

PublicNetworkAccess

Control permission to the managed HSM from public networks.

Region

List of all regions associated with the managed hsm pool.

ScheduledPurgeDate

The scheduled purge date in UTC.

SecurityDomainPropertyActivationStatus

Activation Status

SecurityDomainPropertyActivationStatusMessage

Activation Status Message.

SoftDeleteRetentionInDay

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.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ManagedHsmProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ManagedHsmProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.IManagedHsmProperties.

FromJsonString(String)

Creates a new instance of ManagedHsmProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of ManagedHsmProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to