Microsoft.MachineLearningServices workspaces/datastores 2021-03-01-preview

Article
12/09/2024

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@2021-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    contents: {
      contentsType: 'string'
      // For remaining properties, see DatastoreContents objects
    }
    description: 'string'
    isDefault: bool
    linkedInfo: {
      linkedId: 'string'
      linkedResourceName: 'string'
      origin: 'string'
    }
    properties: {
      {customized property}: 'string'
    }
    tags: {
      {customized property}: 'string'
    }
  }
}

DatastoreCredentials objects

Set the credentialsType property to specify the type of object.

For AccountKey, use:

{
  credentialsType: 'AccountKey'
  secrets: {
    key: 'string'
    secretsType: 'string'
  }
}

For Certificate, use:

{
  authorityUrl: 'string'
  clientId: 'string'
  credentialsType: 'Certificate'
  resourceUri: 'string'
  secrets: {
    certificate: 'string'
    secretsType: 'string'
  }
  tenantId: 'string'
  thumbprint: 'string'
}

For None, use:

{
  credentialsType: 'None'
  secrets: {
    secretsType: 'string'
  }
}

For Sas, use:

{
  credentialsType: 'Sas'
  secrets: {
    sasToken: 'string'
    secretsType: 'string'
  }
}

For ServicePrincipal, use:

{
  authorityUrl: 'string'
  clientId: 'string'
  credentialsType: 'ServicePrincipal'
  resourceUri: 'string'
  secrets: {
    clientSecret: 'string'
    secretsType: 'string'
  }
  tenantId: 'string'
}

For SqlAdmin, use:

{
  credentialsType: 'SqlAdmin'
  secrets: {
    password: 'string'
    secretsType: 'string'
  }
  userId: 'string'
}

DatastoreContents objects

Set the contentsType property to specify the type of object.

For AzureBlob, use:

{
  accountName: 'string'
  containerName: 'string'
  contentsType: 'AzureBlob'
  credentials: {
    credentialsType: 'string'
    // For remaining properties, see DatastoreCredentials objects
  }
  endpoint: 'string'
  protocol: 'string'
}

For AzureDataLakeGen1, use:

{
  contentsType: 'AzureDataLakeGen1'
  credentials: {
    credentialsType: 'string'
    // For remaining properties, see DatastoreCredentials objects
  }
  storeName: 'string'
}

For AzureDataLakeGen2, use:

{
  accountName: 'string'
  containerName: 'string'
  contentsType: 'AzureDataLakeGen2'
  credentials: {
    credentialsType: 'string'
    // For remaining properties, see DatastoreCredentials objects
  }
  endpoint: 'string'
  protocol: 'string'
}

For AzureFile, use:

{
  accountName: 'string'
  containerName: 'string'
  contentsType: 'AzureFile'
  credentials: {
    credentialsType: 'string'
    // For remaining properties, see DatastoreCredentials objects
  }
  endpoint: 'string'
  protocol: 'string'
}

For AzurePostgreSql, use:

{
  contentsType: 'AzurePostgreSql'
  credentials: {
    credentialsType: 'string'
    // For remaining properties, see DatastoreCredentials objects
  }
  databaseName: 'string'
  enableSSL: bool
  endpoint: 'string'
  portNumber: int
  serverName: 'string'
}

For AzureSqlDatabase, use:

{
  contentsType: 'AzureSqlDatabase'
  credentials: {
    credentialsType: 'string'
    // For remaining properties, see DatastoreCredentials objects
  }
  databaseName: 'string'
  endpoint: 'string'
  portNumber: int
  serverName: 'string'
}

For GlusterFs, use:

{
  contentsType: 'GlusterFs'
  serverAddress: 'string'
  volumeName: 'string'
}

Property values

AccountKeyDatastoreCredentials

Name	Description	Value
credentialsType	[Required] Credential type used to authentication with storage.	'AccountKey' (required)
secrets	Storage account secrets.	AccountKeyDatastoreSecrets

AccountKeyDatastoreSecrets

Name	Description	Value
key	Storage account key.	string
secretsType	[Required] Credential type used to authentication with storage.	'AccountKey' 'Certificate' 'None' 'Sas' 'ServicePrincipal' 'SqlAdmin' (required)

AzureBlobContents

Name	Description	Value
accountName	[Required] Storage account name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
containerName	[Required] Storage account container name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
contentsType	[Required] Storage type backing the datastore.	'AzureBlob' (required)
credentials	[Required] Account credentials.	DatastoreCredentials (required)
endpoint	[Required] Azure cloud endpoint for the storage account.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
protocol	[Required] Protocol used to communicate with the storage account.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

AzureDataLakeGen1Contents

Name	Description	Value
contentsType	[Required] Storage type backing the datastore.	'AzureDataLakeGen1' (required)
credentials	[Required] Account credentials.	DatastoreCredentials (required)
storeName	[Required] Azure Data Lake store name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

AzureDataLakeGen2Contents

Name	Description	Value
accountName	[Required] Storage account name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
containerName	[Required] Storage account container name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
contentsType	[Required] Storage type backing the datastore.	'AzureDataLakeGen2' (required)
credentials	[Required] Account credentials.	DatastoreCredentials (required)
endpoint	[Required] Azure cloud endpoint for the storage account.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
protocol	[Required] Protocol used to communicate with the storage account.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

AzureFileContents

Name	Description	Value
accountName	[Required] Storage account name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
containerName	[Required] Storage account container name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
contentsType	[Required] Storage type backing the datastore.	'AzureFile' (required)
credentials	[Required] Account credentials.	DatastoreCredentials (required)
endpoint	[Required] Azure cloud endpoint for the storage account.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
protocol	[Required] Protocol used to communicate with the storage account.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

AzurePostgreSqlContents

Name	Description	Value
contentsType	[Required] Storage type backing the datastore.	'AzurePostgreSql' (required)
credentials	[Required] Account credentials.	DatastoreCredentials (required)
databaseName	[Required] Azure SQL database name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
enableSSL	Whether the Azure PostgreSQL server requires SSL.	bool
endpoint	[Required] Azure cloud endpoint for the database.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
portNumber	[Required] Azure SQL server port.	int (required)
serverName	[Required] Azure SQL server name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

AzureSqlDatabaseContents

Name	Description	Value
contentsType	[Required] Storage type backing the datastore.	'AzureSqlDatabase' (required)
credentials	[Required] Account credentials.	DatastoreCredentials (required)
databaseName	[Required] Azure SQL database name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
endpoint	[Required] Azure cloud endpoint for the database.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
portNumber	[Required] Azure SQL server port.	int (required)
serverName	[Required] Azure SQL server name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

CertificateDatastoreCredentials

Name	Description	Value
authorityUrl	Authority URL used for authentication.	string
clientId	[Required] Service principal client ID.	string Constraints: Min length = 36 Max length = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (required)
credentialsType	[Required] Credential type used to authentication with storage.	'Certificate' (required)
resourceUri	Resource the service principal has access to.	string
secrets	Service principal secrets.	CertificateDatastoreSecrets
tenantId	[Required] ID of the tenant to which the service principal belongs.	string Constraints: Min length = 36 Max length = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (required)
thumbprint	[Required] Thumbprint of the certificate used for authentication.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

CertificateDatastoreSecrets

Name	Description	Value
certificate	Service principal certificate.	string
secretsType	[Required] Credential type used to authentication with storage.	'AccountKey' 'Certificate' 'None' 'Sas' 'ServicePrincipal' 'SqlAdmin' (required)

DatastoreContents

Name	Description	Value
contentsType	Set to 'AzureBlob' for type AzureBlobContents. Set to 'AzureDataLakeGen1' for type AzureDataLakeGen1Contents. Set to 'AzureDataLakeGen2' for type AzureDataLakeGen2Contents. Set to 'AzureFile' for type AzureFileContents. Set to 'AzurePostgreSql' for type AzurePostgreSqlContents. Set to 'AzureSqlDatabase' for type AzureSqlDatabaseContents. Set to 'GlusterFs' for type GlusterFsContents.	'AzureBlob' 'AzureDataLakeGen1' 'AzureDataLakeGen2' 'AzureFile' 'AzurePostgreSql' 'AzureSqlDatabase' 'GlusterFs' (required)

DatastoreCredentials

Name	Description	Value
credentialsType	Set to 'AccountKey' for type AccountKeyDatastoreCredentials. Set to 'Certificate' for type CertificateDatastoreCredentials. Set to 'None' for type NoneDatastoreCredentials. Set to 'Sas' for type SasDatastoreCredentials. Set to 'ServicePrincipal' for type ServicePrincipalDatastoreCredentials. Set to 'SqlAdmin' for type SqlAdminDatastoreCredentials.	'AccountKey' 'Certificate' 'None' 'Sas' 'ServicePrincipal' 'SqlAdmin' (required)

DatastoreProperties

Name	Description	Value
contents	[Required] Reference to the datastore storage contents.	DatastoreContents (required)
description	The asset description text.	string
isDefault	Whether this datastore is the default for the workspace.	bool
linkedInfo	Information about the datastore origin, if linked.	LinkedInfo
properties	The asset property dictionary.	DatastoreProperties
tags	Tag dictionary. Tags can be added, removed, and updated.	DatastorePropertiesTags

DatastoreProperties

Name	Description	Value

DatastorePropertiesTags

Name	Description	Value

GlusterFsContents

Name	Description	Value
contentsType	[Required] Storage type backing the datastore.	'GlusterFs' (required)
serverAddress	[Required] GlusterFS server address (can be the IP address or server name).	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
volumeName	[Required] GlusterFS volume name.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

LinkedInfo

Name	Description	Value
linkedId	Linked service ID.	string
linkedResourceName	Linked service resource name.	string
origin	Type of the linked service.	'Synapse'