Compartir a través de


Áreas de trabajo de Microsoft.MachineLearningServices/connections 2023-06-01-preview

Definición de recursos de Bicep

El tipo de recurso workspaces/connections se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.MachineLearningServices/workspaces/connections, agregue el siguiente bicep a la plantilla.

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

Objetos WorkspaceConnectionPropertiesV2

Establezca la propiedad authType para especificar el tipo de objeto.

Para AccessKey, use:

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

Para ApiKey, use:

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

Para CustomKeys, use:

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

Para ManagedIdentity, use:

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

Para Ninguno, use:

  authType: 'None'

Para PAT, use:

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

Para SAS, use:

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

Para ServicePrincipal, use:

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

Para UsernamePassword, use:

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

Valores de propiedad

áreas de trabajo o conexiones

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.
string (obligatorio)
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: áreas de trabajo
properties WorkspaceConnectionPropertiesV2 (obligatorio)

WorkspaceConnectionPropertiesV2

Nombre Descripción Valor
category Categoría de la conexión 'ADLSGen2'
'ApiKey'
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
'CognitiveSearch'
'CognitiveService'
'ContainerRegistry'
'CustomKeys'
'Git'
'PythonFeed'
"Redis"
'S3'
"Copo de nieve"
expiryTime string
metadata Cualquier objeto. Para Bicep, puede usar la función any().
Destino string
authType Establecimiento del tipo de objeto Accesskey
ApiKey
CustomKeys
ManagedIdentity
None
PAT
SAS
ServicePrincipal
UsernamePassword (obligatorio)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'AccessKey' (obligatorio)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nombre Descripción Valor
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'ApiKey' (obligatorio)
credentials Objeto de clave de API para la credencial de conexión del área de trabajo. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nombre Descripción Valor
key string

CustomKeysWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'CustomKeys' (obligatorio)
credentials Objeto de credenciales de claves personalizadas CustomKeys

CustomKeys

Nombre Descripción Valor
claves Diccionario de {string} CustomKeys
{propiedad personalizada} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'ManagedIdentity' (obligatorio)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nombre Descripción Valor
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'None' (obligatorio)

PATAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'PAT' (obligatorio)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nombre Descripción Valor
palmadita string

SASAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'SAS' (obligatorio)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nombre Descripción Valor
Sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'ServicePrincipal' (obligatorio)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nombre Descripción Valor
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'UsernamePassword' (obligatorio)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nombre Descripción Valor
password string
username string

Definición de recursos de plantilla de ARM

El tipo de recurso workspaces/connections se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.MachineLearningServices/workspaces/connections, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "category": "string",
    "expiryTime": "string",
    "metadata": {},
    "target": "string",
    "authType": "string"
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

Objetos WorkspaceConnectionPropertiesV2

Establezca la propiedad authType para especificar el tipo de objeto.

Para AccessKey, use:

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

Para ApiKey, use:

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

Para CustomKeys, use:

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

Para ManagedIdentity, use:

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

Para Ninguno, use:

  "authType": "None"

Para PAT, use:

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

Para SAS, use:

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

Para ServicePrincipal, use:

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

Para UsernamePassword, use:

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

Valores de propiedad

workspaces/connections

Nombre Descripción Value
type Tipo de recurso "Microsoft.MachineLearningServices/workspaces/connections"
apiVersion La versión de la API de recursos "2023-06-01-preview"
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.
string (obligatorio)
properties WorkspaceConnectionPropertiesV2 (obligatorio)

WorkspaceConnectionPropertiesV2

Nombre Descripción Valor
category Categoría de la conexión 'ADLSGen2'
'ApiKey'
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
'CognitiveSearch'
'CognitiveService'
"ContainerRegistry"
'CustomKeys'
"Git"
"PythonFeed"
"Redis"
'S3'
"Copo de nieve"
expiryTime string
metadata Cualquier objeto.
Destino string
authType Establecimiento del tipo de objeto Accesskey
ApiKey
CustomKeys
ManagedIdentity
None
PAT
SAS
ServicePrincipal
UsernamePassword (obligatorio)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'AccessKey' (obligatorio)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nombre Descripción Valor
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'ApiKey' (obligatorio)
credentials Objeto de clave de API para la credencial de conexión del área de trabajo. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nombre Descripción Valor
key string

CustomKeysWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'CustomKeys' (obligatorio)
credentials Objeto de credenciales de claves personalizadas CustomKeys

CustomKeys

Nombre Descripción Valor
claves Diccionario de {string} CustomKeys
{propiedad personalizada} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'ManagedIdentity' (obligatorio)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nombre Descripción Valor
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'None' (obligatorio)

PATAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'PAT' (obligatorio)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nombre Descripción Valor
palmadita string

SASAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'SAS' (obligatorio)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nombre Descripción Valor
Sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'ServicePrincipal' (obligatorio)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nombre Descripción Valor
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión 'UsernamePassword' (obligatorio)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nombre Descripción Valor
password string
username string

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso workspaces/connections se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.MachineLearningServices/workspaces/connections, agregue el siguiente terraform a la plantilla.

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

Objetos WorkspaceConnectionPropertiesV2

Establezca la propiedad authType para especificar el tipo de objeto.

Para AccessKey, use:

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

Para ApiKey, use:

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

Para CustomKeys, use:

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

Para ManagedIdentity, use:

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

Para Ninguno, use:

  authType = "None"

Para PAT, use:

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

Para SAS, use:

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

Para ServicePrincipal, use:

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

Para UsernamePassword, use:

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

Valores de propiedad

áreas de trabajo o conexiones

Nombre Descripción Value
type Tipo de recurso "Microsoft.MachineLearningServices/workspaces/connections@2023-06-01-preview"
name El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: áreas de trabajo
properties WorkspaceConnectionPropertiesV2 (obligatorio)

WorkspaceConnectionPropertiesV2

Nombre Descripción Valor
category Categoría de la conexión "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Copo de nieve"
expiryTime string
metadata Cualquier objeto.
Destino string
authType Establecimiento del tipo de objeto Accesskey
ApiKey
CustomKeys
ManagedIdentity
None
PAT
SAS
ServicePrincipal
UsernamePassword (obligatorio)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "AccessKey" (obligatorio)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nombre Descripción Valor
accessKeyId string
secretAccessKey string

ApiKeyAuthWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "ApiKey" (obligatorio)
credentials Objeto de clave de API para la credencial de conexión del área de trabajo. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nombre Descripción Valor
key string

CustomKeysWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "CustomKeys" (obligatorio)
credentials Objeto de credencial de claves personalizadas CustomKeys

CustomKeys

Nombre Descripción Valor
claves Diccionario de {string} CustomKeys
{propiedad personalizada} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "ManagedIdentity" (obligatorio)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nombre Descripción Valor
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "None" (obligatorio)

PATAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "PAT" (obligatorio)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nombre Descripción Valor
palmadita string

SASAuthTypeWorkspaceConnectionProperties

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "SAS" (obligatorio)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nombre Descripción Valor
Sas string

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "ServicePrincipal" (obligatorio)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nombre Descripción Valor
clientId string
clientSecret string
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nombre Descripción Valor
authType Tipo de autenticación del destino de conexión "UsernamePassword" (obligatorio)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nombre Descripción Valor
password string
username string