Microsoft.MachineLearningServices workspaces/connections 2023-08-01-preview

• Latest
• 2024-10-01
• 2024-10-01-preview
• 2024-07-01-preview
• 2024-04-01
• 2024-04-01-preview
• 2024-01-01-preview
• 2023-10-01
• 2023-08-01-preview
• 2023-06-01-preview
• 2023-04-01
• 2023-04-01-preview
• 2023-02-01-preview
• 2022-12-01-preview
• 2022-10-01
• 2022-10-01-preview
• 2022-06-01-preview
• 2022-05-01
• 2022-02-01-preview
• 2022-01-01-preview
• 2021-07-01
• 2021-04-01
• 2021-03-01-preview
• 2021-01-01
• 2020-09-01-preview
• 2020-08-01
• 2020-06-01

Bicep resource definition

The workspaces/connections 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/connections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    category: 'string'
    expiryTime: 'string'
    isSharedToAll: bool
    metadata: any(Azure.Bicep.Types.Concrete.AnyType)
    target: 'string'
    authType: 'string'
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 objects

Set the authType property to specify the type of object.

For AccessKey, use:

{
  authType: 'AccessKey'
  credentials: {
    accessKeyId: 'string'
    secretAccessKey: 'string'
  }
}

For ApiKey, use:

{
  authType: 'ApiKey'
  credentials: {
    key: 'string'
  }
}

For CustomKeys, use:

{
  authType: 'CustomKeys'
  credentials: {
    keys: {
      {customized property}: 'string'
    }
  }
}

For ManagedIdentity, use:

{
  authType: 'ManagedIdentity'
  credentials: {
    clientId: 'string'
    resourceId: 'string'
  }
}

For None, use:

{
  authType: 'None'
}

For PAT, use:

{
  authType: 'PAT'
  credentials: {
    pat: 'string'
  }
}

For SAS, use:

{
  authType: 'SAS'
  credentials: {
    sas: 'string'
  }
}

For ServicePrincipal, use:

{
  authType: 'ServicePrincipal'
  credentials: {
    clientId: 'string'
    clientSecret: 'string'
    tenantId: 'string'
  }
}

For UsernamePassword, use:

{
  authType: 'UsernamePassword'
  credentials: {
    password: 'string'
    username: 'string'
  }
}

Property values

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'AccessKey' (required)
credentials		WorkspaceConnectionAccessKey

ApiKeyAuthWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ApiKey' (required)
credentials	Api key object for workspace connection credential.	WorkspaceConnectionApiKey

CustomKeys

Name	Description	Value
keys	Dictionary of <string>	CustomKeys

CustomKeys

Name	Description	Value

CustomKeysWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'CustomKeys' (required)
credentials	Custom Keys credential object	CustomKeys

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ManagedIdentity' (required)
credentials		WorkspaceConnectionManagedIdentity

Microsoft.MachineLearningServices/workspaces/connections

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (required)
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
properties		WorkspaceConnectionPropertiesV2 (required)

NoneAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'None' (required)

PATAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'PAT' (required)
credentials		WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'SAS' (required)
credentials		WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ServicePrincipal' (required)
credentials		WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'UsernamePassword' (required)
credentials		WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

Name	Description	Value
accessKeyId		string
secretAccessKey		string

WorkspaceConnectionApiKey

Name	Description	Value
key		string

WorkspaceConnectionManagedIdentity

Name	Description	Value
clientId		string
resourceId		string

WorkspaceConnectionPersonalAccessToken

Name	Description	Value
pat		string

WorkspaceConnectionPropertiesV2

Name	Description	Value
authType	Set to 'AccessKey' for type AccessKeyAuthTypeWorkspaceConnectionProperties. Set to 'ApiKey' for type ApiKeyAuthWorkspaceConnectionProperties. Set to 'CustomKeys' for type CustomKeysWorkspaceConnectionProperties. Set to 'ManagedIdentity' for type ManagedIdentityAuthTypeWorkspaceConnectionProperties. Set to 'None' for type NoneAuthTypeWorkspaceConnectionProperties. Set to 'PAT' for type PATAuthTypeWorkspaceConnectionProperties. Set to 'SAS' for type SASAuthTypeWorkspaceConnectionProperties. Set to 'ServicePrincipal' for type ServicePrincipalAuthTypeWorkspaceConnectionProperties. Set to 'UsernamePassword' for type UsernamePasswordAuthTypeWorkspaceConnectionProperties.	'AccessKey' 'ApiKey' 'CustomKeys' 'ManagedIdentity' 'None' 'PAT' 'SAS' 'ServicePrincipal' 'UsernamePassword' (required)
category	Category of the connection	'ADLSGen2' 'ApiKey' 'AzureMySqlDb' 'AzureOpenAI' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'CognitiveSearch' 'CognitiveService' 'ContainerRegistry' 'CustomKeys' 'Git' 'PythonFeed' 'Redis' 'S3' 'Snowflake'
expiryTime		string
isSharedToAll	whether this connection will be shared to all the project workspace under the hub	bool
metadata	Any object	any
target		string

WorkspaceConnectionServicePrincipal

Name	Description	Value
clientId		string
clientSecret		string
tenantId		string

WorkspaceConnectionSharedAccessSignature

Name	Description	Value
sas		string

WorkspaceConnectionUsernamePassword

Name	Description	Value
password		string
username		string

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Azure AI Studio basic setup	This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio basic setup	This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio basic setup	This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio Network Restricted	This set of templates demonstrates how to set up Azure AI Studio with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio Network Restricted	This set of templates demonstrates how to set up Azure AI Studio with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio with Microsoft Entra ID Authentication	This set of templates demonstrates how to set up Azure AI Studio with Microsoft Entra ID authentication for dependent resources, such as Azure AI Services and Azure Storage.
Deploy Secure Azure AI Studio with a managed virtual network	This template creates a secure Azure AI Studio environment with robust network and identity security restrictions.

ARM template resource definition

The workspaces/connections 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/connections resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "properties": {
    "category": "string",
    "expiryTime": "string",
    "isSharedToAll": "bool",
    "metadata": {},
    "target": "string",
    "authType": "string"
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 objects

Set the authType property to specify the type of object.

For AccessKey, use:

{
  "authType": "AccessKey",
  "credentials": {
    "accessKeyId": "string",
    "secretAccessKey": "string"
  }
}

For ApiKey, use:

{
  "authType": "ApiKey",
  "credentials": {
    "key": "string"
  }
}

For CustomKeys, use:

{
  "authType": "CustomKeys",
  "credentials": {
    "keys": {
      "{customized property}": "string"
    }
  }
}

For ManagedIdentity, use:

{
  "authType": "ManagedIdentity",
  "credentials": {
    "clientId": "string",
    "resourceId": "string"
  }
}

For None, use:

{
  "authType": "None"
}

For PAT, use:

{
  "authType": "PAT",
  "credentials": {
    "pat": "string"
  }
}

For SAS, use:

{
  "authType": "SAS",
  "credentials": {
    "sas": "string"
  }
}

For ServicePrincipal, use:

{
  "authType": "ServicePrincipal",
  "credentials": {
    "clientId": "string",
    "clientSecret": "string",
    "tenantId": "string"
  }
}

For UsernamePassword, use:

{
  "authType": "UsernamePassword",
  "credentials": {
    "password": "string",
    "username": "string"
  }
}

Property values

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'AccessKey' (required)
credentials		WorkspaceConnectionAccessKey

ApiKeyAuthWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ApiKey' (required)
credentials	Api key object for workspace connection credential.	WorkspaceConnectionApiKey

CustomKeys

Name	Description	Value
keys	Dictionary of <string>	CustomKeys

CustomKeys

Name	Description	Value

CustomKeysWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'CustomKeys' (required)
credentials	Custom Keys credential object	CustomKeys

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ManagedIdentity' (required)
credentials		WorkspaceConnectionManagedIdentity

Microsoft.MachineLearningServices/workspaces/connections

Name	Description	Value
apiVersion	The api version	'2023-08-01-preview'
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (required)
properties		WorkspaceConnectionPropertiesV2 (required)
type	The resource type	'Microsoft.MachineLearningServices/workspaces/connections'

NoneAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'None' (required)

PATAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'PAT' (required)
credentials		WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'SAS' (required)
credentials		WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ServicePrincipal' (required)
credentials		WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'UsernamePassword' (required)
credentials		WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

Name	Description	Value
accessKeyId		string
secretAccessKey		string

WorkspaceConnectionApiKey

Name	Description	Value
key		string

WorkspaceConnectionManagedIdentity

Name	Description	Value
clientId		string
resourceId		string

WorkspaceConnectionPersonalAccessToken

Name	Description	Value
pat		string

WorkspaceConnectionPropertiesV2

Name	Description	Value
authType	Set to 'AccessKey' for type AccessKeyAuthTypeWorkspaceConnectionProperties. Set to 'ApiKey' for type ApiKeyAuthWorkspaceConnectionProperties. Set to 'CustomKeys' for type CustomKeysWorkspaceConnectionProperties. Set to 'ManagedIdentity' for type ManagedIdentityAuthTypeWorkspaceConnectionProperties. Set to 'None' for type NoneAuthTypeWorkspaceConnectionProperties. Set to 'PAT' for type PATAuthTypeWorkspaceConnectionProperties. Set to 'SAS' for type SASAuthTypeWorkspaceConnectionProperties. Set to 'ServicePrincipal' for type ServicePrincipalAuthTypeWorkspaceConnectionProperties. Set to 'UsernamePassword' for type UsernamePasswordAuthTypeWorkspaceConnectionProperties.	'AccessKey' 'ApiKey' 'CustomKeys' 'ManagedIdentity' 'None' 'PAT' 'SAS' 'ServicePrincipal' 'UsernamePassword' (required)
category	Category of the connection	'ADLSGen2' 'ApiKey' 'AzureMySqlDb' 'AzureOpenAI' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'CognitiveSearch' 'CognitiveService' 'ContainerRegistry' 'CustomKeys' 'Git' 'PythonFeed' 'Redis' 'S3' 'Snowflake'
expiryTime		string
isSharedToAll	whether this connection will be shared to all the project workspace under the hub	bool
metadata	Any object	any
target		string

WorkspaceConnectionServicePrincipal

Name	Description	Value
clientId		string
clientSecret		string
tenantId		string

WorkspaceConnectionSharedAccessSignature

Name	Description	Value
sas		string

WorkspaceConnectionUsernamePassword

Name	Description	Value
password		string
username		string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure AI Studio basic setup	This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio basic setup	This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio basic setup	This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio Network Restricted	This set of templates demonstrates how to set up Azure AI Studio with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio Network Restricted	This set of templates demonstrates how to set up Azure AI Studio with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource.
Azure AI Studio with Microsoft Entra ID Authentication	This set of templates demonstrates how to set up Azure AI Studio with Microsoft Entra ID authentication for dependent resources, such as Azure AI Services and Azure Storage.
Deploy Secure Azure AI Studio with a managed virtual network	This template creates a secure Azure AI Studio environment with robust network and identity security restrictions.

Terraform (AzAPI provider) resource definition

The workspaces/connections 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/connections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      category = "string"
      expiryTime = "string"
      isSharedToAll = bool
      metadata = ?
      target = "string"
      authType = "string"
      // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
    }
  })
}

WorkspaceConnectionPropertiesV2 objects

Set the authType property to specify the type of object.

For AccessKey, use:

{
  authType = "AccessKey"
  credentials = {
    accessKeyId = "string"
    secretAccessKey = "string"
  }
}

For ApiKey, use:

{
  authType = "ApiKey"
  credentials = {
    key = "string"
  }
}

For CustomKeys, use:

{
  authType = "CustomKeys"
  credentials = {
    keys = {
      {customized property} = "string"
    }
  }
}

For ManagedIdentity, use:

{
  authType = "ManagedIdentity"
  credentials = {
    clientId = "string"
    resourceId = "string"
  }
}

For None, use:

{
  authType = "None"
}

For PAT, use:

{
  authType = "PAT"
  credentials = {
    pat = "string"
  }
}

For SAS, use:

{
  authType = "SAS"
  credentials = {
    sas = "string"
  }
}

For ServicePrincipal, use:

{
  authType = "ServicePrincipal"
  credentials = {
    clientId = "string"
    clientSecret = "string"
    tenantId = "string"
  }
}

For UsernamePassword, use:

{
  authType = "UsernamePassword"
  credentials = {
    password = "string"
    username = "string"
  }
}

Property values

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'AccessKey' (required)
credentials		WorkspaceConnectionAccessKey

ApiKeyAuthWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ApiKey' (required)
credentials	Api key object for workspace connection credential.	WorkspaceConnectionApiKey

CustomKeys

Name	Description	Value
keys	Dictionary of <string>	CustomKeys

CustomKeys

Name	Description	Value

CustomKeysWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'CustomKeys' (required)
credentials	Custom Keys credential object	CustomKeys

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ManagedIdentity' (required)
credentials		WorkspaceConnectionManagedIdentity

Microsoft.MachineLearningServices/workspaces/connections

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: workspaces
properties		WorkspaceConnectionPropertiesV2 (required)
type	The resource type	"Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview"

NoneAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'None' (required)

PATAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'PAT' (required)
credentials		WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'SAS' (required)
credentials		WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'ServicePrincipal' (required)
credentials		WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'UsernamePassword' (required)
credentials		WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

Name	Description	Value
accessKeyId		string
secretAccessKey		string

WorkspaceConnectionApiKey

Name	Description	Value
key		string

WorkspaceConnectionManagedIdentity

Name	Description	Value
clientId		string
resourceId		string

WorkspaceConnectionPersonalAccessToken

Name	Description	Value
pat		string

WorkspaceConnectionPropertiesV2

Name	Description	Value
authType	Set to 'AccessKey' for type AccessKeyAuthTypeWorkspaceConnectionProperties. Set to 'ApiKey' for type ApiKeyAuthWorkspaceConnectionProperties. Set to 'CustomKeys' for type CustomKeysWorkspaceConnectionProperties. Set to 'ManagedIdentity' for type ManagedIdentityAuthTypeWorkspaceConnectionProperties. Set to 'None' for type NoneAuthTypeWorkspaceConnectionProperties. Set to 'PAT' for type PATAuthTypeWorkspaceConnectionProperties. Set to 'SAS' for type SASAuthTypeWorkspaceConnectionProperties. Set to 'ServicePrincipal' for type ServicePrincipalAuthTypeWorkspaceConnectionProperties. Set to 'UsernamePassword' for type UsernamePasswordAuthTypeWorkspaceConnectionProperties.	'AccessKey' 'ApiKey' 'CustomKeys' 'ManagedIdentity' 'None' 'PAT' 'SAS' 'ServicePrincipal' 'UsernamePassword' (required)
category	Category of the connection	'ADLSGen2' 'ApiKey' 'AzureMySqlDb' 'AzureOpenAI' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'CognitiveSearch' 'CognitiveService' 'ContainerRegistry' 'CustomKeys' 'Git' 'PythonFeed' 'Redis' 'S3' 'Snowflake'
expiryTime		string
isSharedToAll	whether this connection will be shared to all the project workspace under the hub	bool
metadata	Any object	any
target		string

WorkspaceConnectionServicePrincipal

Name	Description	Value
clientId		string
clientSecret		string
tenantId		string

WorkspaceConnectionSharedAccessSignature

Name	Description	Value
sas		string

WorkspaceConnectionUsernamePassword

Name	Description	Value
password		string
username		string