@azure/arm-hardwaresecuritymodules package

The API entity reference.

Optional parameters.

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.

Interface representing a CloudHsmClusterBackupStatus.

Defines headers for CloudHsmClusterBackupStatus_get operation.

Defines headers for CloudHsmClusterBackupStatus_get operation.

Optional parameters.

List of Cloud HSM Clusters

Patchable properties of the Cloud HSM Cluster

Interface representing a CloudHsmClusterPrivateEndpointConnections.

Optional parameters.

Defines headers for CloudHsmClusterPrivateEndpointConnections_delete operation.

Optional parameters.

Optional parameters.

Interface representing a CloudHsmClusterPrivateLinkResources.

Optional parameters.

Optional parameters.

Cloud HSM Cluster Resource

Interface representing a CloudHsmClusterRestoreStatus.

Defines headers for CloudHsmClusterRestoreStatus_get operation.

Defines headers for CloudHsmClusterRestoreStatus_get operation.

Optional parameters.

Cloud Hsm Cluster SKU information

Interface representing a CloudHsmClusters.

Defines headers for CloudHsmClusters_backup operation.

Optional parameters.

Optional parameters.

Defines headers for CloudHsmClusters_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for CloudHsmClusters_restore operation.

Optional parameters.

Defines headers for CloudHsmClusters_update operation.

Optional parameters.

Defines headers for CloudHsmClusters_validateBackupProperties operation.

Optional parameters.

Defines headers for CloudHsmClusters_validateRestoreProperties operation.

Optional parameters.

The Cloud HSM Properties

Resource information with extended details.

Optional parameters.

Defines headers for DedicatedHsm_delete operation.

Optional parameters.

The error exception.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

List of dedicated HSMs

Interface representing a DedicatedHsmOperations.

Patchable properties of the dedicated HSM

Defines headers for DedicatedHsm_update operation.

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. (This also follows the OData error response format.).

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 this particular operation.

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Interface representing a Operations.

Optional parameters.

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

Collection of OutboundEnvironmentEndpoint

The private endpoint resource.

The private endpoint connection resource.

List of private endpoint connections associated with the specified resource.

Interface representing a PrivateEndpointConnections.

Optional parameters.

Optional parameters.

A private link resource.

A list of private link resources.

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

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

Defines values for ActivationState.
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

Defines values for AutoGeneratedDomainNameLabelScope.
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

Defines values for BackupRestoreOperationStatus.
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

Contains response data for the get operation.

Contains response data for the create operation.

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByCloudHsmClusterNext operation.

Contains response data for the listByCloudHsmCluster operation.

Contains response data for the get operation.

Defines values for CloudHsmClusterSkuFamily.
KnownCloudHsmClusterSkuFamily can be used interchangeably with CloudHsmClusterSkuFamily, this enum contains the known values that the service supports.

Known values supported by the service

B

Defines values for CloudHsmClusterSkuName.

Contains response data for the backup operation.

Contains response data for the createOrUpdate operation.

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the restore operation.

Contains response data for the update operation.

Contains response data for the validateBackupProperties operation.

Contains response data for the validateRestoreProperties operation.

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Contains response data for the createOrUpdate operation.

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation.

Contains response data for the listOutboundNetworkDependenciesEndpoints operation.

Contains response data for the update operation.

Defines values for IdentityType.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for JsonWebKeyType.
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.

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Contains response data for the list operation.

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

Defines values for PrivateEndpointConnectionProvisioningState.
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

Contains response data for the listByCloudHsmClusterNext operation.

Contains response data for the listByCloudHsmCluster operation.

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

Defines values for 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
Failed
Deleting
Canceled

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Disabled

Defines values for SkuName.
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.

Known values of ActionType that the service accepts.

Known values of ActivationState that the service accepts.

Known values of AutoGeneratedDomainNameLabelScope that the service accepts.

Known values of BackupRestoreOperationStatus that the service accepts.

Known values of CloudHsmClusterSkuFamily that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of IdentityType that the service accepts.

Known values of JsonWebKeyType that the service accepts.

Known values of ManagedServiceIdentityType that the service accepts.

Known values of Origin that the service accepts.

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

Known values of ProvisioningState that the service accepts.

Known values of PublicNetworkAccess that the service accepts.

Known values of SkuName that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.