Condividi tramite


Aree di lavoro Microsoft.MachineLearningServices/connections 2023-08-01-preview

Definizione di risorsa Bicep

Il tipo di risorsa aree di lavoro/connessioni può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.MachineLearningServices/workspaces/connections, aggiungere il bicep seguente al modello.

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

Oggetti WorkspaceConnectionPropertiesV2

Impostare la proprietà authType per specificare il tipo di oggetto.

Per AccessKey, usare:

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

Per ApiKey, usare:

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

Per CustomKeys, usare:

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

Per ManagedIdentity, usare:

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

Per Nessuna, usare:

  authType: 'None'

Per PAT, usare:

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

Per sas, usare:

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

Per ServicePrincipal, usare:

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

Per UsernamePassword, usare:

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

Valori delle proprietà

aree di lavoro/connessioni

Nome Descrizione Valore
nome Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.
stringa (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: aree di lavoro
proprietà WorkspaceConnectionPropertiesV2 (obbligatorio)

WorkspaceConnectionPropertiesV2

Nome Descrizione Valore
categoria Categoria della connessione 'ADLSGen2'
'ApiKey'
'AzureMySqlDb'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
'Redis'
'S3'
'Snowflake'
expiryTime corda
isSharedToAll se questa connessione verrà condivisa a tutte le aree di lavoro del progetto nell'hub Bool
metadati Qualsiasi oggetto Per Bicep, è possibile usare la funzione any() .
bersaglio corda
authType Impostare il tipo di oggetto AccessKey
ApiKey
CustomKeys
ManagedIdentity
Nessuna
pat
sas
ServicePrincipal
usernamePassword (obbligatorio)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'AccessKey' (obbligatorio)
credenziali WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nome Descrizione Valore
accessKeyId corda
secretAccessKey corda

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'ApiKey' (obbligatorio)
credenziali Oggetto chiave API per le credenziali di connessione dell'area di lavoro. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nome Descrizione Valore
chiave corda

CustomKeysWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'CustomKeys' (obbligatorio)
credenziali Oggetto credenziali chiavi personalizzate CustomKeys

CustomKeys

Nome Descrizione Valore
Chiavi Dizionario di {string} CustomKeys
{proprietà personalizzata} corda

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'ManagedIdentity' (obbligatorio)
credenziali WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nome Descrizione Valore
clientId corda
resourceId corda

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'Nessuno' (obbligatorio)

PATAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'PAT' (obbligatorio)
credenziali WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nome Descrizione Valore
buffetto corda

SASAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'SAS' (obbligatorio)
credenziali WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nome Descrizione Valore
Sas corda

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'ServicePrincipal' (obbligatorio)
credenziali WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nome Descrizione Valore
clientId corda
clientSecret corda
tenantId corda

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'UsernamePassword' (obbligatorio)
credenziali WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nome Descrizione Valore
parola d’ordine corda
nome utente corda

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa aree di lavoro/connessioni può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.MachineLearningServices/workspaces/connections, aggiungere il codice JSON seguente al modello.

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

Oggetti WorkspaceConnectionPropertiesV2

Impostare la proprietà authType per specificare il tipo di oggetto.

Per AccessKey, usare:

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

Per ApiKey, usare:

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

Per CustomKeys, usare:

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

Per ManagedIdentity, usare:

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

Per Nessuna, usare:

  "authType": "None"

Per PAT, usare:

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

Per sas, usare:

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

Per ServicePrincipal, usare:

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

Per UsernamePassword, usare:

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

Valori delle proprietà

aree di lavoro/connessioni

Nome Descrizione Valore
digitare Tipo di risorsa 'Microsoft.MachineLearningServices/workspaces/connections'
apiVersion Versione dell'API della risorsa '2023-08-01-preview'
nome Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in modelli DI Resource Manager JSON.
stringa (obbligatorio)
proprietà WorkspaceConnectionPropertiesV2 (obbligatorio)

WorkspaceConnectionPropertiesV2

Nome Descrizione Valore
categoria Categoria della connessione 'ADLSGen2'
'ApiKey'
'AzureMySqlDb'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
'Redis'
'S3'
'Snowflake'
expiryTime corda
isSharedToAll se questa connessione verrà condivisa a tutte le aree di lavoro del progetto nell'hub Bool
metadati Qualsiasi oggetto
bersaglio corda
authType Impostare il tipo di oggetto AccessKey
ApiKey
CustomKeys
ManagedIdentity
Nessuna
pat
sas
ServicePrincipal
usernamePassword (obbligatorio)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'AccessKey' (obbligatorio)
credenziali WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nome Descrizione Valore
accessKeyId corda
secretAccessKey corda

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'ApiKey' (obbligatorio)
credenziali Oggetto chiave API per le credenziali di connessione dell'area di lavoro. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nome Descrizione Valore
chiave corda

CustomKeysWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'CustomKeys' (obbligatorio)
credenziali Oggetto credenziali chiavi personalizzate CustomKeys

CustomKeys

Nome Descrizione Valore
Chiavi Dizionario di {string} CustomKeys
{proprietà personalizzata} corda

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'ManagedIdentity' (obbligatorio)
credenziali WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nome Descrizione Valore
clientId corda
resourceId corda

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'Nessuno' (obbligatorio)

PATAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'PAT' (obbligatorio)
credenziali WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nome Descrizione Valore
buffetto corda

SASAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'SAS' (obbligatorio)
credenziali WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nome Descrizione Valore
Sas corda

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'ServicePrincipal' (obbligatorio)
credenziali WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nome Descrizione Valore
clientId corda
clientSecret corda
tenantId corda

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione 'UsernamePassword' (obbligatorio)
credenziali WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nome Descrizione Valore
parola d’ordine corda
nome utente corda

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa aree di lavoro/connessioni può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.MachineLearningServices/workspaces/connections, aggiungere il codice Terraform seguente al modello.

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

Oggetti WorkspaceConnectionPropertiesV2

Impostare la proprietà authType per specificare il tipo di oggetto.

Per AccessKey, usare:

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

Per ApiKey, usare:

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

Per CustomKeys, usare:

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

Per ManagedIdentity, usare:

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

Per Nessuna, usare:

  authType = "None"

Per PAT, usare:

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

Per sas, usare:

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

Per ServicePrincipal, usare:

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

Per UsernamePassword, usare:

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

Valori delle proprietà

aree di lavoro/connessioni

Nome Descrizione Valore
digitare Tipo di risorsa "Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview"
nome Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: aree di lavoro
proprietà WorkspaceConnectionPropertiesV2 (obbligatorio)

WorkspaceConnectionPropertiesV2

Nome Descrizione Valore
categoria Categoria della connessione "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Snowflake"
expiryTime corda
isSharedToAll se questa connessione verrà condivisa a tutte le aree di lavoro del progetto nell'hub Bool
metadati Qualsiasi oggetto
bersaglio corda
authType Impostare il tipo di oggetto AccessKey
ApiKey
CustomKeys
ManagedIdentity
Nessuna
pat
sas
ServicePrincipal
usernamePassword (obbligatorio)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "AccessKey" (obbligatorio)
credenziali WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nome Descrizione Valore
accessKeyId corda
secretAccessKey corda

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "ApiKey" (obbligatorio)
credenziali Oggetto chiave API per le credenziali di connessione dell'area di lavoro. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nome Descrizione Valore
chiave corda

CustomKeysWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "CustomKeys" (obbligatorio)
credenziali Oggetto credenziali chiavi personalizzate CustomKeys

CustomKeys

Nome Descrizione Valore
Chiavi Dizionario di {string} CustomKeys
{proprietà personalizzata} corda

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "ManagedIdentity" (obbligatorio)
credenziali WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nome Descrizione Valore
clientId corda
resourceId corda

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "Nessuno" (obbligatorio)

PATAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "PAT" (obbligatorio)
credenziali WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nome Descrizione Valore
buffetto corda

SASAuthTypeWorkspaceConnectionProperties

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "SAS" (obbligatorio)
credenziali WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nome Descrizione Valore
Sas corda

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "ServicePrincipal" (obbligatorio)
credenziali WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nome Descrizione Valore
clientId corda
clientSecret corda
tenantId corda

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nome Descrizione Valore
authType Tipo di autenticazione della destinazione della connessione "UsernamePassword" (obbligatorio)
credenziali WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nome Descrizione Valore
parola d’ordine corda
nome utente corda