PowerShell modules for Machine Learning Studio (classic)

APPLIES TO: Applies to.Machine Learning Studio (classic) Does not apply to.Azure Machine Learning

Important

Support for Machine Learning Studio (classic) will end on 31 August 2024. We recommend you transition to Azure Machine Learning by that date.

Beginning 1 December 2021, you will not be able to create new Machine Learning Studio (classic) resources. Through 31 August 2024, you can continue to use the existing Machine Learning Studio (classic) resources.

ML Studio (classic) documentation is being retired and may not be updated in the future.

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

You can interact with Studio (classic) resources using three PowerShell modules:

Although these PowerShell 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.

Check the support table below to see which resources are supported by each module.

Azure PowerShell Az and AzureRM

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. Az and AzureRM both manage solutions deployed using the Azure Resource Manager deployment model. These resources include Studio (classic) workspaces and Studio (classic) "New" web services.

PowerShell classic can be installed alongside either Az or AzureRM to cover both "new" and "classic" resource types. 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. Learn more about Az versus AzureRM and the migration path in introduction to the Azure PowerShell Az.

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

PowerShell classic

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

However, Microsoft recommends that you use the Resource Manager deployment model for all future 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 classic can be installed alongside either Az or AzureRM to cover both "new" and "classic" resource types.

PowerShell support table

Task Az PowerShell classic
Create/delete workspaces Resource Manager templates
Manage workspace commitment plans New-AzMlCommitmentPlan
Manage workspace users Add-AmlWorkspaceUsers
Manage web services New-AzMlWebService
("new" web services)
New-AmlWebService
("classic" web services)
Manage web service endpoints/keys Get-AzMlWebServiceKey Add-AmlWebServiceEndpoint
Manage user datasets/trained models Get-AmlDataset
Manage user experiments Start-AmlExperiment
Manage custom modules New-AmlCustomModule

Next steps

Consult the full documentation these PowerShell module: