Microsoft.MachineLearningServices workspaces/connections 2023-06-01-preview
- Latest
- 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-06-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
category: 'string'
expiryTime: 'string'
metadata: any()
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
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 | 'ADLSGen2' 'ApiKey' 'AzureMySqlDb' 'AzureOpenAI' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'CognitiveSearch' 'CognitiveService' 'ContainerRegistry' 'CustomKeys' 'Git' 'PythonFeed' 'Redis' 'S3' 'Snowflake' |
expiryTime | string | |
metadata | Any object | For Bicep, you can use the any() function. |
target | string | |
authType | Set the object type | AccessKey ApiKey CustomKeys 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 |
ApiKeyAuthWorkspaceConnectionProperties
Name | Description | Value |
---|---|---|
authType | Authentication type of the connection target | 'ApiKey' (required) |
credentials | Api key object for workspace connection credential. | WorkspaceConnectionApiKey |
WorkspaceConnectionApiKey
Name | Description | Value |
---|---|---|
key | string |
CustomKeysWorkspaceConnectionProperties
Name | Description | Value |
---|---|---|
authType | Authentication type of the connection target | 'CustomKeys' (required) |
credentials | Custom Keys credential object | CustomKeys |
CustomKeys
Name | Description | Value |
---|---|---|
keys | Dictionary of {string} | CustomKeys |
{customized property} | string |
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 | |
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:
- 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-06-01-preview",
"name": "string",
"properties": {
"category": "string",
"expiryTime": "string",
"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
workspaces/connections
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.MachineLearningServices/workspaces/connections' |
apiVersion | The resource api version | '2023-06-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 | 'ADLSGen2' 'ApiKey' 'AzureMySqlDb' 'AzureOpenAI' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'CognitiveSearch' 'CognitiveService' 'ContainerRegistry' 'CustomKeys' 'Git' 'PythonFeed' 'Redis' 'S3' 'Snowflake' |
expiryTime | string | |
metadata | Any object | |
target | string | |
authType | Set the object type | AccessKey ApiKey CustomKeys 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 |
ApiKeyAuthWorkspaceConnectionProperties
Name | Description | Value |
---|---|---|
authType | Authentication type of the connection target | 'ApiKey' (required) |
credentials | Api key object for workspace connection credential. | WorkspaceConnectionApiKey |
WorkspaceConnectionApiKey
Name | Description | Value |
---|---|---|
key | string |
CustomKeysWorkspaceConnectionProperties
Name | Description | Value |
---|---|---|
authType | Authentication type of the connection target | 'CustomKeys' (required) |
credentials | Custom Keys credential object | CustomKeys |
CustomKeys
Name | Description | Value |
---|---|---|
keys | Dictionary of {string} | CustomKeys |
{customized property} | string |
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 | |
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-06-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
category = "string"
expiryTime = "string"
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
workspaces/connections
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.MachineLearningServices/workspaces/connections@2023-06-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 | "ADLSGen2" "ApiKey" "AzureMySqlDb" "AzureOpenAI" "AzurePostgresDb" "AzureSqlDb" "AzureSynapseAnalytics" "CognitiveSearch" "CognitiveService" "ContainerRegistry" "CustomKeys" "Git" "PythonFeed" "Redis" "S3" "Snowflake" |
expiryTime | string | |
metadata | Any object | |
target | string | |
authType | Set the object type | AccessKey ApiKey CustomKeys 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 |
ApiKeyAuthWorkspaceConnectionProperties
Name | Description | Value |
---|---|---|
authType | Authentication type of the connection target | "ApiKey" (required) |
credentials | Api key object for workspace connection credential. | WorkspaceConnectionApiKey |
WorkspaceConnectionApiKey
Name | Description | Value |
---|---|---|
key | string |
CustomKeysWorkspaceConnectionProperties
Name | Description | Value |
---|---|---|
authType | Authentication type of the connection target | "CustomKeys" (required) |
credentials | Custom Keys credential object | CustomKeys |
CustomKeys
Name | Description | Value |
---|---|---|
keys | Dictionary of {string} | CustomKeys |
{customized property} | string |
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 | |
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 |
Feedback
https://aka.ms/ContentUserFeedback.
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:Submit and view feedback for