az ml datastore
Note
This reference is part of the azure-cli-ml extension for the Azure CLI (version 2.0.28 or higher). The extension will automatically install the first time you run an az ml datastore command. Learn more about extensions.
Commands for managing and using datastores with the Azure ML Workspace.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az ml datastore attach-adls |
Attach an ADLS datastore. |
Extension | GA |
| az ml datastore attach-adls-gen2 |
Attach a ADLS Gen2 datastore. |
Extension | GA |
| az ml datastore attach-blob |
Attach a blob storage datastore. |
Extension | GA |
| az ml datastore attach-dbfs |
Attach a Databricks File System datastore. |
Extension | GA |
| az ml datastore attach-file |
Attach a file share datastore. |
Extension | GA |
| az ml datastore attach-mysqldb |
Attach an Azure MySQL datastore. |
Extension | GA |
| az ml datastore attach-psqldb |
Attach an Azure PostgreSQL datastore. |
Extension | GA |
| az ml datastore attach-sqldb |
Attach an Azure SQL datastore. |
Extension | GA |
| az ml datastore detach |
Detach a datastore by name. |
Extension | GA |
| az ml datastore download |
Download files from a Datastore. |
Extension | GA |
| az ml datastore list |
List datastores in the workspace. |
Extension | GA |
| az ml datastore set-default |
Set the workspace default datastore by name. |
Extension | GA |
| az ml datastore show |
Show a single datastore by name. |
Extension | GA |
| az ml datastore show-default |
Show the workspace default datastore. |
Extension | GA |
| az ml datastore upload |
Upload files to a Datastore. |
Extension | GA |
az ml datastore attach-adls
Attach an ADLS datastore.
az ml datastore attach-adls --client-id
--client-secret
--name
--store-name
--tenant-id
[--adls-resource-group]
[--adls-subscription-id]
[--authority-url]
[--grant-workspace-msi-access]
[--include-secret]
[--output-metadata-file]
[--path]
[--resource-group]
[--resource-url]
[--subscription-id]
[--workspace-name]Required Parameters
The service principal's client/application ID.
The service principal's secret.
The datastore name.
The ADLS store name.
The service principal Tenant ID.
Optional Parameters
The resource group the ADLS store belongs to.
The ID of the subscription the ADLS store belongs to.
Authority url used to authenticate the user.
Defaults to False. Set it to True to access data behind virtual network from Machine Learning Studio. This makes data access from Machine Learning Studio use workspace managed identity for authentication, You have to be Owner or User Access Administrator of the storage to opt-in. Ask your administrator to configure it for you if you do not have the required permission. Learn more 'https://docs.microsoft.com/azure/machine-learning/how-to-enable-studio-virtual-network.
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Determines what operations will be performed on the data lake store.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore attach-adls-gen2
Attach a ADLS Gen2 datastore.
az ml datastore attach-adls-gen2 --account-name
--client-id
--client-secret
--file-system
--name
--tenant-id
[--adlsgen2-account-resource-group]
[--adlsgen2-account-subscription-id]
[--authority-url]
[--endpoint]
[--grant-workspace-msi-access]
[--include-secret]
[--output-metadata-file]
[--path]
[--protocol]
[--resource-group]
[--resource-url]
[--subscription-id]
[--workspace-name]Required Parameters
The name of the storage account.
The service principal's client/application ID.
The service principal's secret.
The file system name of the ADLS Gen2.
The datastore name.
The service principal Tenant ID.
Optional Parameters
The resource group of the ADLS Gen2 storage account.
The subscription ID of the ADLS Gen2 storage account.
Authority url used to authenticate the user.
The endpoint of the storage account. Defaults to core.windows.net.
Defaults to False. Set it to True to access data behind virtual network from Machine Learning Studio. This makes data access from Machine Learning Studio use workspace managed identity for authentication, You have to be Owner or User Access Administrator of the storage to opt-in. Ask your administrator to configure it for you if you do not have the required permission. Learn more 'https://docs.microsoft.com/azure/machine-learning/how-to-enable-studio-virtual-network.
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Protocol to use to connect to the blob container. If not specified, defaults to https.
Resource group name.
Determines what operations will be performed on the data lake store.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore attach-blob
Attach a blob storage datastore.
az ml datastore attach-blob --account-name
--container-name
--name
[--account-key]
[--endpoint]
[--grant-workspace-msi-access]
[--include-secret]
[--output-metadata-file]
[--path]
[--protocol]
[--resource-group]
[--sas-token]
[--storage-account-resource-group]
[--storage-account-subscription-id]
[--subscription-id]
[--workspace-name]Required Parameters
The name of the storage account.
The blob container name.
The datastore name.
Optional Parameters
The storage account key.
The endpoint of the storage account. Defaults to core.windows.net.
Defaults to False. Set it to True to access data behind virtual network from Machine Learning Studio. This makes data access from Machine Learning Studio use workspace managed identity for authentication, You have to be Owner or User Access Administrator of the storage to opt-in. Ask your administrator to configure it for you if you do not have the required permission. Learn more 'https://docs.microsoft.com/azure/machine-learning/how-to-enable-studio-virtual-network.
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Protocol to use to connect to the blob container. If not specified, defaults to https.
Resource group name.
A SAS token for the blob container.
The resource group of the storage account.
The subscription ID of the storage account.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore attach-dbfs
Attach a Databricks File System datastore.
az ml datastore attach-dbfs --name
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The datastore name.
Optional Parameters
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore attach-file
Attach a file share datastore.
az ml datastore attach-file --account-name
--name
--share-name
[--account-key]
[--endpoint]
[--include-secret]
[--output-metadata-file]
[--path]
[--protocol]
[--resource-group]
[--sas-token]
[--subscription-id]
[--workspace-name]Required Parameters
The name of the storage account.
The datastore name.
The file share name.
Optional Parameters
The storage account key.
The endpoint of the storage account. Defaults to core.windows.net.
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Protocol to use to connect to the blob container. If not specified, defaults to https.
Resource group name.
A SAS token for the blob container.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore attach-mysqldb
Attach an Azure MySQL datastore.
az ml datastore attach-mysqldb --database-name
--name
--password
--server-name
--user-id
[--endpoint]
[--include-secret]
[--output-metadata-file]
[--path]
[--port]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The database name.
The datastore name.
The password.
The SQL/PostgreSQL/MySQL server name.
The user ID.
Optional Parameters
The endpoint of the server. Defaults to mysql.database.azure.com.
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
The port number.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore attach-psqldb
Attach an Azure PostgreSQL datastore.
az ml datastore attach-psqldb --database-name
--name
--password
--server-name
--user-id
[--endpoint]
[--enforce-ssl]
[--include-secret]
[--output-metadata-file]
[--path]
[--port]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The database name.
The datastore name.
The password.
The SQL/PostgreSQL/MySQL server name.
The user ID.
Optional Parameters
The endpoint of the server. Defaults to postgres.database.azure.com.
This sets the ssl value of the server. Defaults to true if not set.
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
The port number.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore attach-sqldb
Attach an Azure SQL datastore.
az ml datastore attach-sqldb --database-name
--name
--server-name
[--authority-url]
[--client-id]
[--client-secret]
[--endpoint]
[--grant-workspace-msi-access]
[--include-secret]
[--output-metadata-file]
[--password]
[--path]
[--resource-group]
[--resource-url]
[--sql-resource-group]
[--sql-subscription-id]
[--subscription-id]
[--tenant-id]
[--username]
[--workspace-name]Required Parameters
The database name.
The datastore name.
The SQL/PostgreSQL/MySQL server name.
Optional Parameters
Authority url used to authenticate the user.
The service principal/application ID.
The service principal's secret.
The endpoint of the sql server. Defaults to database.windows.net.
Defaults to False. Set it to True to access data behind virtual network from Machine Learning Studio. This makes data access from Machine Learning Studio use workspace managed identity for authentication, You have to be Owner or User Access Administrator of the storage to opt-in. Ask your administrator to configure it for you if you do not have the required permission. Learn more 'https://docs.microsoft.com/azure/machine-learning/how-to-enable-studio-virtual-network.
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
The password of the database user to access the database.
Path to a root directory for run configuration files.
Resource group name.
Determines what operations will be performed on the database.
The resource group of the Azure Sql Server.
The subscription ID of the Azure Sql Server.
Specifies the subscription Id.
The service principal Tenant ID.
The username of the database user to access the database.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore detach
Detach a datastore by name.
az ml datastore detach --name
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The datastore name.
Optional Parameters
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore download
Download files from a Datastore.
az ml datastore download --name
--target-path
[--hide-progress]
[--output-metadata-file]
[--overwrite]
[--path]
[--prefix]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The datastore name.
Target path for the downloaded files.
Optional Parameters
Whether to hide progress of operation.
Provide an optional output file location for structured object output.
Overwrite target files if they exist.
Path to a root directory for run configuration files.
Path filter for files to download. If none is provided, downloads everything.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore list
List datastores in the workspace.
az ml datastore list [--include-secret]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Optional Parameters
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore set-default
Set the workspace default datastore by name.
az ml datastore set-default --name
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The datastore name.
Optional Parameters
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore show
Show a single datastore by name.
az ml datastore show --name
[--include-secret]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The datastore name.
Optional Parameters
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore show-default
Show the workspace default datastore.
az ml datastore show-default [--include-secret]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Optional Parameters
Show the registered secret for the datastores.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml datastore upload
Upload files to a Datastore.
az ml datastore upload --name
--src-path
[--hide-progress]
[--output-metadata-file]
[--overwrite]
[--path]
[--resource-group]
[--subscription-id]
[--target-path]
[--workspace-name]Required Parameters
The datastore name.
Path from which to upload data.
Optional Parameters
Whether to hide progress of operation.
Provide an optional output file location for structured object output.
Overwrite target files if they exist.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Path to upload data in the container. Uploads to the root by default.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for