Espaces de travail/connexions Microsoft.MachineLearningServices 2023-08-01-preview

Définition de ressource Bicep

Le type de ressource espaces de travail/connexions peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.MachineLearningServices/workspaces/connections, ajoutez le Bicep suivant à votre modèle.

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

Objets WorkspaceConnectionPropertiesV2

Définissez la propriété authType pour spécifier le type d’objet.

Pour AccessKey, utilisez :

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

Pour ApiKey, utilisez :

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

Pour CustomKeys, utilisez :

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

Pour ManagedIdentity, utilisez :

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

Pour Aucun, utilisez :

  authType: 'None'

Pour PAT, utilisez :

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

Pour SAS, utilisez :

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

Pour ServicePrincipal, utilisez :

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

Pour UsernamePassword, utilisez :

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

Valeurs de propriétés

espaces de travail/connexions

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.
chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.
Nom symbolique de la ressource de type : espaces de travail
properties WorkspaceConnectionPropertiesV2 (obligatoire)

WorkspaceConnectionPropertiesV2

Nom Description Valeur
catégorie Catégorie de la connexion 'ADLSGen2'
'ApiKey'
'AzureMySqlDb'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
'Redis'
'S3'
'Flocon de neige'
expiryTime string
isSharedToAll si cette connexion sera partagée avec l’ensemble de l’espace de travail du projet sous le hub bool
metadata Tout objet Pour Bicep, vous pouvez utiliser la fonction any().
target string
authType Définir le type d’objet Accesskey
ApiKey
CustomKeys
ManagedIdentity
Aucun
Jeton d’accès personnel
SAS
ServicePrincipal
UsernamePassword (obligatoire)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'AccessKey' (obligatoire)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nom Description Valeur
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'ApiKey' (obligatoire)
credentials Objet de clé API pour les informations d’identification de connexion de l’espace de travail. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nom Description Valeur
key string

CustomKeysWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'CustomKeys' (obligatoire)
credentials Objet d’informations d’identification clés personnalisées CustomKeys

CustomKeys

Nom Description Valeur
clés Dictionnaire de {string} CustomKeys
{propriété personnalisée} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'ManagedIdentity' (obligatoire)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nom Description Valeur
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'None' (obligatoire)

PATAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'PAT' (obligatoire)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nom Description Valeur
Pat string

SASAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'SAS' (obligatoire)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nom Description Valeur
Sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'ServicePrincipal' (obligatoire)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nom Description Valeur
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'UsernamePassword' (obligatoire)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nom Description Valeur
mot de passe string
username string

Définition de ressources de modèle ARM

Le type de ressource espaces de travail/connexions peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.MachineLearningServices/workspaces/connections, ajoutez le code JSON suivant à votre modèle.

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

Objets WorkspaceConnectionPropertiesV2

Définissez la propriété authType pour spécifier le type d’objet.

Pour AccessKey, utilisez :

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

Pour ApiKey, utilisez :

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

Pour CustomKeys, utilisez :

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

Pour ManagedIdentity, utilisez :

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

Pour Aucun, utilisez :

  "authType": "None"

Pour PAT, utilisez :

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

Pour SAS, utilisez :

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

Pour ServicePrincipal, utilisez :

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

Pour UsernamePassword, utilisez :

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

Valeurs de propriétés

espaces de travail/connexions

Nom Description Valeur
type Type de ressource « Microsoft.MachineLearningServices/workspaces/connections »
apiVersion Version de l’API de ressource « 2023-08-01-preview »
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.
chaîne (obligatoire)
properties WorkspaceConnectionPropertiesV2 (obligatoire)

WorkspaceConnectionPropertiesV2

Nom Description Valeur
catégorie Catégorie de la connexion 'ADLSGen2'
'ApiKey'
'AzureMySqlDb'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSynapseAnalytics'
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
'Redis'
'S3'
'Flocon de neige'
expiryTime string
isSharedToAll si cette connexion sera partagée avec tout l’espace de travail du projet sous le hub bool
metadata Tout objet
target string
authType Définir le type d’objet Accesskey
ApiKey
CustomKeys
ManagedIdentity
Aucun
Jeton d’accès personnel
SAS
ServicePrincipal
UsernamePassword (obligatoire)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'AccessKey' (obligatoire)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nom Description Valeur
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'ApiKey' (obligatoire)
credentials Objet de clé API pour les informations d’identification de connexion de l’espace de travail. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nom Description Valeur
key string

CustomKeysWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'CustomKeys' (obligatoire)
credentials Objet d’informations d’identification clés personnalisées CustomKeys

CustomKeys

Nom Description Valeur
clés Dictionnaire de {string} CustomKeys
{propriété personnalisée} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'ManagedIdentity' (obligatoire)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nom Description Valeur
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'None' (obligatoire)

PATAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'PAT' (obligatoire)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nom Description Valeur
Pat string

SASAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'SAS' (obligatoire)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nom Description Valeur
Sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'ServicePrincipal' (obligatoire)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nom Description Valeur
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nom Description Valeur
authType Type d’authentification de la cible de connexion 'UsernamePassword' (obligatoire)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nom Description Valeur
mot de passe string
username string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource espaces de travail/connexions peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.MachineLearningServices/workspaces/connections, ajoutez le Terraform suivant à votre modèle.

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

Objets WorkspaceConnectionPropertiesV2

Définissez la propriété authType pour spécifier le type d’objet.

Pour AccessKey, utilisez :

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

Pour ApiKey, utilisez :

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

Pour CustomKeys, utilisez :

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

Pour ManagedIdentity, utilisez :

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

Pour Aucun, utilisez :

  authType = "None"

Pour PAT, utilisez :

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

Pour SAS, utilisez :

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

Pour ServicePrincipal, utilisez :

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

Pour UsernamePassword, utilisez :

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

Valeurs de propriétés

espaces de travail/connexions

Nom Description Valeur
type Type de ressource « Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview »
name Nom de la ressource string (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : espaces de travail
properties WorkspaceConnectionPropertiesV2 (obligatoire)

WorkspaceConnectionPropertiesV2

Nom Description Valeur
catégorie Catégorie de la connexion « ADLSGen2 »
« ApiKey »
« AzureMySqlDb »
« AzureOpenAI »
« AzurePostgresDb »
« AzureSqlDb »
« AzureSynapseAnalytics »
« CognitiveSearch »
« CognitiveService »
« ContainerRegistry »
« CustomKeys »
« Git »
« PythonFeed »
« Redis »
« S3 »
« Flocon de neige »
expiryTime string
isSharedToAll si cette connexion sera partagée avec tout l’espace de travail du projet sous le hub bool
metadata Tout objet
target string
authType Définir le type d’objet Accesskey
ApiKey
CustomKeys
ManagedIdentity
Aucun
Jeton d’accès personnel
SAS
ServicePrincipal
UsernamePassword (obligatoire)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion « AccessKey » (obligatoire)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nom Description Valeur
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion « ApiKey » (obligatoire)
credentials Objet de clé API pour les informations d’identification de connexion de l’espace de travail. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nom Description Valeur
key string

CustomKeysWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion « CustomKeys » (obligatoire)
credentials Objet d’informations d’identification clés personnalisées CustomKeys

CustomKeys

Nom Description Valeur
clés Dictionnaire de {string} CustomKeys
{propriété personnalisée} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion « ManagedIdentity » (obligatoire)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nom Description Valeur
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion « None » (obligatoire)

PATAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion « PAT » (obligatoire)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nom Description Valeur
Pat string

SASAuthTypeWorkspaceConnectionProperties

Nom Description Valeur
authType Type d’authentification de la cible de connexion « SAP » (obligatoire)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nom Description Valeur
Sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nom Description Valeur
authType Type d’authentification de la cible de connexion « ServicePrincipal » (obligatoire)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nom Description Valeur
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nom Description Valeur
authType Type d’authentification de la cible de connexion « UsernamePassword » (obligatoire)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nom Description Valeur
mot de passe string
username string