This pull request updates the Node.js version requirement across multiple files and tools in the repository. The changes ensure compatibility with Node.js version 22 and its corresponding type definitions. Resolves #37945. ***NO_CI***
client library samples for JavaScript (Beta)
These sample programs show how to use the JavaScript client libraries for in some common scenarios.
| File Name | Description |
|---|---|
| azureLargeInstanceGetSample.js | Gets an Azure Large Instance for the specified subscription, resource group, and instance name. x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeInstance_Get.json |
| azureLargeInstanceListByResourceGroupSample.js | Gets a list of Azure Large Instances in the specified subscription and resource group. The operations returns various properties of each Azure Large Instance. x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeInstance_ListByResourceGroup.json |
| azureLargeInstanceListBySubscriptionSample.js | Gets a list of Azure Large Instances in the specified subscription. The operations returns various properties of each Azure Large Instance. x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeInstance_ListBySubscription.json |
| azureLargeInstanceRestartSample.js | The operation to restart an Azure Large Instance (only for compute instances) x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeInstance_Restart.json |
| azureLargeInstanceShutdownSample.js | The operation to shutdown an Azure Large Instance (only for compute instances) x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeInstance_Shutdown.json |
| azureLargeInstanceStartSample.js | The operation to start an Azure Large Instance (only for compute instances) x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeInstance_Start.json |
| azureLargeInstanceUpdateSample.js | Patches the Tags field of an Azure Large Instance for the specified subscription, resource group, and instance name. x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeInstance_PatchTags_Delete.json |
| azureLargeStorageInstanceGetSample.js | Gets an Azure Large Storage instance for the specified subscription, resource group, and instance name. x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeStorageInstance_Get.json |
| azureLargeStorageInstanceListByResourceGroupSample.js | Gets a list of AzureLargeStorageInstances in the specified subscription and resource group. The operations returns various properties of each Azure LargeStorage instance. x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeStorageInstance_ListByResourceGroup.json |
| azureLargeStorageInstanceListBySubscriptionSample.js | Gets a list of AzureLargeStorageInstances in the specified subscription. The operations returns various properties of each Azure LargeStorage instance. x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeStorageInstance_ListBySubscription.json |
| azureLargeStorageInstanceUpdateSample.js | Patches the Tags field of a Azure Large Storage Instance for the specified subscription, resource group, and instance name. x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeStorageInstance_PatchTags_Delete.json |
| operationsListSample.js | List the operations for the provider x-ms-original-file: specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/examples/AzureLargeInstanceOperations_List.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:
- Install the dependencies using
npm:
npm install
-
Edit the file
sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file fromsample.envto just.env. The sample programs will read this file automatically. -
Run whichever samples you like (note that some samples may require additional setup, see the table above):
node azureLargeInstanceGetSample.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 LARGEINSTANCE_SUBSCRIPTION_ID="<largeinstance subscription id>" LARGEINSTANCE_RESOURCE_GROUP="<largeinstance resource group>" node azureLargeInstanceGetSample.js
Next Steps
Take a look at our API Documentation for more information about the APIs that are available in the clients.