reference-yaml-datastore-data-lake-gen2.md

title	titleSuffix	description	services	ms.service	ms.subservice	ms.topic	ms.custom	author	ms.author	ms.date	ms.reviewer
CLI (v2) Azure Data Lake Gen2 datastore YAML schema	Azure Machine Learning	Reference documentation for the CLI (v2) Azure Data Lake Gen2 datastore YAML schema.	machine-learning	machine-learning	mldata	reference	cliv2, event-tier1-build-2022	ynpandey	yogipandey	10/21/2021	laobri

CLI (v2) Azure Data Lake Gen2 YAML schema

[!INCLUDE cli v2]

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

[!INCLUDE schema note]

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_data_lake_gen2
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.
filesystem	string	Required. Name of the file system. The parent directory that contains the files and folders. This is equivalent to a container in Azure Blob storage.
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>.dfs.core.windows.net.		core.windows.net
protocol	string	Protocol to use to connect to the file system.	https, abfss	https
credentials	object	Service principal credentials for connecting to the Azure storage account. Credential secrets are stored in the workspace key vault.
credentials.tenant_id	string	The tenant ID of the service principal. Required if credentials is specified.
credentials.client_id	string	The client ID of the service principal. Required if credentials is specified.
credentials.client_secret	string	The client secret of the service principal. Required if credentials is specified.
credentials.resource_url	string	The resource URL that determines what operations will be performed on the Azure Data Lake Storage Gen2 account.		https://storage.azure.com/
credentials.authority_url	string	The authority URL used to authenticate the user.		https://login.microsoftonline.com

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: identity-based access

:::code language="yaml" source="~/azureml-examples-main/cli/resources/datastore/adls-gen2-credless.yml":::

YAML: tenant ID, client ID, client secret

:::code language="yaml" source="~/azureml-examples-main/cli/resources/datastore/adls-gen2.yml":::

Next steps

• Install and use the CLI (v2)