Workspace Connections - List Secrets

Referencia

Servicio:: Machine Learning

Versión de la API:: 2025-04-01

Enumere todos los secretos de las conexiones de áreas de trabajo de Machine Learning.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets?api-version=2025-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
connectionName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nombre descriptivo de la conexión del área de trabajo
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nombre del área de trabajo de Azure Machine Learning.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	La solicitud se realizó correctamente; la solicitud se formó correctamente y se recibió correctamente.
Other Status Codes	ErrorResponse	Error

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

GetWorkspaceConnection

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1/listsecrets?api-version=2025-04-01

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1",
  "name": "connection-1",
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "properties": {
    "authType": "AccessKey",
    "credentials": {
      "accessKeyId": "some_string",
      "secretAccessKey": "some_string"
    },
    "category": "CustomKeys",
    "expiryTime": "2020-01-01T00:00:00Z",
    "target": "some_string",
    "metadata": {}
  },
  "systemData": {
    "createdAt": "2020-01-01T00:00:00Z",
    "createdBy": "some_string",
    "createdByType": "ManagedIdentity",
    "lastModifiedAt": "2020-01-01T00:00:00Z",
    "lastModifiedBy": "some_string",
    "lastModifiedByType": "User"
  }
}

Definiciones

Nombre	Description
AADAuthTypeWorkspaceConnectionProperties	Este tipo de conexión cubre la autenticación de AAD para cualquier servicio de Azure aplicable.
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Este tipo de conexión abarca la conexión de clave de cuenta para Azure Storage.
ApiKeyAuthWorkspaceConnectionProperties	Este tipo de conexión cubre las categorías genéricas de conexión de autenticación ApiKey, por ejemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como discriminador de tipos) Credentials:= {ApiKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminador de tipo) Credenciales:= {SubscriptionKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como discriminador de tipo) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Usar el contenedor de propiedades Metadata para ApiType, ApiVersion, Kind y otros campos de metadatos
ConnectionAuthType	Tipo de autenticación del destino de conexión
ConnectionCategory	Categoría de la conexión
ConnectionGroup	Grupo basado en la categoría de conexión
createdByType	Tipo de identidad que creó el recurso.
CustomKeys	Objeto de credencial de claves personalizadas
CustomKeysWorkspaceConnectionProperties	Category:= CustomKeys AuthType:= CustomKeys (como discriminador de tipos) Credentials:= {CustomKeys} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion y otros campos de metadatos
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metadatos relativos a la creación y última modificación del recurso.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	formato para el valor de conexión del área de trabajo
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Objeto de clave de API para la credencial de conexión del área de trabajo.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	Se requieren ClientId y ClientSecret. Otras propiedades son opcionales en función de la implementación de cada proveedor de OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Object

Este tipo de conexión cubre la autenticación de AAD para cualquier servicio de Azure aplicable.

Nombre	Tipo	Description
authType	string: AAD	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

AccessKeyAuthTypeWorkspaceConnectionProperties

Object

Nombre	Tipo	Description
authType	string: AccessKey	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionAccessKey
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

AccountKeyAuthTypeWorkspaceConnectionProperties

Object

Este tipo de conexión abarca la conexión de clave de cuenta para Azure Storage.

Nombre	Tipo	Description
authType	string: AccountKey	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionAccountKey
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

ApiKeyAuthWorkspaceConnectionProperties

Object

Este tipo de conexión cubre las categorías genéricas de conexión de autenticación ApiKey, por ejemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como discriminador de tipos) Credentials:= {ApiKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminador de tipo) Credenciales:= {SubscriptionKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como discriminador de tipo) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Usar el contenedor de propiedades Metadata para ApiType, ApiVersion, Kind y otros campos de metadatos

Nombre	Tipo	Description
authType	string: ApiKey	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionApiKey	Objeto de clave de API para la credencial de conexión del área de trabajo.
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

ConnectionAuthType

Enumeración

Tipo de autenticación del destino de conexión

Valor	Description
AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
None
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword

ConnectionCategory

Enumeración

Categoría de la conexión

Valor	Description
ADLSGen2
AIServices
AmazonMws
AmazonRdsForOracle
AmazonRdsForSqlServer
AmazonRedshift
AmazonS3Compatible
ApiKey
AzureBlob
AzureDataExplorer
AzureDatabricksDeltaLake
AzureMariaDb
AzureMySqlDb
AzureOneLake
AzureOpenAI
AzurePostgresDb
AzureSqlDb
AzureSqlMi
AzureSynapseAnalytics
AzureTableStorage
BingLLMSearch
Cassandra
CognitiveSearch
CognitiveService
Concur
ContainerRegistry
CosmosDb
CosmosDbMongoDbApi
Couchbase
CustomKeys
Db2
Drill
Dynamics
DynamicsAx
DynamicsCrm
Elasticsearch
Eloqua
FileServer
FtpServer
GenericContainerRegistry
GenericHttp
GenericRest
Git
GoogleAdWords
GoogleBigQuery
GoogleCloudStorage
Greenplum
Hbase
Hdfs
Hive
Hubspot
Impala
Informix
Jira
Magento
ManagedOnlineEndpoint
MariaDb
Marketo
MicrosoftAccess
MongoDbAtlas
MongoDbV2
MySql
Netezza
ODataRest
Odbc
Office365
OpenAI
Oracle
OracleCloudStorage
OracleServiceCloud
PayPal
Phoenix
Pinecone
PostgreSql
Presto
PythonFeed
QuickBooks
Redis
Responsys
S3
Salesforce
SalesforceMarketingCloud
SalesforceServiceCloud
SapBw
SapCloudForCustomer
SapEcc
SapHana
SapOpenHub
SapTable
Serp
Serverless
ServiceNow
Sftp
SharePointOnlineList
Shopify
Snowflake
Spark
SqlServer
Square
Sybase
Teradata
Vertica
WebTable
Xero
Zoho

ConnectionGroup

Enumeración

Grupo basado en la categoría de conexión

Valor	Description
Azure
AzureAI
Database
File
GenericProtocol
NoSQL
ServicesAndApps

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

CustomKeys

Object

Objeto de credencial de claves personalizadas

Nombre	Tipo	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Object

Category:= CustomKeys AuthType:= CustomKeys (como discriminador de tipos) Credentials:= {CustomKeys} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion y otros campos de metadatos

Nombre	Tipo	Description
authType	string: CustomKeys	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	CustomKeys	Objeto de credencial de claves personalizadas
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Object

Nombre	Tipo	Description
authType	string: ManagedIdentity	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

NoneAuthTypeWorkspaceConnectionProperties

Object

Nombre	Tipo	Description
authType	string: None	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

OAuth2AuthTypeWorkspaceConnectionProperties

Object

Nombre	Tipo	Description
authType	string: OAuth2	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionOAuth2	Se requieren ClientId y ClientSecret. Otras propiedades son opcionales en función de la implementación de cada proveedor de OAuth2.
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

PATAuthTypeWorkspaceConnectionProperties

Object

Nombre	Tipo	Description
authType	string: PAT	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

SASAuthTypeWorkspaceConnectionProperties

Object

Nombre	Tipo	Description
authType	string: SAS	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Object

Nombre	Tipo	Description
authType	string: ServicePrincipal	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Object

Nombre	Tipo	Description
authType	string: UsernamePassword	Tipo de autenticación del destino de conexión
category	ConnectionCategory	Categoría de la conexión
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string (date-time)
group	ConnectionGroup	Grupo basado en la categoría de conexión
isSharedToAll	boolean
metadata	object	Almacenar metadatos de usuario para esta conexión
sharedUserList	string[]
target	string
value	string	Detalles del valor de la conexión del área de trabajo.
valueFormat	ValueFormat	formato para el valor de conexión del área de trabajo

ValueFormat

Enumeración

formato para el valor de conexión del área de trabajo

Valor	Description
JSON

WorkspaceConnectionAccessKey

Object

Nombre	Tipo	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Object

Nombre	Tipo	Description
key	string

WorkspaceConnectionApiKey

Object

Objeto de clave de API para la credencial de conexión del área de trabajo.

Nombre	Tipo	Description
key	string

WorkspaceConnectionManagedIdentity

Object

Nombre	Tipo	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

Object

Se requieren ClientId y ClientSecret. Otras propiedades son opcionales en función de la implementación de cada proveedor de OAuth2.

Nombre	Tipo	Description
authUrl	string (url)	Requerido por la categoría de conexión concur
clientId	string (uuid)	Id. de cliente con el formato UUID
clientSecret	string
developerToken	string	Requerido por la categoría de conexión GoogleAdWords
password	string
refreshToken	string	Requerido por GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, donde el usuario necesita desconectar RefreshToken
tenantId	string	Requerido por las categorías de conexión QuickBooks y Xero
username	string	Concur, el tipo de concesión accessToken del servidor de autenticación de ServiceNow es "Password", que requiere UsernamePassword.

WorkspaceConnectionPersonalAccessToken

Object

Nombre	Tipo	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Object

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Object

Nombre	Tipo	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Object

Nombre	Tipo	Description
sas	string

WorkspaceConnectionUsernamePassword

Object

Nombre	Tipo	Description
password	string
securityToken	string	Opcional, requerido por conexiones como SalesForce para mayor seguridad además de UsernamePassword
username	string

Compartir a través de

Workspace Connections - List Secrets

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

GetWorkspaceConnection

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AADAuthTypeWorkspaceConnectionProperties

AccessKeyAuthTypeWorkspaceConnectionProperties

AccountKeyAuthTypeWorkspaceConnectionProperties

ApiKeyAuthWorkspaceConnectionProperties

ConnectionAuthType

ConnectionCategory

ConnectionGroup

createdByType

CustomKeys

CustomKeysWorkspaceConnectionProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedIdentityAuthTypeWorkspaceConnectionProperties

NoneAuthTypeWorkspaceConnectionProperties

OAuth2AuthTypeWorkspaceConnectionProperties

PATAuthTypeWorkspaceConnectionProperties

SASAuthTypeWorkspaceConnectionProperties

ServicePrincipalAuthTypeWorkspaceConnectionProperties

systemData

UsernamePasswordAuthTypeWorkspaceConnectionProperties

ValueFormat

WorkspaceConnectionAccessKey

WorkspaceConnectionAccountKey

WorkspaceConnectionApiKey

WorkspaceConnectionManagedIdentity

WorkspaceConnectionOAuth2

WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPropertiesV2BasicResource

WorkspaceConnectionServicePrincipal

WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionUsernamePassword