Partilhar via


Áreas de trabalho/ligações Microsoft.MachineLearningServices 2023-08-01-preview

Definição de recurso do Bicep

O tipo de recurso de áreas de trabalho/ligações pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.MachineLearningServices/workspaces/connections, adicione o seguinte Bicep ao seu modelo.

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

Objetos WorkspaceConnectionPropertiesV2

Defina a propriedade authType para especificar o tipo de objeto.

Para AccessKey, utilize:

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

Para ApiKey, utilize:

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

Para CustomKeys, utilize:

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

Para ManagedIdentity, utilize:

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

Para Nenhum, utilize:

  authType: 'None'

Para PAT, utilize:

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

Para SAS, utilize:

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

Para ServicePrincipal, utilize:

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

Para UsernamePassword, utilize:

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

Valores de propriedade

áreas de trabalho/ligações

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.
cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.
Nome simbólico para recurso do tipo: áreas de trabalho
propriedades WorkspaceConnectionPropertiesV2 (necessário)

WorkspaceConnectionPropertiesV2

Nome Descrição Valor
categoria Categoria da ligação "ADLSGen2"
'ApiKey'
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
'CognitiveSearch'
'CognitiveService'
"ContainerRegistry"
"CustomKeys"
'Git'
'PythonFeed'
'Redis'
'S3'
'Floco de Neve'
expiryTime string
isSharedToAll se esta ligação será partilhada em toda a área de trabalho do projeto no hub bool
do IdP Qualquer objeto Para o Bicep, pode utilizar a função any( ).
destino string
authType Definir o tipo de objeto AccessKey
ApiKey
CustomKeys
ManagedIdentity
Nenhuma
PAT
SAS
ServicePrincipal
UsernamePassword (obrigatório)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "AccessKey" (obrigatório)
credenciais WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nome Descrição Valor
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "ApiKey" (obrigatório)
credenciais Objeto de chave de API para credenciais de ligação da área de trabalho. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nome Descrição Valor
chave string

CustomKeysWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "CustomKeys" (obrigatório)
credenciais Objeto de credencial chaves personalizadas CustomKeys

CustomKeys

Nome Descrição Valor
keys Dicionário de {string} CustomKeys
{customized property} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "ManagedIdentity" (obrigatório)
credenciais WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nome Descrição Valor
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "Nenhum" (obrigatório)

PATAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "PAT" (obrigatório)
credenciais WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nome Descrição Valor
pat string

SASAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "SAS" (obrigatório)
credenciais WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nome Descrição Valor
sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "ServicePrincipal" (obrigatório)
credenciais WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nome Descrição Valor
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "UsernamePassword" (obrigatório)
credenciais WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nome Descrição Valor
palavra-passe cadeia (de carateres)
nome de utilizador string

Definição de recurso de modelo do ARM

O tipo de recurso de áreas de trabalho/ligações pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.MachineLearningServices/workspaces/connections, adicione o seguinte JSON ao seu modelo.

{
  "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
  }
}

Objetos WorkspaceConnectionPropertiesV2

Defina a propriedade authType para especificar o tipo de objeto.

Para AccessKey, utilize:

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

Para ApiKey, utilize:

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

Para CustomKeys, utilize:

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

Para ManagedIdentity, utilize:

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

Para Nenhum, utilize:

  "authType": "None"

Para PAT, utilize:

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

Para SAS, utilize:

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

Para ServicePrincipal, utilize:

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

Para UsernamePassword, utilize:

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

Valores de propriedade

áreas de trabalho/ligações

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.MachineLearningServices/workspaces/connections"
apiVersion A versão da API de recursos "2023-08-01-preview"
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.
cadeia (obrigatório)
propriedades WorkspaceConnectionPropertiesV2 (necessário)

WorkspaceConnectionPropertiesV2

Nome Descrição Valor
categoria Categoria da ligação "ADLSGen2"
'ApiKey'
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
'CognitiveSearch'
'CognitiveService'
"ContainerRegistry"
"CustomKeys"
'Git'
'PythonFeed'
'Redis'
'S3'
'Floco de Neve'
expiryTime string
isSharedToAll se esta ligação será partilhada em toda a área de trabalho do projeto no hub bool
do IdP Qualquer objeto
destino string
authType Definir o tipo de objeto AccessKey
ApiKey
CustomKeys
ManagedIdentity
Nenhuma
PAT
SAS
ServicePrincipal
UsernamePassword (obrigatório)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "AccessKey" (obrigatório)
credenciais WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nome Descrição Valor
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "ApiKey" (obrigatório)
credenciais Objeto de chave de API para credenciais de ligação da área de trabalho. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nome Descrição Valor
chave string

CustomKeysWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "CustomKeys" (obrigatório)
credenciais Objeto de credencial chaves personalizadas CustomKeys

CustomKeys

Nome Descrição Valor
keys Dicionário de {string} CustomKeys
{customized property} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "ManagedIdentity" (obrigatório)
credenciais WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nome Descrição Valor
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "Nenhum" (obrigatório)

PATAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino da ligação "PAT" (obrigatório)
credenciais WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nome Descrição Valor
pat string

SASAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino da ligação "SAS" (obrigatório)
credenciais WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nome Descrição Valor
sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nome Descrição Valor
authType Tipo de autenticação do destino da ligação "ServicePrincipal" (obrigatório)
credenciais WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nome Descrição Valor
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nome Descrição Valor
authType Tipo de autenticação do destino da ligação "UsernamePassword" (obrigatório)
credenciais WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nome Descrição Valor
palavra-passe cadeia (de carateres)
nome de utilizador string

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso de áreas de trabalho/ligações pode ser implementado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.MachineLearningServices/workspaces/connections, adicione o seguinte Terraform ao seu modelo.

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

Objetos WorkspaceConnectionPropertiesV2

Defina a propriedade authType para especificar o tipo de objeto.

Para AccessKey, utilize:

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

Para ApiKey, utilize:

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

Para CustomKeys, utilize:

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

Para ManagedIdentity, utilize:

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

Para Nenhum, utilize:

  authType = "None"

Para PAT, utilize:

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

Para SAS, utilize:

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

Para ServicePrincipal, utilize:

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

Para UsernamePassword, utilize:

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

Valores de propriedade

áreas de trabalho/ligações

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: áreas de trabalho
propriedades WorkspaceConnectionPropertiesV2 (obrigatório)

WorkspaceConnectionPropertiesV2

Nome Descrição Valor
categoria Categoria da ligação "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Floco de Neve"
expiryTime string
isSharedToAll se esta ligação será partilhada em toda a área de trabalho do projeto no hub bool
do IdP Qualquer objeto
destino string
authType Definir o tipo de objeto AccessKey
ApiKey
CustomKeys
ManagedIdentity
Nenhuma
PAT
SAS
ServicePrincipal
UsernamePassword (obrigatório)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "AccessKey" (obrigatório)
credenciais WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nome Descrição Valor
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "ApiKey" (obrigatório)
credenciais Objeto de chave de API para credenciais de ligação da área de trabalho. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nome Descrição Valor
chave string

CustomKeysWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "CustomKeys" (obrigatório)
credenciais Objeto de credencial chaves personalizadas CustomKeys

CustomKeys

Nome Descrição Valor
keys Dicionário de {string} CustomKeys
{customized property} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "ManagedIdentity" (obrigatório)
credenciais WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nome Descrição Valor
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "Nenhum" (obrigatório)

PATAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "PAT" (obrigatório)
credenciais WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nome Descrição Valor
pat string

SASAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "SAS" (obrigatório)
credenciais WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nome Descrição Valor
sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "ServicePrincipal" (obrigatório)
credenciais WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nome Descrição Valor
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nome Descrição Valor
authType Tipo de autenticação do destino de ligação "UsernamePassword" (obrigatório)
credenciais WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nome Descrição Valor
palavra-passe cadeia (de carateres)
nome de utilizador string