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'
  }

針對 None,請使用:

  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

名字 描述 價值
名字 資源名稱

請參閱如何在 Bicep 中設定子資源的名稱和類型。
字串 (必要)
父母 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型的資源符號名稱:工作區
性能 WorkspaceConnectionPropertiesV2 (必要)

WorkspaceConnectionPropertiesV2

名字 描述 價值
類別 線上的類別 'ADLSGen2'
'ApiKey'
'AzureMySqlDb'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
'Redis'
'S3'
“雪花”
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"
  }

針對 None,請使用:

  "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'
名字 資源名稱

請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。
字串 (必要)
性能 WorkspaceConnectionPropertiesV2 (必要)

WorkspaceConnectionPropertiesV2

名字 描述 價值
類別 線上的類別 'ADLSGen2'
'ApiKey'
'AzureMySqlDb'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
'Redis'
'S3'
“雪花”
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"
  }

針對 None,請使用:

  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”
名字 資源名稱 字串 (必要)
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼:工作區
性能 WorkspaceConnectionPropertiesV2 (必要)

WorkspaceConnectionPropertiesV2

名字 描述 價值
類別 線上的類別 “ADLSGen2”
“ApiKey”
“AzureMySqlDb”
“AzureOpenAI”
“AzurePostgresDb”
“AzureSqlDb”
“AzureSynapseAnalytics”
“CognitiveSearch”
“CognitiveService”
“ContainerRegistry”
“CustomKeys”
“Git”
“PythonFeed”
“Redis”
“S3”
“雪花”
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 字串