Microsoft.MachineLearningServices workspaces/connections 2021-07-01

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@2021-07-01' = {
  name: 'string'
  properties: {
    authType: 'string'
    category: 'string'
    target: 'string'
    value: 'string'
    valueFormat: 'string'
  }
}

Property values

Microsoft.MachineLearningServices/workspaces/connections

Name Description Value
name The resource name 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 Properties of workspace connection. WorkspaceConnectionProps

WorkspaceConnectionProps

Name Description Value
authType Authorization type of the workspace connection. string
category Category of the workspace connection. string
target Target of the workspace connection. string
value Value details of the workspace connection. string
valueFormat format for the workspace connection value 'JSON'

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:

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": "2021-07-01",
  "name": "string",
  "properties": {
    "authType": "string",
    "category": "string",
    "target": "string",
    "value": "string",
    "valueFormat": "string"
  }
}

Property values

Microsoft.MachineLearningServices/workspaces/connections

Name Description Value
apiVersion The api version '2021-07-01'
name The resource name string (required)
properties Properties of workspace connection. WorkspaceConnectionProps
type The resource type 'Microsoft.MachineLearningServices/workspaces/connections'

WorkspaceConnectionProps

Name Description Value
authType Authorization type of the workspace connection. string
category Category of the workspace connection. string
target Target of the workspace connection. string
value Value details of the workspace connection. string
valueFormat format for the workspace connection value 'JSON'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure AI Studio basic setup

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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@2021-07-01"
  name = "string"
  body = jsonencode({
    properties = {
      authType = "string"
      category = "string"
      target = "string"
      value = "string"
      valueFormat = "string"
    }
  })
}

Property values

Microsoft.MachineLearningServices/workspaces/connections

Name Description Value
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 Properties of workspace connection. WorkspaceConnectionProps
type The resource type "Microsoft.MachineLearningServices/workspaces/connections@2021-07-01"

WorkspaceConnectionProps

Name Description Value
authType Authorization type of the workspace connection. string
category Category of the workspace connection. string
target Target of the workspace connection. string
value Value details of the workspace connection. string
valueFormat format for the workspace connection value 'JSON'