Workspace Connections - List Secrets

Servicio:

Machine Learning

Versión de la API:

2024-10-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=2024-10-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
connectionName	path	True	string	Nombre descriptivo de la conexión del área de trabajo Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
workspaceName	path	True	string	Nombre del área de trabajo de Azure Machine Learning. Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	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=2024-10-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 (as type discriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) 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

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
expiryTime	string
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

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
credentials	WorkspaceConnectionAccessKey
expiryTime	string
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

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
credentials	WorkspaceConnectionAccountKey
expiryTime	string
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

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 (as type discriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) 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
credentials	WorkspaceConnectionApiKey	Objeto de clave de API para la credencial de conexión del área de trabajo.
expiryTime	string
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

Tipo de autenticación del destino de conexión

Nombre	Tipo	Description
AAD	string
AccessKey	string
AccountKey	string
ApiKey	string
CustomKeys	string
ManagedIdentity	string
None	string
OAuth2	string
PAT	string
SAS	string
ServicePrincipal	string
UsernamePassword	string

ConnectionCategory

Categoría de la conexión

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

ConnectionGroup

Grupo basado en la categoría de conexión

Nombre	Tipo	Description
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Objeto de credencial de claves personalizadas

Nombre	Tipo	Description
keys	object

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

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
credentials	CustomKeys	Objeto de credencial de claves personalizadas
expiryTime	string
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

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

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	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

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
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
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

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
expiryTime	string
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

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

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
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
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

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
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
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

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
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
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

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

Nombre	Tipo	Description
createdAt	string	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	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

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
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
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

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

Nombre	Tipo	Description
JSON	string

WorkspaceConnectionAccessKey

Nombre	Tipo	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Nombre	Tipo	Description
key	string

WorkspaceConnectionApiKey

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

Nombre	Tipo	Description
key	string

WorkspaceConnectionManagedIdentity

Nombre	Tipo	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

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	Requerido por la categoría de conexión concur
clientId	string	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

Nombre	Tipo	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

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 del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Nombre	Tipo	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Nombre	Tipo	Description
sas	string

WorkspaceConnectionUsernamePassword

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