az ml datastore
Commands for managing and using datastores with the Azure ML Workspace.
Commands
| az ml datastore attach-adls |
Attach an ADLS datastore. |
| az ml datastore attach-adls-gen2 |
Attach a ADLS Gen2 datastore. |
| az ml datastore attach-blob |
Attach a blob storage datastore. |
| az ml datastore attach-dbfs |
Attach a Databricks File System datastore. |
| az ml datastore attach-file |
Attach a file share datastore. |
| az ml datastore attach-mysqldb |
Attach an Azure MySQL datastore. |
| az ml datastore attach-psqldb |
Attach an Azure PostgreSQL datastore. |
| az ml datastore attach-sqldb |
Attach an Azure SQL datastore. |
| az ml datastore detach |
Detach a datastore by name. |
| az ml datastore download |
Download files from a Datastore. |
| az ml datastore list |
List datastores in the workspace. |
| az ml datastore set-default |
Set the workspace default datastore by name. |
| az ml datastore show |
Show a single datastore by name. |
| az ml datastore show-default |
Show the workspace default datastore. |
| az ml datastore upload |
Upload files to a Datastore. |
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]
[--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.
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. Defaults to https://datalake.azure.net/ allowing for filesystem operations.
Specifies the subscription Id.
Workspace name.
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.
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
[--authority-url]
[--endpoint]
[--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
Authority url used to authenticate the user.
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.
Determines what operations will be performed on the data lake store. Defaults to https://storage.azure.com/ allowing for filesystem operations.
Specifies the subscription Id.
Workspace name.
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.
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.
Grants Workspace Managed Service Identity (MSI) access to the storage account. Defaults to False. This should be set if the storage account is in a VNet. If set to True, we will use the current user's identity to grant the Workspace MSI access to the storage account. It may take up to 5 minutes for the granted access to take effect so the first time you run this, it can fail. If such an event occurs, please rerun this command after 5 minutes. If this error persists, please contact Azure Support.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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]
[--include-secret]
[--output-metadata-file]
[--password]
[--path]
[--resource-group]
[--resource-url]
[--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.
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.
Specifies the subscription Id.
The service principal Tenant ID.
The username of the database user to access the database.
Workspace name.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Increase logging verbosity. Use --debug for full debug logs.