@azure/arm-hardwaresecuritymodules package

Classes

Interfaces

ApiEntityReference	The API entity reference.
AzureDedicatedHSMResourceProviderOptionalParams	Optional parameters for the client.
BackupRequestProperties	Backup properties
BackupRestoreBaseResultProperties	Backup and Restore operation common properties
BackupRestoreRequestBaseProperties	Backup and Restore Common properties
BackupResult	Backup operation Result
BackupResultProperties	Properties of the Cloud HSM Cluster
CloudHsmCluster	Resource information with extended details.
CloudHsmClusterBackupStatusGetOptionalParams	Optional parameters.
CloudHsmClusterBackupStatusOperations	Interface representing a CloudHsmClusterBackupStatus operations.
CloudHsmClusterPatchParameters	Patchable properties of the Cloud HSM Cluster
CloudHsmClusterPrivateEndpointConnectionsCreateOptionalParams	Optional parameters.
CloudHsmClusterPrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
CloudHsmClusterPrivateEndpointConnectionsGetOptionalParams	Optional parameters.
CloudHsmClusterPrivateEndpointConnectionsOperations	Interface representing a CloudHsmClusterPrivateEndpointConnections operations.
CloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterOptionalParams	Optional parameters.
CloudHsmClusterPrivateLinkResourcesOperations	Interface representing a CloudHsmClusterPrivateLinkResources operations.
CloudHsmClusterProperties	Properties of a Cloud HSM Cluster.
CloudHsmClusterRestoreStatusGetOptionalParams	Optional parameters.
CloudHsmClusterRestoreStatusOperations	Interface representing a CloudHsmClusterRestoreStatus operations.
CloudHsmClusterSku	Cloud Hsm Cluster SKU information
CloudHsmClustersBackupOptionalParams	Optional parameters.
CloudHsmClustersCreateOrUpdateOptionalParams	Optional parameters.
CloudHsmClustersDeleteOptionalParams	Optional parameters.
CloudHsmClustersGetOptionalParams	Optional parameters.
CloudHsmClustersListByResourceGroupOptionalParams	Optional parameters.
CloudHsmClustersListBySubscriptionOptionalParams	Optional parameters.
CloudHsmClustersOperations	Interface representing a CloudHsmClusters operations.
CloudHsmClustersRestoreOptionalParams	Optional parameters.
CloudHsmClustersUpdateOptionalParams	Optional parameters.
CloudHsmClustersValidateBackupPropertiesOptionalParams	Optional parameters.
CloudHsmClustersValidateRestorePropertiesOptionalParams	Optional parameters.
CloudHsmProperties	The Cloud HSM Properties
DedicatedHsm	Resource information with extended details.
DedicatedHsmCreateOrUpdateOptionalParams	Optional parameters.
DedicatedHsmDeleteOptionalParams	Optional parameters.
DedicatedHsmError	The error exception.
DedicatedHsmGetOptionalParams	Optional parameters.
DedicatedHsmListByResourceGroupOptionalParams	Optional parameters.
DedicatedHsmListBySubscriptionOptionalParams	Optional parameters.
DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams	Optional parameters.
DedicatedHsmOperations	Interface representing a DedicatedHsm operations.
DedicatedHsmPatchParameters	Patchable properties of the dedicated HSM
DedicatedHsmProperties	Properties of the dedicated hsm
DedicatedHsmUpdateOptionalParams	Optional parameters.
EndpointDependency	A domain name that dedicated hsm services are reaching at.
EndpointDetail	Connect information from the dedicated hsm service to a single endpoint.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorModel	The key vault server error.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
NetworkInterface	The network interface definition.
NetworkProfile	The network profile definition.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OutboundEnvironmentEndpoint	Egress endpoints which dedicated hsm service connects to for common purpose.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PaymentHsmCluster	Resource information with extended details.
PaymentHsmClusterPatchParameters	Patchable properties of the Payment HSM Cluster
PaymentHsmClusterPrivateEndpointConnection	The private endpoint connection resource.
PaymentHsmClusterPrivateEndpointConnectionsCreateOptionalParams	Optional parameters.
PaymentHsmClusterPrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PaymentHsmClusterPrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PaymentHsmClusterPrivateEndpointConnectionsListByPaymentHsmClusterOptionalParams	Optional parameters.
PaymentHsmClusterPrivateEndpointConnectionsOperations	Interface representing a PaymentHsmClusterPrivateEndpointConnections operations.
PaymentHsmClusterPrivateLinkResourcesListByPaymentHsmClusterOptionalParams	Optional parameters.
PaymentHsmClusterPrivateLinkResourcesOperations	Interface representing a PaymentHsmClusterPrivateLinkResources operations.
PaymentHsmClusterProperties	Properties of a Payment HSM Cluster.
PaymentHsmClusterSku	Payment Hsm Cluster SKU information
PaymentHsmClustersCreateOrUpdateOptionalParams	Optional parameters.
PaymentHsmClustersDeleteOptionalParams	Optional parameters.
PaymentHsmClustersGetOptionalParams	Optional parameters.
PaymentHsmClustersListByResourceGroupOptionalParams	Optional parameters.
PaymentHsmClustersListBySubscriptionOptionalParams	Optional parameters.
PaymentHsmClustersOperations	Interface representing a PaymentHsmClusters operations.
PaymentHsmClustersUpdateOptionalParams	Optional parameters.
PaymentHsmProperties	The Payment HSM Properties
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	A private link resource.
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
RestoreRequestProperties	Cloud Hsm Cluster restore information
RestoreResult	Restore operation properties
Sku	SKU of the dedicated HSM
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties

Type Aliases

ActionType	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.
ActivationState	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
AutoGeneratedDomainNameLabelScope	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
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BackupRestoreOperationStatus	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
CloudHsmClusterSkuFamily	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
CloudHsmClusterSkuName	Sku name of the Cloud HSM Cluster KnownCloudHsmClusterSkuName can be used interchangeably with CloudHsmClusterSkuName, this enum contains the known values that the service supports. Known values supported by the service Standard_B1: Standard_B1 SKU Standard B10: Standard B10 SKU Standard_B1v2: Standard_B1v2 SKU Standard_B5v2: Standard_B5v2 SKU Standard_B10v2: Standard_B10v2 SKU Standard_B15v2: Standard_B15v2 SKU Standard_B20v2: Standard_B20v2 SKU
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. 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.
HsmState	The state of an HSM resource. KnownHsmState can be used interchangeably with HsmState, this enum contains the known values that the service supports. Known values supported by the service Unknown: The HSM state is unknown. Deploying: The HSM is being deployed. ConfiguringSlb: The HSM's software load balancer (SLB) is being configured. Starting: The HSM is starting. Started: The HSM has started and is running. Failed: The HSM has failed. Relocating: The HSM is being relocated. Deleting: The HSM is being deleted. DeletingSlbEntry: The HSM's software load balancer (SLB) entry is being deleted. InitialProvisioning: The HSM is being provisioned for the first time. Updating: The HSM is being updated. Degraded: The HSM is running in a degraded state. DelayedDeletion: The HSM deletion has been delayed.
JsonWebKeyType	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.
ManagedServiceIdentityType	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.
Origin	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.
PaymentHsmClusterSkuFamily	Sku family of the Payment HSM Cluster KnownPaymentHsmClusterSkuFamily can be used interchangeably with PaymentHsmClusterSkuFamily, this enum contains the known values that the service supports. Known values supported by the service B: B family SKU
PaymentHsmClusterSkuName	Sku name of the Payment HSM Cluster KnownPaymentHsmClusterSkuName can be used interchangeably with PaymentHsmClusterSkuName, this enum contains the known values that the service supports. Known values supported by the service Payments_v2: Payments_v2 SKU
PrivateEndpointConnectionProvisioningState	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
PrivateEndpointServiceConnectionStatus	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
ProvisioningState	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
PublicNetworkAccess	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
SkuName	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.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActivationState	State of security domain activation
KnownAutoGeneratedDomainNameLabelScope	The Cloud HSM Cluster's auto-generated Domain Name Label Scope
KnownBackupRestoreOperationStatus	Status of the backup/restore operation
KnownCloudHsmClusterSkuFamily	Sku family of the Cloud HSM Cluster
KnownCloudHsmClusterSkuName	Sku name of the Cloud HSM Cluster
KnownCreatedByType	The kind of entity that created the resource.
KnownHsmState	The state of an HSM resource.
KnownJsonWebKeyType	Provisioning state.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPaymentHsmClusterSkuFamily	Sku family of the Payment HSM Cluster
KnownPaymentHsmClusterSkuName	Sku name of the Payment HSM Cluster
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownProvisioningState	The Cloud HSM Cluster's provisioningState
KnownPublicNetworkAccess	The Cloud HSM Cluster public network access
KnownSkuName	SKU of the dedicated HSM
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AzureDedicatedHSMResourceProvider, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	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.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(AzureDedicatedHSMResourceProvider, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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.

function restorePoller<TResponse, TResult>(client: AzureDedicatedHSMResourceProvider, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: AzureDedicatedHSMResourceProvider

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-hardwaresecuritymodules package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(AzureDedicatedHSMResourceProvider, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback