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

21 KiB

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
azureDevOpsConnectorCreateOrUpdateSample.js Creates or updates an Azure DevOps Connector. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorCreateOrUpdate.json
azureDevOpsConnectorDeleteSample.js Delete monitored AzureDevOps Connector details. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorDelete.json
azureDevOpsConnectorGetSample.js Returns a monitored AzureDevOps Connector resource for a given ID. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorGet.json
azureDevOpsConnectorListByResourceGroupSample.js x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListByResourceGroup.json
azureDevOpsConnectorListBySubscriptionSample.js Returns a list of monitored AzureDevOps Connectors. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListBySubscription.json
azureDevOpsConnectorStatsGetSample.js Returns the summary of the AzureDevOps Connector Stats. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorStatsGet.json
azureDevOpsConnectorUpdateSample.js Update monitored AzureDevOps Connector details. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorUpdate.json
azureDevOpsOrgCreateOrUpdateSample.js Creates or updates an Azure DevOps Org. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgCreateOrUpdate.json
azureDevOpsOrgGetSample.js Returns a monitored AzureDevOps Org resource for a given ID. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgGet.json
azureDevOpsOrgListSample.js x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgList.json
azureDevOpsOrgUpdateSample.js Update monitored AzureDevOps Org details. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgUpdate.json
azureDevOpsProjectCreateOrUpdateSample.js Creates or updates an Azure DevOps Project. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectCreateOrUpdate.json
azureDevOpsProjectGetSample.js Returns a monitored AzureDevOps Project resource for a given ID. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectGet.json
azureDevOpsProjectListSample.js x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectList.json
azureDevOpsProjectUpdateSample.js Update monitored AzureDevOps Project details. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectUpdate.json
azureDevOpsRepoCreateOrUpdateSample.js Updates an Azure DevOps Repo. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoCreateOrUpdate.json
azureDevOpsRepoGetSample.js Returns a monitored AzureDevOps Project resource for a given ID. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoGet.json
azureDevOpsRepoListByConnectorSample.js x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoListByConnector.json
azureDevOpsRepoListSample.js x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoList.json
azureDevOpsRepoUpdateSample.js Update monitored AzureDevOps Project details. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoUpdate.json
gitHubConnectorCreateOrUpdateSample.js Create or update a monitored GitHub Connector resource. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorCreateOrUpdate.json
gitHubConnectorDeleteSample.js Delete monitored GitHub Connector details. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorDelete.json
gitHubConnectorGetSample.js Returns a monitored GitHub Connector resource for a given ID. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorGet.json
gitHubConnectorListByResourceGroupSample.js x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListByResourceGroup.json
gitHubConnectorListBySubscriptionSample.js Returns a list of monitored GitHub Connectors. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListBySubscription.json
gitHubConnectorStatsGetSample.js Returns the summary of the GitHub Connector Stats. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorStatsGet.json
gitHubConnectorUpdateSample.js Update monitored GitHub Connector details. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorUpdate.json
gitHubOwnerCreateOrUpdateSample.js Create or update a monitored GitHub owner. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerCreateOrUpdate.json
gitHubOwnerGetSample.js Returns a monitored GitHub repository. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerGet.json
gitHubOwnerListSample.js Returns a list of monitored GitHub owners. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerList.json
gitHubOwnerUpdateSample.js Patch a monitored GitHub repository. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerUpdate.json
gitHubRepoCreateOrUpdateSample.js Create or update a monitored GitHub repository. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoCreateOrUpdate.json
gitHubRepoGetSample.js Returns a monitored GitHub repository. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoGet.json
gitHubRepoListByConnectorSample.js Returns a list of monitored GitHub repositories. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoListByConnector.json
gitHubRepoListSample.js Returns a list of monitored GitHub repositories. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoList.json
gitHubRepoUpdateSample.js Patch a monitored GitHub repository. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoUpdate.json
operationsListSample.js Returns list of operations supported by the Microsoft.SecurityDevOps provider. x-ms-original-file: specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/OperationsList.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 azureDevOpsConnectorCreateOrUpdateSample.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 SECURITYDEVOPS_SUBSCRIPTION_ID="<securitydevops subscription id>" SECURITYDEVOPS_RESOURCE_GROUP="<securitydevops resource group>" node azureDevOpsConnectorCreateOrUpdateSample.js

Next Steps

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