@azure/arm-hardwaresecuritymodules package

The API entity reference.

Optional parameters for the client.

Backup properties

Backup and Restore operation common properties

Backup and Restore Common properties

Backup operation Result

Properties of the Cloud HSM Cluster

Resource information with extended details.

Optional parameters.

Interface representing a CloudHsmClusterBackupStatus operations.

Patchable properties of the Cloud HSM Cluster

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a CloudHsmClusterPrivateEndpointConnections operations.

Optional parameters.

Interface representing a CloudHsmClusterPrivateLinkResources operations.

Properties of a Cloud HSM Cluster.

Optional parameters.

Interface representing a CloudHsmClusterRestoreStatus operations.

Cloud Hsm Cluster SKU information

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a CloudHsmClusters operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The Cloud HSM Properties

Resource information with extended details.

Optional parameters.

Optional parameters.

The error exception.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DedicatedHsm operations.

Patchable properties of the dedicated HSM

Properties of the dedicated hsm

Optional parameters.

A domain name that dedicated hsm services are reaching at.

Connect information from the dedicated hsm service to a single endpoint.

The resource management error additional info.

The error detail.

The key vault server error.

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Managed service identity (system assigned and/or user assigned identities)

The network interface definition.

The network profile definition.

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for and operation.

Optional parameters.

Interface representing a Operations operations.

Egress endpoints which dedicated hsm service connects to for common purpose.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

The private endpoint resource.

The private endpoint connection resource.

Properties of the private endpoint connection.

Optional parameters.

Interface representing a PrivateEndpointConnections operations.

A private link resource.

Properties of a private link resource.

A collection of information about the state of the connection between service consumer and provider.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Common fields that are returned in the response for all Azure Resource Manager resources

Cloud Hsm Cluster restore information

Restore operation properties

SKU of the dedicated HSM

Metadata pertaining to creation and last modification of the resource.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

User assigned identity properties

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

State of security domain activation
KnownActivationState can be used interchangeably with ActivationState, this enum contains the known values that the service supports.

Known values supported by the service

NotDefined
NotActivated
Active
Failed
Unknown

The Cloud HSM Cluster's auto-generated Domain Name Label Scope
KnownAutoGeneratedDomainNameLabelScope can be used interchangeably with AutoGeneratedDomainNameLabelScope, this enum contains the known values that the service supports.

Known values supported by the service

TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

Status of the backup/restore operation
KnownBackupRestoreOperationStatus can be used interchangeably with BackupRestoreOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Succeeded
Failed
Cancelled

Sku family of the Cloud HSM Cluster
KnownCloudHsmClusterSkuFamily can be used interchangeably with CloudHsmClusterSkuFamily, this enum contains the known values that the service supports.

Known values supported by the service

B

Sku name of the Cloud HSM Cluster

An interface that describes a page of results.

The kind of entity that created the resource.
<xref:KnowncreatedByType> can be used interchangeably with createdByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

Provisioning state.
KnownJsonWebKeyType can be used interchangeably with JsonWebKeyType, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The dedicated HSM has been fully provisioned.
Provisioning: The dedicated HSM is currently being provisioned.
Allocating: A device is currently being allocated for the dedicated HSM resource.
Connecting: The dedicated HSM is being connected to the virtual network.
Failed: Provisioning of the dedicated HSM has failed.
CheckingQuota: Validating the subscription has sufficient quota to allocate a dedicated HSM device.
Deleting: The dedicated HSM is currently being deleted.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed
Updating
InternalError
Canceled

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Connection waiting for approval or rejection
Approved: Connection approved
Rejected: Connection Rejected

The Cloud HSM Cluster's provisioningState
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Provisioning
Succeeded
Updating
Failed
Deleting
Canceled

The Cloud HSM Cluster public network access
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Disabled

SKU of the dedicated HSM
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

SafeNet Luna Network HSM A790: The dedicated HSM is a Safenet Luna Network HSM A790 device.
payShield10K_LMK1_CPS60: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 60 calls per second.
payShield10K_LMK1_CPS250: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 250 calls per second.
payShield10K_LMK1_CPS2500: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 2500 calls per second.
payShield10K_LMK2_CPS60: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 60 calls per second.
payShield10K_LMK2_CPS250: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 250 calls per second.
payShield10K_LMK2_CPS2500: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 2500 calls per second.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

State of security domain activation

The Cloud HSM Cluster's auto-generated Domain Name Label Scope

Status of the backup/restore operation

Sku family of the Cloud HSM Cluster

The kind of entity that created the resource.

Provisioning state.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

The current provisioning state.

The private endpoint connection status.

The Cloud HSM Cluster's provisioningState

The Cloud HSM Cluster public network access

SKU of the dedicated HSM

The available API versions.

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.