Files
e1b671e43d [AutoPR @azure-arm-machinelearning]-generated-from-SDK Generation - JS-6492167 (#38998)
Configurations:
'specification/machinelearningservices/MachineLearningServices.Management/tspconfig.yaml',
API Version: 2026-03-15-preview, SDK Release Type: beta, and CommitSHA:
'dfef10d031a60f8e2fcf36e99364c144e9661036' in SpecRepo:
'https://github.com/Azure/azure-rest-api-specs' Pipeline run:
https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6492167
Refer to
https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites
to prepare for SDK release.

---------

Co-authored-by: Jiao Di (MSFT) <[email protected]>
Co-authored-by: Jiao Di (MSFT) <[email protected]>
2026-06-29 12:59:37 +08:00

239 KiB

@azure/arm-machinelearning client library samples for JavaScript (Beta)

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

File Name Description
batchDeploymentsCreateOrUpdateSample.js creates/updates a batch inference deployment (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/BatchDeployment/createOrUpdate.json
batchDeploymentsDeleteSample.js delete Batch Inference deployment (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/BatchDeployment/delete.json
batchDeploymentsGetSample.js gets a batch inference deployment by id. x-ms-original-file: 2026-03-15-preview/Workspace/BatchDeployment/get.json
batchDeploymentsListSample.js lists Batch inference deployments in the workspace. x-ms-original-file: 2026-03-15-preview/Workspace/BatchDeployment/list.json
batchDeploymentsUpdateSample.js update a batch inference deployment (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/BatchDeployment/update.json
batchEndpointsCreateOrUpdateSample.js creates a batch inference endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/BatchEndpoint/createOrUpdate.json
batchEndpointsDeleteSample.js delete Batch Inference Endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/BatchEndpoint/delete.json
batchEndpointsGetSample.js gets a batch inference endpoint by name. x-ms-original-file: 2026-03-15-preview/Workspace/BatchEndpoint/get.json
batchEndpointsListKeysSample.js lists batch Inference Endpoint keys. x-ms-original-file: 2026-03-15-preview/Workspace/BatchEndpoint/listKeys.json
batchEndpointsListSample.js lists Batch inference endpoint in the workspace. x-ms-original-file: 2026-03-15-preview/Workspace/BatchEndpoint/list.json
batchEndpointsUpdateSample.js update a batch inference endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/BatchEndpoint/update.json
capabilityHostsCreateOrUpdateSample.js create or update capabilityHost. x-ms-original-file: 2026-03-15-preview/CapabilityHost/createOrUpdate.json
capabilityHostsDeleteSample.js delete capabilityHost. x-ms-original-file: 2026-03-15-preview/CapabilityHost/delete.json
capabilityHostsGetSample.js get capabilityHost. x-ms-original-file: 2026-03-15-preview/CapabilityHost/get.json
codeContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Workspace/CodeContainer/createOrUpdate.json
codeContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Workspace/CodeContainer/delete.json
codeContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Workspace/CodeContainer/get.json
codeContainersListSample.js list containers. x-ms-original-file: 2026-03-15-preview/Workspace/CodeContainer/list.json
codeVersionsCreateOrGetStartPendingUploadSample.js generate a storage location and credential for the client to upload a code asset to. x-ms-original-file: 2026-03-15-preview/Workspace/CodeVersion/createOrGetStartPendingUpload.json
codeVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Workspace/CodeVersion/createOrUpdate.json
codeVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Workspace/CodeVersion/delete.json
codeVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Workspace/CodeVersion/get.json
codeVersionsListSample.js list versions. x-ms-original-file: 2026-03-15-preview/Workspace/CodeVersion/list.json
codeVersionsPublishSample.js publish version asset into registry. x-ms-original-file: 2026-03-15-preview/Workspace/CodeVersion/publish.json
componentContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentContainer/createOrUpdate.json
componentContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentContainer/delete.json
componentContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentContainer/get.json
componentContainersListSample.js list component containers. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentContainer/list.json
componentVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentVersion/createOrUpdate.json
componentVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentVersion/delete.json
componentVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentVersion/get.json
componentVersionsListSample.js list component versions. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentVersion/list.json
componentVersionsPublishSample.js publish version asset into registry. x-ms-original-file: 2026-03-15-preview/Workspace/ComponentVersion/publish.json
computeOperationsCreateOrUpdateSample.js creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet. x-ms-original-file: 2026-03-15-preview/Compute/createOrUpdate/AKSCompute.json
computeOperationsDeleteSample.js deletes specified Machine Learning compute. x-ms-original-file: 2026-03-15-preview/Compute/delete.json
computeOperationsGetAllowedResizeSizesSample.js returns supported virtual machine sizes for resize. x-ms-original-file: 2026-03-15-preview/Compute/getAllowedVMSizesForResize.json
computeOperationsGetSample.js gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them. x-ms-original-file: 2026-03-15-preview/Compute/get/AKSCompute.json
computeOperationsListKeysSample.js gets secrets related to Machine Learning compute (storage keys, service credentials, etc). x-ms-original-file: 2026-03-15-preview/Compute/listKeys.json
computeOperationsListNodesSample.js get the details (e.g IP address, port etc) of all the compute nodes in the compute. x-ms-original-file: 2026-03-15-preview/Compute/listNodes.json
computeOperationsListSample.js gets computes in specified workspace. x-ms-original-file: 2026-03-15-preview/Compute/list.json
computeOperationsResizeSample.js updates the size of a Compute Instance. x-ms-original-file: 2026-03-15-preview/Compute/resize.json
computeOperationsRestartSample.js posts a restart action to a compute instance x-ms-original-file: 2026-03-15-preview/Compute/restart.json
computeOperationsStartSample.js posts a start action to a compute instance x-ms-original-file: 2026-03-15-preview/Compute/start.json
computeOperationsStopSample.js posts a stop action to a compute instance x-ms-original-file: 2026-03-15-preview/Compute/stop.json
computeOperationsUpdateCustomServicesSample.js updates the custom services list. The list of custom services provided shall be overwritten. x-ms-original-file: 2026-03-15-preview/Compute/updateCustomServices.json
computeOperationsUpdateDataMountsSample.js update Data Mounts of a Machine Learning compute. x-ms-original-file: 2026-03-15-preview/Compute/updateDataMounts.json
computeOperationsUpdateIdleShutdownSettingSample.js updates the idle shutdown setting of a compute instance. x-ms-original-file: 2026-03-15-preview/Compute/updateIdleShutdownSetting.json
computeOperationsUpdateSample.js updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. x-ms-original-file: 2026-03-15-preview/Compute/patch.json
connectionCreateOrUpdateDeploymentSample.js create or update Azure OpenAI connection deployment resource with the specified parameters x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/createDeployment.json
connectionDeleteDeploymentSample.js delete Azure OpenAI connection deployment resource by name x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/deleteDeployment.json
connectionGetAllModelsSample.js get models under the Azure ML workspace for all Azure OpenAI connections that the user can deploy. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/listConnectionModels.json
connectionGetDeploymentSample.js get deployments under the Azure OpenAI connection by name. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/getDeployment.json
connectionGetModelsSample.js get available models under the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/getModels.json
connectionListDeploymentsSample.js get all the deployments under the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/listDeployments.json
connectionRaiBlocklistCreateSample.js update the state of specified blocklist associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklist/create.json
connectionRaiBlocklistDeleteSample.js deletes the specified custom blocklist associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklist/delete.json
connectionRaiBlocklistGetSample.js gets the specified custom blocklist associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklist/get.json
connectionRaiBlocklistItemAddBulkSample.js add multiple blocklist items to the specified blocklist associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklistItem/addBulk.json
connectionRaiBlocklistItemCreateSample.js update the state of specified blocklist item associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklistItem/create.json
connectionRaiBlocklistItemDeleteBulkSample.js delete multiple blocklist items from the specified blocklist associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklistItem/deleteBulk.json
connectionRaiBlocklistItemDeleteSample.js deletes the specified custom blocklist item associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklistItem/delete.json
connectionRaiBlocklistItemGetSample.js gets the specified custom blocklist item associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklistItem/get.json
connectionRaiBlocklistItemsListSample.js gets the custom blocklist items associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklistItem/list.json
connectionRaiBlocklistsListSample.js gets the custom blocklists associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiBlocklist/list.json
connectionRaiPoliciesListSample.js list the specified Content Filters associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiPolicy/list.json
connectionRaiPolicyCreateSample.js update the state of specified Content Filters associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiPolicy/create.json
connectionRaiPolicyDeleteSample.js deletes the specified Content Filters associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiPolicy/delete.json
connectionRaiPolicyGetSample.js gets the specified Content Filters associated with the Azure OpenAI connection. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/RaiPolicy/get.json
dataContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Workspace/DataContainer/createOrUpdate.json
dataContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Workspace/DataContainer/delete.json
dataContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Workspace/DataContainer/get.json
dataContainersListSample.js list data containers. x-ms-original-file: 2026-03-15-preview/Workspace/DataContainer/list.json
dataVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Workspace/DataVersionBase/createOrUpdate.json
dataVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Workspace/DataVersionBase/delete.json
dataVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Workspace/DataVersionBase/get.json
dataVersionsListSample.js list data versions in the data container x-ms-original-file: 2026-03-15-preview/Workspace/DataVersionBase/list.json
dataVersionsPublishSample.js publish version asset into registry. x-ms-original-file: 2026-03-15-preview/Workspace/DataVersionBase/publish.json
datastoresCreateOrUpdateSample.js create or update datastore. x-ms-original-file: 2026-03-15-preview/Datastore/AzureBlobWAccountKey/createOrUpdate.json
datastoresDeleteSample.js delete datastore. x-ms-original-file: 2026-03-15-preview/Datastore/delete.json
datastoresGetSample.js get datastore. x-ms-original-file: 2026-03-15-preview/Datastore/get.json
datastoresListSample.js list datastores. x-ms-original-file: 2026-03-15-preview/Datastore/list.json
datastoresListSecretsSample.js get datastore secrets. x-ms-original-file: 2026-03-15-preview/Datastore/listSecrets.json
endpointCreateOrUpdateSample.js create or update endpoint resource with the specified parameters x-ms-original-file: 2026-03-15-preview/Endpoint/create.json
endpointDeploymentCreateOrUpdateSample.js create or update endpoint deployment resource with the specified parameters x-ms-original-file: 2026-03-15-preview/Endpoint/Deployment/create.json
endpointDeploymentDeleteSample.js delete endpoint deployment resource by name x-ms-original-file: 2026-03-15-preview/Endpoint/Deployment/delete.json
endpointDeploymentGetInWorkspaceSample.js get all the deployments under the workspace scope. x-ms-original-file: 2026-03-15-preview/Endpoint/Deployment/getInWorkspace.json
endpointDeploymentGetSample.js get deployments under endpoint resource by name x-ms-original-file: 2026-03-15-preview/Endpoint/Deployment/get.json
endpointDeploymentListSample.js get all the deployments under the endpoint resource scope x-ms-original-file: 2026-03-15-preview/Endpoint/Deployment/getDeployments.json
endpointGetModelsSample.js get available models under the endpoint resource. x-ms-original-file: 2026-03-15-preview/Endpoint/getModels.json
endpointGetSample.js gets endpoint resource x-ms-original-file: 2026-03-15-preview/Endpoint/get.json
endpointListKeysSample.js list keys for the endpoint resource. x-ms-original-file: 2026-03-15-preview/Endpoint/listKeys.json
endpointListSample.js list All the endpoints under this workspace x-ms-original-file: 2026-03-15-preview/Endpoint/list.json
endpointRegenerateKeysSample.js regenerate account keys x-ms-original-file: 2026-03-15-preview/Endpoint/regenerateKey.json
environmentContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentContainer/createOrUpdate.json
environmentContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentContainer/delete.json
environmentContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentContainer/get.json
environmentContainersListSample.js list environment containers. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentContainer/list.json
environmentVersionsCreateOrUpdateSample.js creates or updates an EnvironmentVersion. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentVersion/createOrUpdate.json
environmentVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentVersion/delete.json
environmentVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentVersion/get.json
environmentVersionsListSample.js list versions. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentVersion/list.json
environmentVersionsPublishSample.js publish version asset into registry. x-ms-original-file: 2026-03-15-preview/Workspace/EnvironmentVersion/publish.json
featuresGetSample.js get feature. x-ms-original-file: 2026-03-15-preview/Feature/get.json
featuresListSample.js list Features. x-ms-original-file: 2026-03-15-preview/Feature/list.json
featuresetContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetContainer/createOrUpdate.json
featuresetContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetContainer/delete.json
featuresetContainersGetEntitySample.js get container. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetContainer/getEntity.json
featuresetContainersListSample.js list featurestore entity containers. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetContainer/list.json
featuresetVersionsBackfillSample.js backfill. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetVersion/backfill.json
featuresetVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetVersion/createOrUpdate.json
featuresetVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetVersion/delete.json
featuresetVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetVersion/get.json
featuresetVersionsListSample.js list versions. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturesetVersion/list.json
featurestoreEntityContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturestoreEntityContainer/createOrUpdate.json
featurestoreEntityContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturestoreEntityContainer/delete.json
featurestoreEntityContainersGetEntitySample.js get container. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturestoreEntityContainer/getEntity.json
featurestoreEntityContainersListSample.js list featurestore entity containers. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturestoreEntityContainer/list.json
featurestoreEntityVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturestoreEntityVersion/createOrUpdate.json
featurestoreEntityVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturestoreEntityVersion/delete.json
featurestoreEntityVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturestoreEntityVersion/get.json
featurestoreEntityVersionsListSample.js list versions. x-ms-original-file: 2026-03-15-preview/Workspace/FeaturestoreEntityVersion/list.json
inferenceEndpointsCreateOrUpdateSample.js create or update InferenceEndpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferenceEndpoint/createOrUpdate.json
inferenceEndpointsDeleteSample.js delete InferenceEndpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferenceEndpoint/delete.json
inferenceEndpointsGetSample.js get InferenceEndpoint. x-ms-original-file: 2026-03-15-preview/Workspace/InferenceEndpoint/get.json
inferenceEndpointsListSample.js list Inference Endpoints. x-ms-original-file: 2026-03-15-preview/Workspace/InferenceEndpoint/list.json
inferenceEndpointsUpdateSample.js update InferenceEndpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferenceEndpoint/update.json
inferenceGroupsCreateOrUpdateSample.js create or update InferenceGroup (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferenceGroup/createOrUpdate.json
inferenceGroupsDeleteSample.js delete InferenceGroup (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferenceGroup/delete.json
inferenceGroupsGetDeltaModelsStatusAsyncSample.js retrieve status of delta models associated with the InferenceGroup and the target base model. x-ms-original-file: 2026-03-15-preview/InferenceGroup/getDeltaModelsStatusAsync.json
inferenceGroupsGetSample.js get InferenceGroup. x-ms-original-file: 2026-03-15-preview/Workspace/InferenceGroup/get.json
inferenceGroupsGetStatusSample.js retrieve inference group status. x-ms-original-file: 2026-03-15-preview/Workspace/InferenceGroup/getStatus.json
inferenceGroupsListDeltaModelsAsyncSample.js list delta models associated with the InferenceGroup and the target base model. x-ms-original-file: 2026-03-15-preview/InferenceGroup/listDeltaModelsAsync.json
inferenceGroupsListSample.js list Inference Groups. x-ms-original-file: 2026-03-15-preview/Workspace/InferenceGroup/list.json
inferenceGroupsListSkusSample.js list Inference Group Skus. x-ms-original-file: 2026-03-15-preview/Workspace/InferenceGroup/listSkus.json
inferenceGroupsModifyDeltaModelsAsyncSample.js modify delta models associated with the InferenceGroup and the target base model. x-ms-original-file: 2026-03-15-preview/InferenceGroup/modifyDeltaModelsAsync.json
inferenceGroupsUpdateSample.js update InferenceGroup (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferenceGroup/update.json
inferencePoolsCreateOrUpdateSample.js create or update InferencePool (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferencePool/createOrUpdate.json
inferencePoolsDeleteSample.js delete InferencePool (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferencePool/delete.json
inferencePoolsGetSample.js get InferencePool. x-ms-original-file: 2026-03-15-preview/Workspace/InferencePool/get.json
inferencePoolsListSample.js list InferencePools. x-ms-original-file: 2026-03-15-preview/Workspace/InferencePool/list.json
inferencePoolsUpdateSample.js update InferencePool (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/InferencePool/update.json
jobsCancelSample.js cancels a Job (asynchronous). x-ms-original-file: 2026-03-15-preview/Job/cancel.json
jobsCreateOrUpdateSample.js creates and executes a Job. For update case, the Tags in the definition passed in will replace Tags in the existing job. x-ms-original-file: 2026-03-15-preview/Job/AutoMLJob/createOrUpdate.json
jobsDeleteSample.js deletes a Job (asynchronous). x-ms-original-file: 2026-03-15-preview/Job/delete.json
jobsGetSample.js gets a Job by name/id. x-ms-original-file: 2026-03-15-preview/Job/AutoMLJob/get.json
jobsListSample.js lists Jobs in the workspace. x-ms-original-file: 2026-03-15-preview/Job/AutoMLJob/list.json
managedNetworkProvisionsProvisionManagedNetworkSample.js provisions the managed network of a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/provision.json
managedNetworkSettingsGetSample.js get API for managed network settings of a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/getManagedNetworkV2.json
managedNetworkSettingsListSample.js list API for managed network settings of a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/listManagedNetworkV2.json
managedNetworkSettingsPatchSample.js patch API for managed network settings of a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/patchManagedNetworkV2.json
managedNetworkSettingsPutSample.js pUT API for managed network settings of a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/createOrUpdateManagedNetworkV2.json
managedNetworkSettingsRuleCreateOrUpdateSample.js creates or updates an outbound rule in the managed network of a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/createOrUpdateRule.json
managedNetworkSettingsRuleDeleteSample.js deletes an outbound rule from the managed network of a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/deleteRule.json
managedNetworkSettingsRuleGetSample.js gets an outbound rule from the managed network of a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/getRule.json
managedNetworkSettingsRuleListSample.js lists the managed network outbound rules for a machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/listRule.json
marketplaceSubscriptionsCreateOrUpdateSample.js create or update Marketplace Subscription (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/MarketplaceSubscription/createOrUpdate.json
marketplaceSubscriptionsDeleteSample.js delete Marketplace Subscription (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/MarketplaceSubscription/delete.json
marketplaceSubscriptionsGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Workspace/MarketplaceSubscription/get.json
marketplaceSubscriptionsListSample.js list containers. x-ms-original-file: 2026-03-15-preview/Workspace/MarketplaceSubscription/list.json
modelContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Workspace/ModelContainer/createOrUpdate.json
modelContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Workspace/ModelContainer/delete.json
modelContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Workspace/ModelContainer/get.json
modelContainersListSample.js list model containers. x-ms-original-file: 2026-03-15-preview/Workspace/ModelContainer/list.json
modelVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Workspace/ModelVersion/createOrUpdate.json
modelVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Workspace/ModelVersion/delete.json
modelVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Workspace/ModelVersion/get.json
modelVersionsListSample.js list model versions. x-ms-original-file: 2026-03-15-preview/Workspace/ModelVersion/list.json
modelVersionsPublishSample.js publish version asset into registry. x-ms-original-file: 2026-03-15-preview/Workspace/ModelVersion/publish.json
onlineDeploymentsCreateOrUpdateSample.js create or update Inference Endpoint Deployment (asynchronous). x-ms-original-file: 2026-03-15-preview/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json
onlineDeploymentsDeleteSample.js delete Inference Endpoint Deployment (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/OnlineDeployment/delete.json
onlineDeploymentsGetLogsSample.js polls an Endpoint operation. x-ms-original-file: 2026-03-15-preview/OnlineDeployment/getLogs.json
onlineDeploymentsGetSample.js get Inference Deployment Deployment. x-ms-original-file: 2026-03-15-preview/OnlineDeployment/KubernetesOnlineDeployment/get.json
onlineDeploymentsListSample.js list Inference Endpoint Deployments. x-ms-original-file: 2026-03-15-preview/OnlineDeployment/list.json
onlineDeploymentsListSkusSample.js list Inference Endpoint Deployment Skus. x-ms-original-file: 2026-03-15-preview/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json
onlineDeploymentsUpdateSample.js update Online Deployment (asynchronous). x-ms-original-file: 2026-03-15-preview/OnlineDeployment/KubernetesOnlineDeployment/update.json
onlineEndpointsCreateOrUpdateSample.js create or update Online Endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/OnlineEndpoint/createOrUpdate.json
onlineEndpointsDeleteSample.js delete Online Endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/OnlineEndpoint/delete.json
onlineEndpointsGetSample.js get Online Endpoint. x-ms-original-file: 2026-03-15-preview/Workspace/OnlineEndpoint/get.json
onlineEndpointsGetTokenSample.js retrieve a valid AML token for an Endpoint using AMLToken-based authentication. x-ms-original-file: 2026-03-15-preview/Workspace/OnlineEndpoint/getToken.json
onlineEndpointsListKeysSample.js list EndpointAuthKeys for an Endpoint using Key-based authentication. x-ms-original-file: 2026-03-15-preview/Workspace/OnlineEndpoint/listKeys.json
onlineEndpointsListSample.js list Online Endpoints. x-ms-original-file: 2026-03-15-preview/Workspace/OnlineEndpoint/list.json
onlineEndpointsRegenerateKeysSample.js regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/OnlineEndpoint/regenerateKeys.json
onlineEndpointsUpdateSample.js update Online Endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/OnlineEndpoint/update.json
operationsListSample.js list the operations for the provider x-ms-original-file: 2026-03-15-preview/Workspace/operationsList.json
outboundRuleCreateOrUpdateSample.js create a OutboundRuleBasicResource x-ms-original-file: 2026-03-15-preview/ManagedNetwork/createOrUpdateRuleV2.json
outboundRuleDeleteSample.js the DELETE API for deleting a single outbound rule of the managed network associated with the machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/deleteRuleV2.json
outboundRuleGetSample.js the GET API for retrieveing a single outbound rule of the managed network associated with the machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/getRuleV2.json
outboundRuleListSample.js the GET API for retrieveing the list of outbound rules of the managed network associated with the machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/listRuleV2.json
outboundRulesPostSample.js the POST API for updating the outbound rules of the managed network associated with the machine learning workspace. x-ms-original-file: 2026-03-15-preview/ManagedNetwork/postOutboundRulesV2.json
privateEndpointConnectionsCreateOrUpdateSample.js called by end-users to approve or reject a PE connection. This method must validate and forward the call to NRP. x-ms-original-file: 2026-03-15-preview/PrivateEndpointConnection/createOrUpdate.json
privateEndpointConnectionsDeleteSample.js called by end-users to delete a PE connection. x-ms-original-file: 2026-03-15-preview/PrivateEndpointConnection/delete.json
privateEndpointConnectionsGetSample.js called by end-users to get a PE connection. x-ms-original-file: 2026-03-15-preview/PrivateEndpointConnection/get.json
privateEndpointConnectionsListSample.js called by end-users to get all PE connections. x-ms-original-file: 2026-03-15-preview/PrivateEndpointConnection/list.json
privateLinkResourcesListSample.js called by Client (Portal, CLI, etc) to get available "private link resources" for the workspace. Each "private link resource" is a connection endpoint (IP address) to the resource. Pre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution. Other RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc. Defined in the "[NRP] Private Endpoint Design" doc, topic "GET API for GroupIds". x-ms-original-file: 2026-03-15-preview/PrivateLinkResource/list.json
ptuQuotaGetAvailableSample.js get available MaaS PTU quota. x-ms-original-file: 2026-03-15-preview/PTUQuota/getAvailable.json
ptuQuotaListAvailableSample.js list available MaaS PTU quota. x-ms-original-file: 2026-03-15-preview/PTUQuota/listAvailable.json
ptuQuotaListSample.js list MaaS PTU usage and quota. x-ms-original-file: 2026-03-15-preview/PTUQuota/list.json
quotasListSample.js gets the currently assigned Workspace Quotas based on VMFamily. x-ms-original-file: 2026-03-15-preview/Quota/list.json
quotasUpdateSample.js update quota for each VM family in workspace. x-ms-original-file: 2026-03-15-preview/Quota/update.json
raiPoliciesListSample.js list the specified Content Filters associated with the Azure OpenAI account. x-ms-original-file: 2026-03-15-preview/Endpoint/RaiPolicy/list.json
raiPolicyCreateSample.js update the state of specified Content Filters associated with the Azure OpenAI account. x-ms-original-file: 2026-03-15-preview/Endpoint/RaiPolicy/create.json
raiPolicyDeleteSample.js deletes the specified Content Filters associated with the Azure OpenAI account. x-ms-original-file: 2026-03-15-preview/Endpoint/RaiPolicy/delete.json
raiPolicyGetSample.js gets the specified Content Filters associated with the Azure OpenAI account. x-ms-original-file: 2026-03-15-preview/Endpoint/RaiPolicy/get.json
registriesCreateOrUpdateSample.js create or update registry x-ms-original-file: 2026-03-15-preview/Registries/createOrUpdate.json
registriesDeleteSample.js delete registry x-ms-original-file: 2026-03-15-preview/Registries/delete.json
registriesGetSample.js get registry x-ms-original-file: 2026-03-15-preview/Registries/get.json
registriesListBySubscriptionSample.js list registries by subscription x-ms-original-file: 2026-03-15-preview/Registries/listBySubscription.json
registriesListSample.js list registries x-ms-original-file: 2026-03-15-preview/Registries/list.json
registriesRemoveRegionsSample.js remove regions from registry x-ms-original-file: 2026-03-15-preview/Registries/removeRegions.json
registriesUpdateSample.js update tags x-ms-original-file: 2026-03-15-preview/Registries/update.json
registryCodeContainersCreateOrUpdateSample.js create or update Code container. x-ms-original-file: 2026-03-15-preview/Registry/CodeContainer/createOrUpdate.json
registryCodeContainersDeleteSample.js delete Code container. x-ms-original-file: 2026-03-15-preview/Registry/CodeContainer/delete.json
registryCodeContainersGetSample.js get Code container. x-ms-original-file: 2026-03-15-preview/Registry/CodeContainer/get.json
registryCodeContainersListSample.js list containers. x-ms-original-file: 2026-03-15-preview/Registry/CodeContainer/list.json
registryCodeVersionsCreateOrGetStartPendingUploadSample.js generate a storage location and credential for the client to upload a code asset to. x-ms-original-file: 2026-03-15-preview/Registry/CodeVersion/createOrGetStartPendingUpload.json
registryCodeVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Registry/CodeVersion/createOrUpdate.json
registryCodeVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Registry/CodeVersion/delete.json
registryCodeVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Registry/CodeVersion/get.json
registryCodeVersionsListSample.js list versions. x-ms-original-file: 2026-03-15-preview/Registry/CodeVersion/list.json
registryComponentContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Registry/ComponentContainer/createOrUpdate.json
registryComponentContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Registry/ComponentContainer/delete.json
registryComponentContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Registry/ComponentContainer/get.json
registryComponentContainersListSample.js list containers. x-ms-original-file: 2026-03-15-preview/Registry/ComponentContainer/list.json
registryComponentVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Registry/ComponentVersion/createOrUpdate.json
registryComponentVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Registry/ComponentVersion/delete.json
registryComponentVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Registry/ComponentVersion/get.json
registryComponentVersionsListSample.js list versions. x-ms-original-file: 2026-03-15-preview/Registry/ComponentVersion/list.json
registryDataContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Registry/DataContainer/createOrUpdate.json
registryDataContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Registry/DataContainer/delete.json
registryDataContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Registry/DataContainer/get.json
registryDataContainersListSample.js list Data containers. x-ms-original-file: 2026-03-15-preview/Registry/DataContainer/registryList.json
registryDataReferencesGetBlobReferenceSASSample.js get blob reference SAS Uri. x-ms-original-file: 2026-03-15-preview/DataReference/getBlobReferenceSAS.json
registryDataVersionsCreateOrGetStartPendingUploadSample.js generate a storage location and credential for the client to upload a data asset to. x-ms-original-file: 2026-03-15-preview/Registry/DataVersionBase/createOrGetStartPendingUpload.json
registryDataVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Registry/DataVersionBase/createOrUpdate.json
registryDataVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Registry/DataVersionBase/delete.json
registryDataVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Registry/DataVersionBase/get.json
registryDataVersionsListSample.js list data versions in the data container x-ms-original-file: 2026-03-15-preview/Registry/DataVersionBase/registryList.json
registryEnvironmentContainersCreateOrUpdateSample.js create or update container. x-ms-original-file: 2026-03-15-preview/Registry/EnvironmentContainer/createOrUpdate.json
registryEnvironmentContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Registry/EnvironmentContainer/delete.json
registryEnvironmentContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Registry/EnvironmentContainer/get.json
registryEnvironmentContainersListSample.js list environment containers. x-ms-original-file: 2026-03-15-preview/Registry/EnvironmentContainer/list.json
registryEnvironmentVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Registry/EnvironmentVersion/createOrUpdate.json
registryEnvironmentVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Registry/EnvironmentVersion/delete.json
registryEnvironmentVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Registry/EnvironmentVersion/get.json
registryEnvironmentVersionsListSample.js list versions. x-ms-original-file: 2026-03-15-preview/Registry/EnvironmentVersion/list.json
registryModelContainersCreateOrUpdateSample.js create or update model container. x-ms-original-file: 2026-03-15-preview/Registry/ModelContainer/createOrUpdate.json
registryModelContainersDeleteSample.js delete container. x-ms-original-file: 2026-03-15-preview/Registry/ModelContainer/delete.json
registryModelContainersGetSample.js get container. x-ms-original-file: 2026-03-15-preview/Registry/ModelContainer/get.json
registryModelContainersListSample.js list model containers. x-ms-original-file: 2026-03-15-preview/Registry/ModelContainer/list.json
registryModelVersionsCreateOrGetStartPendingUploadSample.js generate a storage location and credential for the client to upload a model asset to. x-ms-original-file: 2026-03-15-preview/Registry/ModelVersion/createOrGetStartPendingUpload.json
registryModelVersionsCreateOrUpdateSample.js create or update version. x-ms-original-file: 2026-03-15-preview/Registry/ModelVersion/createOrUpdate.json
registryModelVersionsDeleteSample.js delete version. x-ms-original-file: 2026-03-15-preview/Registry/ModelVersion/delete.json
registryModelVersionsGetSample.js get version. x-ms-original-file: 2026-03-15-preview/Registry/ModelVersion/get.json
registryModelVersionsListSample.js list versions. x-ms-original-file: 2026-03-15-preview/Registry/ModelVersion/list.json
schedulesCreateOrUpdateSample.js create or update schedule. x-ms-original-file: 2026-03-15-preview/Schedule/createOrUpdate.json
schedulesDeleteSample.js delete schedule. x-ms-original-file: 2026-03-15-preview/Schedule/delete.json
schedulesGetSample.js get schedule. x-ms-original-file: 2026-03-15-preview/Schedule/get.json
schedulesListSample.js list schedules in specified workspace. x-ms-original-file: 2026-03-15-preview/Schedule/list.json
serverlessEndpointsCreateOrUpdateSample.js create or update Serverless Endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/ServerlessEndpoint/createOrUpdate.json
serverlessEndpointsDeleteSample.js delete Serverless Endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/ServerlessEndpoint/delete.json
serverlessEndpointsGetSample.js get Serverless Endpoint. x-ms-original-file: 2026-03-15-preview/Workspace/ServerlessEndpoint/get.json
serverlessEndpointsListKeysSample.js list EndpointAuthKeys for an Endpoint using Key-based authentication. x-ms-original-file: 2026-03-15-preview/Workspace/ServerlessEndpoint/listKeys.json
serverlessEndpointsListSample.js list Serverless Endpoints. x-ms-original-file: 2026-03-15-preview/Workspace/ServerlessEndpoint/list.json
serverlessEndpointsRegenerateKeysSample.js regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/ServerlessEndpoint/regenerateKeys.json
serverlessEndpointsUpdateSample.js update Serverless Endpoint (asynchronous). x-ms-original-file: 2026-03-15-preview/Workspace/ServerlessEndpoint/update.json
usagesListSample.js gets the current usage information as well as limits for AML resources for given subscription and location. x-ms-original-file: 2026-03-15-preview/Usage/list.json
virtualMachineSizesListSample.js returns supported VM Sizes in a location x-ms-original-file: 2026-03-15-preview/VirtualMachineSize/list.json
workspaceConnectionsCreateSample.js create or update machine learning workspaces connections under the specified workspace. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/create.json
workspaceConnectionsDeleteSample.js delete machine learning workspaces connections by name. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/delete.json
workspaceConnectionsGetSample.js lists machine learning workspaces connections by name. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/get.json
workspaceConnectionsListSample.js lists all the available machine learning workspaces connections under the specified workspace. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/list.json
workspaceConnectionsListSecretsSample.js list all the secrets of a machine learning workspaces connections. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/listSecrets.json
workspaceConnectionsTestConnectionSample.js test machine learning workspaces connections under the specified workspace. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/testConnection.json
workspaceConnectionsUpdateSample.js update machine learning workspaces connections under the specified workspace. x-ms-original-file: 2026-03-15-preview/WorkspaceConnection/update.json
workspaceFeaturesListSample.js lists all enabled features for a workspace x-ms-original-file: 2026-03-15-preview/WorkspaceFeature/list.json
workspacesCreateOrUpdateSample.js creates or updates a workspace with the specified parameters. x-ms-original-file: 2026-03-15-preview/Workspace/create.json
workspacesDeleteSample.js deletes a machine learning workspace. x-ms-original-file: 2026-03-15-preview/Workspace/delete.json
workspacesDiagnoseSample.js diagnose workspace setup issue. x-ms-original-file: 2026-03-15-preview/Workspace/diagnose.json
workspacesGetSample.js gets the properties of the specified machine learning workspace. x-ms-original-file: 2026-03-15-preview/Workspace/get.json
workspacesListByResourceGroupSample.js lists all the available machine learning workspaces under the specified resource group. x-ms-original-file: 2026-03-15-preview/Workspace/listByResourceGroup.json
workspacesListBySubscriptionSample.js lists all the available machine learning workspaces under the specified subscription. x-ms-original-file: 2026-03-15-preview/Workspace/listBySubscription.json
workspacesListKeysSample.js lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry. x-ms-original-file: 2026-03-15-preview/Workspace/listKeys.json
workspacesListNotebookAccessTokenSample.js get Azure Machine Learning Workspace notebook access token x-ms-original-file: 2026-03-15-preview/Workspace/listNotebookAccessToken.json
workspacesListNotebookKeysSample.js lists keys of Azure Machine Learning Workspaces notebook. x-ms-original-file: 2026-03-15-preview/Notebook/listKeys.json
workspacesListOutboundNetworkDependenciesEndpointsSample.js called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically. x-ms-original-file: 2026-03-15-preview/ExternalFQDN/get.json
workspacesListStorageAccountKeysSample.js lists keys of Azure Machine Learning Workspace's storage account. x-ms-original-file: 2026-03-15-preview/Workspace/listStorageAccountKeys.json
workspacesPrepareNotebookSample.js prepare Azure Machine Learning Workspace's notebook resource x-ms-original-file: 2026-03-15-preview/Notebook/prepare.json
workspacesResyncKeysSample.js resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry x-ms-original-file: 2026-03-15-preview/Workspace/resyncKeys.json
workspacesUpdateSample.js updates a machine learning workspace with the specified parameters. x-ms-original-file: 2026-03-15-preview/Workspace/update.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 batchDeploymentsCreateOrUpdateSample.js

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

node batchDeploymentsCreateOrUpdateSample.js

Next Steps

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