Workspace Connections - List Secrets

Serviço:

Machine Learning

Versão da API:

2024-04-01

Liste todos os segredos de uma ligação de áreas de trabalho de machine learning.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
connectionName	path	True	string	Nome amigável da ligação da área de trabalho Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
workspaceName	path	True	string	Nome da área de trabalho do Azure Machine Learning. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	O pedido foi efetuado com êxito; o pedido foi bem formado e recebido corretamente.
Other Status Codes	ErrorResponse	Erro

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

GetWorkspaceConnection

Sample request

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

Sample response

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

Definições

Name	Description
AADAuthTypeWorkspaceConnectionProperties	Este tipo de ligação abrange a autenticação do AAD para qualquer serviço do Azure aplicável
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Este tipo de ligação abrange a ligação de chave de conta para o armazenamento do Azure
ApiKeyAuthWorkspaceConnectionProperties	Este tipo de ligação abrange as categorias genéricas de ligação de autenticação ApiKey, por exemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como tipo discriminatório) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminatório do tipo) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como discriminatório do tipo) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Utilizar o conjunto de propriedades de Metadados para campos ApiType, ApiVersion, Kind e outros metadados
ConnectionAuthType	Tipo de autenticação do destino da ligação
ConnectionCategory	Categoria da ligação
ConnectionGroup	Agrupar com base na categoria de ligação
createdByType	O tipo de identidade que criou o recurso.
CustomKeys	Objeto de credencial chaves personalizadas
CustomKeysWorkspaceConnectionProperties	Category:= CustomKeys AuthType:= CustomKeys (como discriminatório do tipo) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metadados relativos à criação e última modificação do recurso.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	formato para o valor de ligação da área de trabalho
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Objeto de chave de API para credenciais de ligação da área de trabalho.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId e ClientSecret são necessários. Outras propriedades são opcionais consoante a implementação de cada fornecedor OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Este tipo de ligação abrange a autenticação do AAD para qualquer serviço do Azure aplicável

Name	Tipo	Description
authType	string: AAD	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Tipo	Description
authType	string: AccessKey	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

AccountKeyAuthTypeWorkspaceConnectionProperties

Este tipo de ligação abrange a ligação de chave de conta para o armazenamento do Azure

Name	Tipo	Description
authType	string: AccountKey	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

ApiKeyAuthWorkspaceConnectionProperties

Este tipo de ligação abrange as categorias genéricas de ligação de autenticação ApiKey, por exemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como tipo discriminatório) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminatório do tipo) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como discriminatório do tipo) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Utilizar o conjunto de propriedades de Metadados para campos ApiType, ApiVersion, Kind e outros metadados

Name	Tipo	Description
authType	string: ApiKey	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Objeto de chave de API para credenciais de ligação da área de trabalho.
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

ConnectionAuthType

Tipo de autenticação do destino da ligação

Name	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

Categoria da ligação

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

Agrupar com base na categoria de ligação

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

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Objeto de credencial chaves personalizadas

Name	Tipo	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (como discriminatório do tipo) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields

Name	Tipo	Description
authType	string: CustomKeys	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	CustomKeys	Objeto de credencial chaves personalizadas
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Tipo	Description
authType	string: ManagedIdentity	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

NoneAuthTypeWorkspaceConnectionProperties

Name	Tipo	Description
authType	string: None	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

OAuth2AuthTypeWorkspaceConnectionProperties

Name	Tipo	Description
authType	string: OAuth2	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId e ClientSecret são necessários. Outras propriedades são opcionais consoante a implementação de cada fornecedor OAuth2.
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

PATAuthTypeWorkspaceConnectionProperties

Name	Tipo	Description
authType	string: PAT	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

SASAuthTypeWorkspaceConnectionProperties

Name	Tipo	Description
authType	string: SAS	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Tipo	Description
authType	string: ServicePrincipal	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Tipo	Description
authType	string: UsernamePassword	Tipo de autenticação do destino da ligação
category	ConnectionCategory	Categoria da ligação
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de ligação
isSharedToAll	boolean
metadata	object	Armazenar metadados de utilizador para esta ligação
sharedUserList	string[]
target	string
value	string	Detalhes do valor da ligação da área de trabalho.
valueFormat	ValueFormat	formato para o valor de ligação da área de trabalho

ValueFormat

formato para o valor de ligação da área de trabalho

Name	Tipo	Description
JSON	string

WorkspaceConnectionAccessKey

Name	Tipo	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Name	Tipo	Description
key	string

WorkspaceConnectionApiKey

Objeto de chave de API para credenciais de ligação da área de trabalho.

Name	Tipo	Description
key	string

WorkspaceConnectionManagedIdentity

Name	Tipo	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId e ClientSecret são necessários. Outras propriedades são opcionais consoante a implementação de cada fornecedor OAuth2.

Name	Tipo	Description
authUrl	string	Obrigatório pela categoria Desativar ligação
clientId	string	ID de cliente no formato UUID
clientSecret	string
developerToken	string	Obrigatório pela categoria de ligação GoogleAdWords
password	string
refreshToken	string	Necessário para GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, onde o utilizador precisa de colocar RefreshToken offline
tenantId	string	Necessário para os QuickBooks e categorias de ligação Xero
username	string	Em simultâneo, o tipo de concessão AccessToken do servidor de autenticação do ServiceNow é "Palavra-passe", o que requer UsernamePassword

WorkspaceConnectionPersonalAccessToken

Name	Tipo	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Name	Tipo	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Name	Tipo	Description
sas	string

WorkspaceConnectionUsernamePassword

Name	Tipo	Description
password	string
securityToken	string	Opcional, exigido por ligações como SalesForce para segurança adicional, além de UsernamePassword
username	string