Files
Minh-Anh PhanandGitHub 3181ad2806 [EngSys] Bump min-version to node 22 (#38887) ***NO_CI***
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***
2026-06-23 16:25:55 -07:00
..
2022-11-23 14:52:56 +08:00

client library samples for JavaScript

These sample programs show how to use the JavaScript client libraries for in some common scenarios.

File Name Description
containerHostMappingsGetContainerHostMappingSample.js Returns container host mapping object for a container host resource ID if an associated controller exists. x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ContainerHostMappingsGetContainerHostMapping_example.json
controllersCreateSample.js Creates an Azure Dev Spaces Controller with the specified create parameters. x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersCreate_example.json
controllersDeleteSample.js Deletes an existing Azure Dev Spaces Controller. x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersDelete_example.json
controllersGetSample.js Gets the properties for an Azure Dev Spaces Controller. x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersGet_example.json
controllersListByResourceGroupSample.js Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription. x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersListByResourceGroup_example.json
controllersListConnectionDetailsSample.js Lists connection details for the underlying container resources of an Azure Dev Spaces Controller. x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersListConnectionDetails_example.json
controllersListSample.js Lists all the Azure Dev Spaces Controllers with their properties in the subscription. x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersList_example.json
controllersUpdateSample.js Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters. x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersUpdate_example.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 containerHostMappingsGetContainerHostMappingSample.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 containerHostMappingsGetContainerHostMappingSample.js

Next Steps

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