PowerShell modules for Azure Machine Learning Studio

Using PowerShell modules, you can programmatically manage your Studio resources and assets such as workspaces, datasets, and web services.

You can interact with Studio resources using three Powershell modules:

Although these modules have some similarities, each is designed for particular scenarios. This article describes the differences between the PowerShell modules, and helps you decide which ones to choose.

Choosing modules

Choosing between the available PowerShell modules depends on the type of resources you are managing.

Check the support table below to see which resources are supported by each module. Since PowerShell classic can be installed in parallel with either Az or AzureRM, you can install two modules and cover all resource types (classic with Az or classic with AzureRM)

However, it is not recommended to have Az and AzureRM installed at the same time. To decide between Az and AzureRM, Microsoft recommends Az for all future deployments. Use AzureRm only if there are special circumstances in your environment that require it.

To learn more about the differences between Az and AzureRM, as well as our provided migration path, see our introduction to the Azure PowerShell Az.

Azure PowerShell Az and AzureRM

Az and AzureRM both manage solutions deployed using the Azure Resource Manager deployment model. These resources include Studio workspaces and Studio New web services. To manage resources deployed using the classic deployment model, you should use the PowerShell classic module. If you would like to learn more about the deployment models, see the Azure Resource Manager vs. classic deployment article.

Az is now the intended PowerShell module for interacting with Azure and includes all the previous functionality of AzureRM. AzureRM will continue to receive bug fixes, but it will receive no new cmdlets or features. While there is an upgrade path from AzureRM, if you encounter problems with Az when working with Studio, report the problem and fall back to using AzureRM.

To get started with Az, follow the installation instructions for Azure Az.

PowerShell classic

The Studio PowerShell classic module allows you to manage resources deployed using the classic deployment model. These resources include Studio user assets, classic web services, and classic web service endpoints.

However, Microsoft recommends that you use the Resource Manager deployment model for all new resources to simplify the deployment and management of resources. If you would like to learn more about the deployment models, see the Azure Resource Manager vs. classic deployment article.

To get started with PowerShell classic, download the release package from GitHub and follow the instructions for installation. The instructions explain how to unblock the downloaded/unzipped DLL and then import it into your PowerShell environment.

PowerShell support table

Studio workspaces Az AzureRM PowerShell classic
Create/Delete workspaces Resource Manager templates Resource Manager templates
Manage workspace users Add-AmlWorkspaceUsers
Manage commitment plans New-AzMlCommitmentPlan New-AzureRmMlCommitmentPlan
Web services Az AzureRM PowerShell classic
Manage web services New-AzMlWebService
(New web services)
New-AzureRmMlWebService
(New web services)
New-AmlWebService
(classic web services)
Manage endpoints/keys Get-AzMlWebServiceKeys
(New web services)
Get-AzureRmMlWebServiceKeys
(New web services)
Add-AmlWebServiceEndpoint
(classic web services)
User assets Az AzureRM PowerShell classic
Manage datasets/trained models Get-AmlDataset
Manage experiments Start-AmlExperiment
Manage custom modules New-AmlCustomModule

Next steps

Follow these links for full documentation for the PowerShell modules: