The workspaces/datastores resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.MachineLearningServices/workspaces/datastores resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/datastores",
"apiVersion": "2023-10-01",
"name": "string",
"properties": {
"credentials": {
"credentialsType": "string"
// For remaining properties, see DatastoreCredentials objects
},
"description": "string",
"properties": {
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string"
},
"tags": {
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string"
},
"datastoreType": "string"
// For remaining properties, see DatastoreProperties objects
}
}
Set the datastoreType property to specify the type of object.
For AzureBlob, use:
"datastoreType": "AzureBlob",
"accountName": "string",
"containerName": "string",
"endpoint": "string",
"protocol": "string",
"resourceGroup": "string",
"serviceDataAccessAuthIdentity": "string",
"subscriptionId": "string"
For AzureDataLakeGen1, use:
"datastoreType": "AzureDataLakeGen1",
"resourceGroup": "string",
"serviceDataAccessAuthIdentity": "string",
"storeName": "string",
"subscriptionId": "string"
For AzureDataLakeGen2, use:
"datastoreType": "AzureDataLakeGen2",
"accountName": "string",
"endpoint": "string",
"filesystem": "string",
"protocol": "string",
"resourceGroup": "string",
"serviceDataAccessAuthIdentity": "string",
"subscriptionId": "string"
For AzureFile, use:
"datastoreType": "AzureFile",
"accountName": "string",
"endpoint": "string",
"fileShareName": "string",
"protocol": "string",
"resourceGroup": "string",
"serviceDataAccessAuthIdentity": "string",
"subscriptionId": "string"
Set the credentialsType property to specify the type of object.
For AccountKey, use:
"credentialsType": "AccountKey",
"secrets": {
"key": "string",
"secretsType": "string"
}
For Certificate, use:
"credentialsType": "Certificate",
"authorityUrl": "string",
"clientId": "string",
"resourceUrl": "string",
"secrets": {
"certificate": "string",
"secretsType": "string"
},
"tenantId": "string",
"thumbprint": "string"
For None, use:
"credentialsType": "None"
For Sas, use:
"credentialsType": "Sas",
"secrets": {
"sasToken": "string",
"secretsType": "string"
}
For ServicePrincipal, use:
"credentialsType": "ServicePrincipal",
"authorityUrl": "string",
"clientId": "string",
"resourceUrl": "string",
"secrets": {
"clientSecret": "string",
"secretsType": "string"
},
"tenantId": "string"
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.MachineLearningServices/workspaces/datastores' |
apiVersion | The resource api version | '2023-10-01' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: Maximum 255 characters for datastore name Valid characters: Datastore name consists only of lowercase letters, digits, and underscores. |
properties | [Required] Additional attributes of the entity. | DatastoreProperties (required) |
Name | Description | Value |
---|---|---|
credentials | [Required] Account credentials. | DatastoreCredentials (required) |
description | The asset description text. | string |
properties | The asset property dictionary. | ResourceBaseProperties |
tags | Tag dictionary. Tags can be added, removed, and updated. | object |
datastoreType | Set the object type | AzureBlob AzureDataLakeGen1 AzureDataLakeGen2 AzureFile (required) |
Name | Description | Value |
---|---|---|
credentialsType | Set the object type | AccountKey Certificate None Sas ServicePrincipal (required) |
Name | Description | Value |
---|---|---|
credentialsType | [Required] Credential type used to authentication with storage. | 'AccountKey' (required) |
secrets | [Required] Storage account secrets. | AccountKeyDatastoreSecrets (required) |
Name | Description | Value |
---|---|---|
key | Storage account key. | string |
secretsType | [Required] Credential type used to authentication with storage. | 'AccountKey' 'Certificate' 'Sas' 'ServicePrincipal' (required) |
Name | Description | Value |
---|---|---|
credentialsType | [Required] Credential type used to authentication with storage. | 'Certificate' (required) |
authorityUrl | Authority URL used for authentication. | string |
clientId | [Required] Service principal client ID. | string (required) Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
resourceUrl | Resource the service principal has access to. | string |
secrets | [Required] Service principal secrets. | CertificateDatastoreSecrets (required) |
tenantId | [Required] ID of the tenant to which the service principal belongs. | string (required) Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
thumbprint | [Required] Thumbprint of the certificate used for authentication. | string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
Name | Description | Value |
---|---|---|
certificate | Service principal certificate. | string |
secretsType | [Required] Credential type used to authentication with storage. | 'AccountKey' 'Certificate' 'Sas' 'ServicePrincipal' (required) |
Name | Description | Value |
---|---|---|
credentialsType | [Required] Credential type used to authentication with storage. | 'None' (required) |
Name | Description | Value |
---|---|---|
credentialsType | [Required] Credential type used to authentication with storage. | 'Sas' (required) |
secrets | [Required] Storage container secrets. | SasDatastoreSecrets (required) |
Name | Description | Value |
---|---|---|
sasToken | Storage container SAS token. | string |
secretsType | [Required] Credential type used to authentication with storage. | 'AccountKey' 'Certificate' 'Sas' 'ServicePrincipal' (required) |
Name | Description | Value |
---|---|---|
credentialsType | [Required] Credential type used to authentication with storage. | 'ServicePrincipal' (required) |
authorityUrl | Authority URL used for authentication. | string |
clientId | [Required] Service principal client ID. | string (required) Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
resourceUrl | Resource the service principal has access to. | string |
secrets | [Required] Service principal secrets. | ServicePrincipalDatastoreSecrets (required) |
tenantId | [Required] ID of the tenant to which the service principal belongs. | string (required) Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Name | Description | Value |
---|---|---|
clientSecret | Service principal secret. | string |
secretsType | [Required] Credential type used to authentication with storage. | 'AccountKey' 'Certificate' 'Sas' 'ServicePrincipal' (required) |
Name | Description | Value |
---|---|---|
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string | |
{customized property} | string |
Name | Description | Value |
---|---|---|
datastoreType | [Required] Storage type backing the datastore. | 'AzureBlob' (required) |
accountName | Storage account name. | string |
containerName | Storage account container name. | string |
endpoint | Azure cloud endpoint for the storage account. | string |
protocol | Protocol used to communicate with the storage account. | string |
resourceGroup | Azure Resource Group name | string |
serviceDataAccessAuthIdentity | Indicates which identity to use to authenticate service data access to customer's storage. | 'None' 'WorkspaceSystemAssignedIdentity' 'WorkspaceUserAssignedIdentity' |
subscriptionId | Azure Subscription Id | string |
Name | Description | Value |
---|---|---|
datastoreType | [Required] Storage type backing the datastore. | 'AzureDataLakeGen1' (required) |
resourceGroup | Azure Resource Group name | string |
serviceDataAccessAuthIdentity | Indicates which identity to use to authenticate service data access to customer's storage. | 'None' 'WorkspaceSystemAssignedIdentity' 'WorkspaceUserAssignedIdentity' |
storeName | [Required] Azure Data Lake store name. | string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
subscriptionId | Azure Subscription Id | string |
Name | Description | Value |
---|---|---|
datastoreType | [Required] Storage type backing the datastore. | 'AzureDataLakeGen2' (required) |
accountName | [Required] Storage account name. | string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
endpoint | Azure cloud endpoint for the storage account. | string |
filesystem | [Required] The name of the Data Lake Gen2 filesystem. | string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
protocol | Protocol used to communicate with the storage account. | string |
resourceGroup | Azure Resource Group name | string |
serviceDataAccessAuthIdentity | Indicates which identity to use to authenticate service data access to customer's storage. | 'None' 'WorkspaceSystemAssignedIdentity' 'WorkspaceUserAssignedIdentity' |
subscriptionId | Azure Subscription Id | string |
Name | Description | Value |
---|---|---|
datastoreType | [Required] Storage type backing the datastore. | 'AzureFile' (required) |
accountName | [Required] Storage account name. | string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
endpoint | Azure cloud endpoint for the storage account. | string |
fileShareName | [Required] The name of the Azure file share that the datastore points to. | string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] |
protocol | Protocol used to communicate with the storage account. | string |
resourceGroup | Azure Resource Group name | string |
serviceDataAccessAuthIdentity | Indicates which identity to use to authenticate service data access to customer's storage. | 'None' 'WorkspaceSystemAssignedIdentity' 'WorkspaceUserAssignedIdentity' |
subscriptionId | Azure Subscription Id | string |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Create AML workspace with multiple Datasets & Datastores |
This template creates Azure Machine Learning workspace with multiple datasets & datastores. |
Create an Azure ADLS Datastore |
This template creates a ADLS datastore in Azure Machine Learning workspace. |
Create an Azure ADLS Gen2 Datastore |
This template creates a ADLS Gen2 datastore in Azure Machine Learning workspace. |
Create a Blob Storage Datastore |
This template creates a blob storage datastore in Azure Machine Learning workspace. |
Create a Databricks File System Datastore |
This template creates a Databricks File System datastore in Azure Machine Learning workspace. |
Create a File Share Datastore |
This template creates a file share datastore in Azure Machine Learning workspace. |
Create an Azure MySQL Datastore |
This template creates a MySQL datastore in Azure Machine Learning workspace. |
Create an Azure PostgreSQL Datastore |
This template creates a PostgreSQL datastore in Azure Machine Learning workspace. |
Create an Azure SQL Datastore |
This template creates a SQL datastore in Azure Machine Learning workspace. |