Share via


ManagedHsm Class

Definition

Resource information with extended details.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.ManagedHsmTypeConverter))]
public class ManagedHsm : Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.IManagedHsm, Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.ManagedHsmTypeConverter))>]
type ManagedHsm = class
    interface IManagedHsm
    interface IJsonSerializable
    interface IManagedHsmResource
    interface IValidates
Public Class ManagedHsm
Implements IManagedHsm, IValidates
Inheritance
ManagedHsm
Attributes
Implements

Constructors

ManagedHsm()

Creates an new ManagedHsm 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.

Id

The Azure Resource Manager resource ID for the managed HSM Pool.

InitialAdminObjectId

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

Location

The supported Azure location where the managed HSM Pool should be created.

Name

The name of the 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.

ResourceGroupName

Gets the resource group name

ScheduledPurgeDate

The scheduled purge date in UTC.

SecurityDomainPropertyActivationStatus

Activation Status

SecurityDomainPropertyActivationStatusMessage

Activation Status Message.

SkuFamily

SKU Family of the managed HSM Pool

SkuName

SKU of the managed HSM Pool

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.

SystemDataCreatedAt

The timestamp of the key vault resource creation (UTC).

SystemDataCreatedBy

The identity that created the key vault resource.

SystemDataCreatedByType

The type of identity that created the key vault resource.

SystemDataLastModifiedAt

The timestamp of the key vault resource last modification (UTC).

SystemDataLastModifiedBy

The identity that last modified the key vault resource.

SystemDataLastModifiedByType

The type of identity that last modified the key vault resource.

Tag

Resource tags

TenantId

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

Type

The resource type of the managed HSM Pool.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ManagedHsm.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ManagedHsm.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of ManagedHsm into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to