IManagedHsm Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.ManagedHsmTypeConverter))]
public interface IManagedHsm : Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.IManagedHsmResource
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.ManagedHsmTypeConverter))]
public interface IManagedHsm : Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.IProxyResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.ManagedHsmTypeConverter))>]
type IManagedHsm = interface
interface IJsonSerializable
interface IManagedHsmResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.ManagedHsmTypeConverter))>]
type IManagedHsm = interface
interface IJsonSerializable
interface IProxyResource
interface IResource
Public Interface IManagedHsm
Implements IManagedHsmResource
Public Interface IManagedHsm
Implements IProxyResource
- Derived
- Attributes
- Implements
Properties
| Name | Description |
|---|---|
| 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 |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" (Inherited from IResource) |
| IdentityPrincipalId |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
| IdentityTenantId |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
| IdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| IdentityUserAssignedIdentity |
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. |
| InitialAdminObjectId |
Array of initial administrators object ids for this managed hsm pool. |
| Location |
The geo-location where the resource lives |
| Name |
The name of the resource (Inherited from IResource) |
| 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. |
| NetworkAclsServiceTag |
The list of service tags. |
| 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. |
| 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 resource creation (UTC). (Inherited from IResource) |
| SystemDataCreatedBy |
The identity that created the resource. (Inherited from IResource) |
| SystemDataCreatedByType |
The type of identity that created the resource. (Inherited from IResource) |
| SystemDataLastModifiedAt |
The timestamp of resource last modification (UTC) (Inherited from IResource) |
| SystemDataLastModifiedBy |
The identity that last modified the resource. (Inherited from IResource) |
| SystemDataLastModifiedByType |
The type of identity that last modified the resource. (Inherited from IResource) |
| Tag |
Resource tags. |
| TenantId |
The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool. |
| Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource) |
Methods
| Name | Description |
|---|---|
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |