共用方式為

Microsoft.MachineLearningServices 工作區/連線 2023-08-01-preview

  • 發行項

Bicep 資源定義

工作區/連線資源類型可以使用目標作業進行部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.MachineLearningServices/workspaces/connections 資源，請將下列 Bicep 新增至您的範本。

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

WorkspaceConnectionPropertiesV2 物件

設定 authType 屬性以指定物件的類型。

針對 AccessKey，請使用：

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

針對 ApiKey，請使用：

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

針對 CustomKeys，請使用：

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

針對 ManagedIdentity，請使用：

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

針對 [無]，請使用：

  authType: 'None'

針對 PAT，請使用：

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

針對 SAS，請使用：

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

針對 ServicePrincipal，請使用：

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

針對 UsernamePassword，請使用：

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

屬性值

workspaces/connections

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 需要字串 ()
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： 工作區
properties WorkspaceConnectionPropertiesV2 (必要)

WorkspaceConnectionPropertiesV2

名稱 描述 值
category 線上的類別 'ADLSGen2'
'ApiKey'
'AzureMySqlDb'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
'Redis'
'S3'
'Snowflake'
expiryTime 字串
isSharedToAll 此連線是否會共用至中樞下的所有專案工作區 bool
中繼資料 任何物件 針對 Bicep，您可以使用 any () 函式。
目標 字串
authType 設定物件類型 AccessKey
ApiKey
CustomKeys
ManagedIdentity
無
PAT
SAS
ServicePrincipal
usernamePassword (必要)

AccessKeyAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 必要 ('AccessKey')
認證 WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

名稱 描述 值
accessKeyId 字串
secretAccessKey 字串

ApiKeyAuthWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 'ApiKey' (必要)
認證 工作區連線認證的 API 金鑰物件。 WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

名稱 描述 值
索引鍵 字串

CustomKeysWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 必要) 'CustomKeys' (
認證 自訂金鑰認證物件 CustomKeys

CustomKeys

名稱 描述 值
金鑰 {string} 的字典 CustomKeys
{自定義屬性} 字串

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 'ManagedIdentity' (必要)
認證 WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

名稱 描述 值
clientId 字串
resourceId 字串

NoneAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 必要) ('None'

PATAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 需要 『PAT』 ()
認證 WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

名稱 描述 值
派特 字串

SASAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 需要 『SAS』 ()
認證 WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

名稱 描述 值
Sas 字串

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

名稱 描述 值
authType 線上目標的驗證類型 'ServicePrincipal' (必要)
認證 WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

名稱 描述 值
clientId 字串
clientSecret 字串
tenantId 字串

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

名稱 描述 值
authType 線上目標的驗證類型 'UsernamePassword' (必要)
認證 WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

名稱 描述 值
密碼 字串
username 字串

ARM 範本資源定義

工作區/連線資源類型可以使用目標作業進行部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.MachineLearningServices/workspaces/connections 資源，請將下列 JSON 新增至範本。

{
  "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 物件

設定 authType 屬性以指定物件的類型。

針對 AccessKey，請使用：

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

針對 ApiKey，請使用：

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

針對 CustomKeys，請使用：

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

針對 ManagedIdentity，請使用：

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

針對 [無]，請使用：

  "authType": "None"

針對 PAT，請使用：

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

針對 SAS，請使用：

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

針對 ServicePrincipal，請使用：

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

針對 UsernamePassword，請使用：

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

屬性值

workspaces/connections

名稱 描述 值
類型 資源類型 'Microsoft.MachineLearningServices/workspaces/connections'
apiVersion 資源 API 版本 '2023-08-01-preview'
NAME 資源名稱

瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。		 需要字串 ()
properties WorkspaceConnectionPropertiesV2 (必要)

WorkspaceConnectionPropertiesV2

名稱 描述 值
category 線上的類別 'ADLSGen2'
'ApiKey'
'AzureMySqlDb'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
'Redis'
'S3'
'Snowflake'
expiryTime 字串
isSharedToAll 此連線是否會共用至中樞下的所有專案工作區 bool
中繼資料 任何物件
目標 字串
authType 設定物件類型 AccessKey
ApiKey
CustomKeys
ManagedIdentity
無
PAT
SAS
ServicePrincipal
需要 UsernamePassword ()

AccessKeyAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 需要 『AccessKey』 ()
認證 WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

名稱 描述 值
accessKeyId 字串
secretAccessKey 字串

ApiKeyAuthWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 'ApiKey' (必要)
認證 工作區連線認證的 API 金鑰物件。 WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

名稱 描述 值
索引鍵 字串

CustomKeysWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 'CustomKeys' (必要)
認證 自訂金鑰認證物件 CustomKeys

CustomKeys

名稱 描述 值
金鑰 {string} 的字典 CustomKeys
{自定義屬性} 字串

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 必要) 'ManagedIdentity' (
認證 WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

名稱 描述 值
clientId 字串
resourceId 字串

NoneAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 必要 『None』 ()

PATAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 需要 『PAT』 ()
認證 WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

名稱 描述 值
派特 字串

SASAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 需要 『SAS』 ()
認證 WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

名稱 描述 值
Sas 字串

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

名稱 描述 值
authType 線上目標的驗證類型 'ServicePrincipal' (必要)
認證 WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

名稱 描述 值
clientId 字串
clientSecret 字串
tenantId 字串

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

名稱 描述 值
authType 線上目標的驗證類型 必要) 'UsernamePassword' (
認證 WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

名稱 描述 值
密碼 字串
username 字串

Terraform (AzAPI 提供者) 資源定義

工作區/連線資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.MachineLearningServices/workspaces/connections 資源，請將下列 Terraform 新增至您的範本。

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

WorkspaceConnectionPropertiesV2 物件

設定 authType 屬性以指定物件的類型。

針對 AccessKey，請使用：

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

針對 ApiKey，請使用：

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

針對 CustomKeys，請使用：

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

針對 ManagedIdentity，請使用：

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

針對 [無]，請使用：

  authType = "None"

針對 PAT，請使用：

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

針對 SAS，請使用：

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

針對 ServicePrincipal，請使用：

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

針對 UsernamePassword，請使用：

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

屬性值

workspaces/connections

名稱 描述 值
類型 資源類型 “Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview”
NAME 資源名稱 字串 (必要)
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼： 工作區
properties WorkspaceConnectionPropertiesV2 (必要)

WorkspaceConnectionPropertiesV2

名稱 描述 值
category 線上的類別 “ADLSGen2”
“ApiKey”
“AzureMySqlDb”
“AzureOpenAI”
“AzurePostgresDb”
“AzureSqlDb”
“AzureSynapseAnalytics”
“CognitiveSearch”
“CognitiveService”
“ContainerRegistry”
“CustomKeys”
“Git”
“PythonFeed”
“Redis”
“S3”
“Snowflake”
expiryTime 字串
isSharedToAll 此連線是否會共用至中樞下的所有專案工作區 bool
中繼資料 任何物件
目標 字串
authType 設定物件類型 AccessKey
ApiKey
CustomKeys
ManagedIdentity
無
PAT
SAS
ServicePrincipal
需要 UsernamePassword ()

AccessKeyAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 “AccessKey” (必要)
認證 WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

名稱 描述 值
accessKeyId 字串
secretAccessKey 字串

ApiKeyAuthWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 “ApiKey” (必要)
認證 工作區連線認證的 API 金鑰物件。 WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

名稱 描述 值
索引鍵 字串

CustomKeysWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 “CustomKeys” (必要)
認證 自訂金鑰認證物件 CustomKeys

CustomKeys

名稱 描述 值
金鑰 {string} 的字典 CustomKeys
{自定義屬性} 字串

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 “ManagedIdentity” (必要)
認證 WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

名稱 描述 值
clientId 字串
resourceId 字串

NoneAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 “None” (必要)

PATAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 “PAT” (必要)
認證 WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

名稱 描述 值
派特 字串

SASAuthTypeWorkspaceConnectionProperties

名稱 描述 值
authType 線上目標的驗證類型 “SAS” (必要)
認證 WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

名稱 描述 值
Sas 字串

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

名稱 描述 值
authType 線上目標的驗證類型 “ServicePrincipal” (必要)
認證 WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

名稱 描述 值
clientId 字串
clientSecret 字串
tenantId 字串

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

名稱 描述 值
authType 線上目標的驗證類型 “UsernamePassword” (必要)
認證 WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

名稱 描述 值
密碼 字串
username 字串