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

Bicep resource definition

The workspaces/connections resource type can be deployed with operations that target:

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-02-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    category: 'string'
    target: 'string'
    value: 'string'
    valueFormat: 'JSON'
    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 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

workspaces/connections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (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)

WorkspaceConnectionPropertiesV2

Name Description Value
category Category of the connection 'AzureDataLakeGen2'
'AzureMySqlDb'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'ContainerRegistry'
'FeatureStore'
'Git'
'PythonFeed'
'Redis'
'S3'
'Snowflake'
target string
value Value details of the workspace connection. string
valueFormat format for the workspace connection value 'JSON'
authType Set the object type AccessKey
ManagedIdentity
None
PAT
SAS
ServicePrincipal
UsernamePassword (required)

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

Name Description Value
accessKeyId string
secretAccessKey string

Constraints:
Sensitive value. Pass in as a secure parameter.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionManagedIdentity

Name Description Value
clientId string
resourceId string

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

WorkspaceConnectionPersonalAccessToken

Name Description Value
pat string

SASAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionSharedAccessSignature

Name Description Value
sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

Name Description Value
clientId string
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

Name Description Value
password string
username string

ARM template resource definition

The workspaces/connections resource type can be deployed with operations that target:

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-02-01-preview",
  "name": "string",
  "properties": {
    "category": "string",
    "target": "string",
    "value": "string",
    "valueFormat": "JSON",
    "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 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

workspaces/connections

Name Description Value
type The resource type 'Microsoft.MachineLearningServices/workspaces/connections'
apiVersion The resource api version '2023-02-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties WorkspaceConnectionPropertiesV2 (required)

WorkspaceConnectionPropertiesV2

Name Description Value
category Category of the connection 'AzureDataLakeGen2'
'AzureMySqlDb'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'ContainerRegistry'
'FeatureStore'
'Git'
'PythonFeed'
'Redis'
'S3'
'Snowflake'
target string
value Value details of the workspace connection. string
valueFormat format for the workspace connection value 'JSON'
authType Set the object type AccessKey
ManagedIdentity
None
PAT
SAS
ServicePrincipal
UsernamePassword (required)

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

Name Description Value
accessKeyId string
secretAccessKey string

Constraints:
Sensitive value. Pass in as a secure parameter.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionManagedIdentity

Name Description Value
clientId string
resourceId string

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

WorkspaceConnectionPersonalAccessToken

Name Description Value
pat string

SASAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionSharedAccessSignature

Name Description Value
sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

Name Description Value
clientId string
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

Name Description Value
password string
username string

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-02-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      category = "string"
      target = "string"
      value = "string"
      valueFormat = "JSON"
      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 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

workspaces/connections

Name Description Value
type The resource type "Microsoft.MachineLearningServices/workspaces/connections@2023-02-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties WorkspaceConnectionPropertiesV2 (required)

WorkspaceConnectionPropertiesV2

Name Description Value
category Category of the connection "AzureDataLakeGen2"
"AzureMySqlDb"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"ContainerRegistry"
"FeatureStore"
"Git"
"PythonFeed"
"Redis"
"S3"
"Snowflake"
target string
value Value details of the workspace connection. string
valueFormat format for the workspace connection value "JSON"
authType Set the object type AccessKey
ManagedIdentity
None
PAT
SAS
ServicePrincipal
UsernamePassword (required)

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

Name Description Value
accessKeyId string
secretAccessKey string

Constraints:
Sensitive value. Pass in as a secure parameter.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionManagedIdentity

Name Description Value
clientId string
resourceId string

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

WorkspaceConnectionPersonalAccessToken

Name Description Value
pat string

SASAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionSharedAccessSignature

Name Description Value
sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

Name Description Value
clientId string
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

Name Description Value
password string
username string