Files
Jeremy MengandGitHub 696aa6ae52 [EngSys] remove dev-tool run vendored from individual packages (#36198)
The primary reason that we added `dev-tool run vendored` command is to manage
dependencies centrally. Now we can achieve that with pnpm workspace/catalog
feature. This PR removes most of the `dev-tool run vendored` usages from
individual packages and replace them with direct tool calls. Those tools are
also added to individual package's dev dependencies per Pnpm recommendation.
2025-10-13 16:52:42 -07:00

18 KiB

@azure/arm-hardwaresecuritymodules client library samples for JavaScript

These sample programs show how to use the JavaScript client libraries for @azure/arm-hardwaresecuritymodules in some common scenarios.

File Name Description
cloudHsmClusterBackupStatusGetSample.js gets the backup operation status of the specified Cloud HSM Cluster x-ms-original-file: 2025-03-31/CloudHsmCluster_Backup_Pending_MaximumSet_Gen.json
cloudHsmClusterPrivateEndpointConnectionsCreateSample.js creates or updates the private endpoint connection for the Cloud Hsm Cluster. x-ms-original-file: 2025-03-31/CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen.json
cloudHsmClusterPrivateEndpointConnectionsDeleteSample.js deletes the private endpoint connection for the Cloud Hsm Cluster. x-ms-original-file: 2025-03-31/CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen.json
cloudHsmClusterPrivateEndpointConnectionsGetSample.js gets the private endpoint connection for the Cloud Hsm Cluster. x-ms-original-file: 2025-03-31/CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen.json
cloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterSample.js gets the private link resources supported for the Cloud Hsm Cluster. x-ms-original-file: 2025-03-31/CloudHsmClusterPrivateLinkResource_ListByCloudHsmCluster_MaximumSet_Gen.json
cloudHsmClusterRestoreStatusGetSample.js gets the restore operation status of the specified Cloud HSM Cluster x-ms-original-file: 2025-03-31/CloudHsmCluster_Restore_Pending_MaximumSet_Gen.json
cloudHsmClustersBackupSample.js create a backup of the Cloud HSM Cluster in the specified subscription x-ms-original-file: 2025-03-31/CloudHsmCluster_CreateOrValidate_Backup_MaximumSet_Gen.json
cloudHsmClustersCreateOrUpdateSample.js create or Update a Cloud HSM Cluster in the specified subscription. x-ms-original-file: 2025-03-31/CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen.json
cloudHsmClustersDeleteSample.js deletes the specified Cloud HSM Cluster x-ms-original-file: 2025-03-31/CloudHsmCluster_Delete_MaximumSet_Gen.json
cloudHsmClustersGetSample.js gets the specified Cloud HSM Cluster x-ms-original-file: 2025-03-31/CloudHsmCluster_Get_MaximumSet_Gen.json
cloudHsmClustersListByResourceGroupSample.js the List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group. x-ms-original-file: 2025-03-31/CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen.json
cloudHsmClustersListBySubscriptionSample.js the List operation gets information about the Cloud HSM Clusters associated with the subscription. x-ms-original-file: 2025-03-31/CloudHsmCluster_ListBySubscription_MaximumSet_Gen.json
cloudHsmClustersRestoreSample.js restores all key materials of a specified Cloud HSM Cluster x-ms-original-file: 2025-03-31/CloudHsmCluster_RequestOrValidate_Restore_MaximumSet_Gen.json
cloudHsmClustersUpdateSample.js update a Cloud HSM Cluster in the specified subscription. x-ms-original-file: 2025-03-31/CloudHsmCluster_Update_MaximumSet_Gen.json
cloudHsmClustersValidateBackupPropertiesSample.js pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription. x-ms-original-file: 2025-03-31/CloudHsmCluster_Create_Backup_MaximumSet_Gen_ValidateBackupProperties.json
cloudHsmClustersValidateRestorePropertiesSample.js queued validating pre restore operation x-ms-original-file: 2025-03-31/CloudHsmCluster_RequestOrValidate_Restore_MaximumSet_Gen_ValidateRestoreProperties.json
dedicatedHsmCreateOrUpdateSample.js create or Update a dedicated HSM in the specified subscription. x-ms-original-file: 2025-03-31/DedicatedHsm_CreateOrUpdate.json
dedicatedHsmDeleteSample.js deletes the specified Azure Dedicated HSM. x-ms-original-file: 2025-03-31/DedicatedHsm_Delete.json
dedicatedHsmGetSample.js gets the specified Azure dedicated HSM. x-ms-original-file: 2025-03-31/DedicatedHsm_Get.json
dedicatedHsmListByResourceGroupSample.js the List operation gets information about the dedicated HSMs associated with the subscription and within the specified resource group. x-ms-original-file: 2025-03-31/DedicatedHsm_ListByResourceGroup.json
dedicatedHsmListBySubscriptionSample.js the List operation gets information about the dedicated HSMs associated with the subscription. x-ms-original-file: 2025-03-31/DedicatedHsm_ListBySubscription.json
dedicatedHsmListOutboundNetworkDependenciesEndpointsSample.js gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. The operation returns properties of each egress endpoint. x-ms-original-file: 2025-03-31/GetOutboundNetworkDependenciesEndpointsList.json
dedicatedHsmUpdateSample.js update a dedicated HSM in the specified subscription. x-ms-original-file: 2025-03-31/DedicatedHsm_Update.json
operationsListSample.js list the operations for the provider x-ms-original-file: 2025-03-31/OperationsList.json
privateEndpointConnectionsListByCloudHsmClusterSample.js the List operation gets information about the private endpoint connections associated with the Cloud HSM Cluster x-ms-original-file: 2025-03-31/CloudHsmClusterPrivateEndpointConnection_ListByCloudHsmCluster_MaximumSet_Gen.json

Prerequisites

The sample programs are compatible with LTS versions of Node.js.

You need an Azure subscription to run these sample programs.

Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.

Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.

Setup

To run the samples using the published version of the package:

  1. Install the dependencies using npm:
npm install
  1. Edit the file sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file from sample.env to just .env. The sample programs will read this file automatically.

  2. Run whichever samples you like (note that some samples may require additional setup, see the table above):

node cloudHsmClusterBackupStatusGetSample.js

Alternatively, run a single sample with the correct environment variables set (setting up the .env file is not required if you do this), for example (cross-platform):

cross-env node cloudHsmClusterBackupStatusGetSample.js

Next Steps

Take a look at our API Documentation for more information about the APIs that are available in the clients.