Microsoft.MachineLearningServices workspaces/connections

Article
11/21/2024

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@2024-10-01' = {
  name: 'string'
  properties: {
    category: 'string'
    expiryTime: 'string'
    isSharedToAll: bool
    metadata: {
      {customized property}: 'string'
    }
    sharedUserList: [
      'string'
    ]
    target: 'string'
    value: 'string'
    valueFormat: 'string'
    authType: 'string'
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 objects

Set the authType property to specify the type of object.

For AAD, use:

{
  authType: 'AAD'
}

For AccessKey, use:

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

For AccountKey, use:

{
  authType: 'AccountKey'
  credentials: {
    key: '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 OAuth2, use:

{
  authType: 'OAuth2'
  credentials: {
    authUrl: 'string'
    clientId: 'string'
    clientSecret: 'string'
    developerToken: 'string'
    password: 'string'
    refreshToken: 'string'
    tenantId: 'string'
    username: 'string'
  }
}

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'
    securityToken: 'string'
    username: 'string'
  }
}

Property values

AADAuthTypeWorkspaceConnectionProperties

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

AccessKeyAuthTypeWorkspaceConnectionProperties

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

AccountKeyAuthTypeWorkspaceConnectionProperties

Name	Description	Value
authType	Authentication type of the connection target	'AccountKey' (required)
credentials		WorkspaceConnectionAccountKey

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