CLI (v2) Azure Files datastore YAML schema

The source JSON schema can be found at https://azuremlschemas.azureedge.net/latest/azureFile.schema.json.

Important

This feature is currently in public preview. This preview version is provided without a service-level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.

Note

The YAML syntax detailed in this document is based on the JSON schema for the latest version of the ML CLI v2 extension. This syntax is guaranteed only to work with the latest version of the ML CLI v2 extension. You can find the schemas for older extension versions at https://azuremlschemasprod.azureedge.net/.

YAML syntax

Key Type Description Allowed values Default value
$schema string The YAML schema. If you use the Azure Machine Learning VS Code extension to author the YAML file, including $schema at the top of your file enables you to invoke schema and resource completions.
type string Required. The type of datastore. azure_file
name string Required. Name of the datastore.
description string Description of the datastore.
tags object Dictionary of tags for the datastore.
account_name string Required. Name of the Azure storage account.
file_share_name string Required. Name of the file share.
endpoint string Endpoint suffix of the storage service, which is used for creating the storage account endpoint URL by combining the storage account name and endpoint. Example storage account URL: https://<storage-account-name>.file.core.windows.net. core.windows.net
protocol string Protocol to use to connect to the file share. https https
credentials object Credential-based authentication credentials for connecting to the Azure storage account. You can provide either an account key or a shared access signature (SAS) token. Credential secrets are stored in the workspace key vault.
credentials.account_key string The account key for accessing the storage account. One of credentials.account_key or credentials.sas_token is required if credentials is specified.
credentials.sas_token string The SAS token for accessing the storage account. One of credentials.account_key or credentials.sas_token is required if credentials is specified.

Remarks

The az ml datastore command can be used for managing Azure Machine Learning datastores.

Examples

Examples are available in the examples GitHub repository. Several are shown below.

YAML: account key

$schema: https://azuremlschemas.azureedge.net/latest/azureFile.schema.json
name: file-example
type: azure_file
description: Datastore pointing to an Azure File Share.
account_name: mytestfilestore
file_share_name: my-share
credentials:
  account_key: XxXxXxXXXXXXXxXxXxxXxxXXXXXXXXxXxxXXxXXXXXXXxxxXxXXxXXXXXxXXxXXXxXxXxxxXXxXXxXXXXXxXxxXX

YAML: sas token

$schema: https://azuremlschemas.azureedge.net/latest/azureFile.schema.json
name: file-sas-example
type: azure_file
description: Datastore pointing to an Azure File Share using SAS token.
account_name: mytestfilestore
file_share_name: my-share
credentials:
  sas_token: ?xx=XXXX-XX-XX&xx=xxxx&xxx=xxx&xx=xxxxxxxxxxx&xx=XXXX-XX-XXXXX:XX:XXX&xx=XXXX-XX-XXXXX:XX:XXX&xxx=xxxxx&xxx=XXxXXXxxxxxXXXXXXXxXxxxXXXXXxxXXXXXxXXXXxXXXxXXxXX

Next steps