Microsoft.MachineLearningServices workspaces/datastores 2020-05-01-preview
Bicep resource definition
The workspaces/datastores resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.MachineLearningServices/workspaces/datastores resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/datastores@2020-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
accountKey: 'string'
accountName: 'string'
adlsResourceGroup: 'string'
adlsSubscriptionId: 'string'
authorityUrl: 'string'
clientId: 'string'
clientSecret: 'string'
containerName: 'string'
databaseName: 'string'
dataStoreType: 'string'
description: 'string'
endpoint: 'string'
enforceSSL: bool
fileSystem: 'string'
includeSecret: bool
password: 'string'
port: 'string'
protocol: 'string'
resourceUrl: 'string'
sasToken: 'string'
serverName: 'string'
shareName: 'string'
skipValidation: bool
storageAccountResourceGroup: 'string'
storageAccountSubscriptionId: 'string'
storeName: 'string'
tenantId: 'string'
userId: 'string'
userName: 'string'
workspaceSystemAssignedIdentity: bool
}
Property values
workspaces/datastores
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: Maximum 255 characters for datastore name Valid characters: Datastore name consists only of lowercase letters, digits, and underscores. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: workspaces |
| accountKey | Account Key of storage account. | string |
| accountName | The name of the storage account. | string |
| adlsResourceGroup | The resource group the ADLS store belongs to. Defaults to selected resource group. | string |
| adlsSubscriptionId | The ID of the subscription the ADLS store belongs to. Defaults to selected subscription. | string |
| authorityUrl | Authority url used to authenticate the user. | string |
| clientId | The service principal's client/application ID. | string |
| clientSecret | The service principal's secret. | string |
| containerName | The name of the azure blob container. | string |
| databaseName | The database name. | string |
| dataStoreType | Specifies datastore type. | 'adls' 'adls-gen2' 'blob' 'dbfs' 'file' 'mysqldb' 'psqldb' 'sqldb' (required) |
| description | The description of the datastore. | string |
| endpoint | The endpoint of the server. | string |
| enforceSSL | This sets the ssl value of the server. Defaults to true if not set. | bool |
| fileSystem | The file system name of the ADLS Gen2. | string |
| includeSecret | Include datastore secret in response. | bool |
| password | The password. | string |
| port | The port number. | string |
| protocol | The protocol to be used | string |
| resourceUrl | Determines what operations will be performed. | string |
| sasToken | Sas Token of storage account. | string |
| serverName | The SQL/MySQL/PostgreSQL server name | string |
| shareName | The name of the file share. | string |
| skipValidation | Skip validation that ensures data can be loaded from the dataset before registration. | bool |
| storageAccountResourceGroup | The resource group of the storage account. Defaults to selected resource group | string |
| storageAccountSubscriptionId | The subscription ID of the storage account. Defaults to selected subscription | string |
| storeName | The ADLS store name. | string |
| tenantId | The service principal Tenant ID. | string |
| userId | The user ID. | string |
| userName | The username of the database user. | string |
| workspaceSystemAssignedIdentity | If set to true, datastore support data access authenticated with Workspace MSI. | bool |
Quickstart templates
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. |
ARM template resource definition
The workspaces/datastores resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.MachineLearningServices/workspaces/datastores resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/datastores",
"apiVersion": "2020-05-01-preview",
"name": "string",
"accountKey": "string",
"accountName": "string",
"adlsResourceGroup": "string",
"adlsSubscriptionId": "string",
"authorityUrl": "string",
"clientId": "string",
"clientSecret": "string",
"containerName": "string",
"databaseName": "string",
"dataStoreType": "string",
"description": "string",
"endpoint": "string",
"enforceSSL": "bool",
"fileSystem": "string",
"includeSecret": "bool",
"password": "string",
"port": "string",
"protocol": "string",
"resourceUrl": "string",
"sasToken": "string",
"serverName": "string",
"shareName": "string",
"skipValidation": "bool",
"storageAccountResourceGroup": "string",
"storageAccountSubscriptionId": "string",
"storeName": "string",
"tenantId": "string",
"userId": "string",
"userName": "string",
"workspaceSystemAssignedIdentity": "bool"
}
Property values
workspaces/datastores
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.MachineLearningServices/workspaces/datastores' |
| apiVersion | The resource api version | '2020-05-01-preview' |
| 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. |
| accountKey | Account Key of storage account. | string |
| accountName | The name of the storage account. | string |
| adlsResourceGroup | The resource group the ADLS store belongs to. Defaults to selected resource group. | string |
| adlsSubscriptionId | The ID of the subscription the ADLS store belongs to. Defaults to selected subscription. | string |
| authorityUrl | Authority url used to authenticate the user. | string |
| clientId | The service principal's client/application ID. | string |
| clientSecret | The service principal's secret. | string |
| containerName | The name of the azure blob container. | string |
| databaseName | The database name. | string |
| dataStoreType | Specifies datastore type. | 'adls' 'adls-gen2' 'blob' 'dbfs' 'file' 'mysqldb' 'psqldb' 'sqldb' (required) |
| description | The description of the datastore. | string |
| endpoint | The endpoint of the server. | string |
| enforceSSL | This sets the ssl value of the server. Defaults to true if not set. | bool |
| fileSystem | The file system name of the ADLS Gen2. | string |
| includeSecret | Include datastore secret in response. | bool |
| password | The password. | string |
| port | The port number. | string |
| protocol | The protocol to be used | string |
| resourceUrl | Determines what operations will be performed. | string |
| sasToken | Sas Token of storage account. | string |
| serverName | The SQL/MySQL/PostgreSQL server name | string |
| shareName | The name of the file share. | string |
| skipValidation | Skip validation that ensures data can be loaded from the dataset before registration. | bool |
| storageAccountResourceGroup | The resource group of the storage account. Defaults to selected resource group | string |
| storageAccountSubscriptionId | The subscription ID of the storage account. Defaults to selected subscription | string |
| storeName | The ADLS store name. | string |
| tenantId | The service principal Tenant ID. | string |
| userId | The user ID. | string |
| userName | The username of the database user. | string |
| workspaceSystemAssignedIdentity | If set to true, datastore support data access authenticated with Workspace MSI. | bool |
Quickstart templates
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. |
Terraform (AzAPI provider) resource definition
The workspaces/datastores resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.MachineLearningServices/workspaces/datastores resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/datastores@2020-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
accountKey = "string"
accountName = "string"
adlsResourceGroup = "string"
adlsSubscriptionId = "string"
authorityUrl = "string"
clientId = "string"
clientSecret = "string"
containerName = "string"
databaseName = "string"
dataStoreType = "string"
description = "string"
endpoint = "string"
enforceSSL = bool
fileSystem = "string"
includeSecret = bool
password = "string"
port = "string"
protocol = "string"
resourceUrl = "string"
sasToken = "string"
serverName = "string"
shareName = "string"
skipValidation = bool
storageAccountResourceGroup = "string"
storageAccountSubscriptionId = "string"
storeName = "string"
tenantId = "string"
userId = "string"
userName = "string"
workspaceSystemAssignedIdentity = bool
})
}
Property values
workspaces/datastores
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.MachineLearningServices/workspaces/datastores@2020-05-01-preview" |
| name | The resource name | string (required) Character limit: Maximum 255 characters for datastore name Valid characters: Datastore name consists only of lowercase letters, digits, and underscores. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| accountKey | Account Key of storage account. | string |
| accountName | The name of the storage account. | string |
| adlsResourceGroup | The resource group the ADLS store belongs to. Defaults to selected resource group. | string |
| adlsSubscriptionId | The ID of the subscription the ADLS store belongs to. Defaults to selected subscription. | string |
| authorityUrl | Authority url used to authenticate the user. | string |
| clientId | The service principal's client/application ID. | string |
| clientSecret | The service principal's secret. | string |
| containerName | The name of the azure blob container. | string |
| databaseName | The database name. | string |
| dataStoreType | Specifies datastore type. | "adls" "adls-gen2" "blob" "dbfs" "file" "mysqldb" "psqldb" "sqldb" (required) |
| description | The description of the datastore. | string |
| endpoint | The endpoint of the server. | string |
| enforceSSL | This sets the ssl value of the server. Defaults to true if not set. | bool |
| fileSystem | The file system name of the ADLS Gen2. | string |
| includeSecret | Include datastore secret in response. | bool |
| password | The password. | string |
| port | The port number. | string |
| protocol | The protocol to be used | string |
| resourceUrl | Determines what operations will be performed. | string |
| sasToken | Sas Token of storage account. | string |
| serverName | The SQL/MySQL/PostgreSQL server name | string |
| shareName | The name of the file share. | string |
| skipValidation | Skip validation that ensures data can be loaded from the dataset before registration. | bool |
| storageAccountResourceGroup | The resource group of the storage account. Defaults to selected resource group | string |
| storageAccountSubscriptionId | The subscription ID of the storage account. Defaults to selected subscription | string |
| storeName | The ADLS store name. | string |
| tenantId | The service principal Tenant ID. | string |
| userId | The user ID. | string |
| userName | The username of the database user. | string |
| workspaceSystemAssignedIdentity | If set to true, datastore support data access authenticated with Workspace MSI. | bool |
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