Workspace Connections - List Secrets

Szolgáltatás:

Machine Learning

API-verzió:

2025-04-01

A gépi tanulási munkaterületek kapcsolatainak összes titkos kulcsának felsorolása.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
connectionName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	A munkaterület-kapcsolat rövid neve
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Az Azure Machine Learning-munkaterület neve.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	A kérés sikeres volt; a kérelem megfelelően alakult és megfelelően érkezett.
Other Status Codes	ErrorResponse	Hiba

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

GetWorkspaceConnection

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
AADAuthTypeWorkspaceConnectionProperties	Ez a kapcsolattípus a vonatkozó Azure-szolgáltatások AAD-hitelesítését fedi le
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Ez a kapcsolattípus az Azure Storage fiókkulcs-kapcsolatát fedi le
ApiKeyAuthWorkspaceConnectionProperties	Ez a kapcsolattípus az általános ApiKey hitelesítési kapcsolatkategóriákat fedi le, például: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (típuskritikusként) Hitelesítő adatok:= {ApiKey} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {SubscriptionKey} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {Key} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Metaadat-tulajdonságcsomag használata ApiType, ApiVersion, Kind és egyéb metaadatmezőkhöz
ConnectionAuthType	A kapcsolati cél hitelesítési típusa
ConnectionCategory	A kapcsolat kategóriája
ConnectionGroup	Csoport kapcsolatkategória alapján
createdByType	Az erőforrást létrehozó identitás típusa.
CustomKeys	Egyéni kulcsok hitelesítő objektuma
CustomKeysWorkspaceConnectionProperties	Category:= CustomKeys AuthType:= CustomKeys (típuskriminatívként) Hitelesítő adatok:= {CustomKeys} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Az ApiVersion és más metaadatmezők metaadat-tulajdonságcsomagjának használata
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	a munkaterület kapcsolati értékének formátuma
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Api-kulcsobjektum a munkaterület kapcsolati hitelesítő adataihoz.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	A ClientId és a ClientSecret megadása kötelező. Más tulajdonságok nem kötelezőek az egyes OAuth2-szolgáltatók implementációjától függően.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Objektum

Ez a kapcsolattípus a vonatkozó Azure-szolgáltatások AAD-hitelesítését fedi le

Name	Típus	Description
authType	string: AAD	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

AccessKeyAuthTypeWorkspaceConnectionProperties

Objektum

Name	Típus	Description
authType	string: AccessKey	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionAccessKey
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

AccountKeyAuthTypeWorkspaceConnectionProperties

Objektum

Ez a kapcsolattípus az Azure Storage fiókkulcs-kapcsolatát fedi le

Name	Típus	Description
authType	string: AccountKey	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionAccountKey
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ApiKeyAuthWorkspaceConnectionProperties

Objektum

Ez a kapcsolattípus az általános ApiKey hitelesítési kapcsolatkategóriákat fedi le, például: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (típuskritikusként) Hitelesítő adatok:= {ApiKey} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {SubscriptionKey} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {Key} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Metaadat-tulajdonságcsomag használata ApiType, ApiVersion, Kind és egyéb metaadatmezőkhöz

Name	Típus	Description
authType	string: ApiKey	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionApiKey	Api-kulcsobjektum a munkaterület kapcsolati hitelesítő adataihoz.
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ConnectionAuthType

Enumerálás

A kapcsolati cél hitelesítési típusa

Érték	Description
AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
None
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword

ConnectionCategory

Enumerálás

A kapcsolat kategóriája

Érték	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

Enumerálás

Csoport kapcsolatkategória alapján

Érték	Description
Azure
AzureAI
Database
File
GenericProtocol
NoSQL
ServicesAndApps

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

CustomKeys

Objektum

Egyéni kulcsok hitelesítő objektuma

Name	Típus	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Objektum

Category:= CustomKeys AuthType:= CustomKeys (típuskriminatívként) Hitelesítő adatok:= {CustomKeys} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Az ApiVersion és más metaadatmezők metaadat-tulajdonságcsomagjának használata

Name	Típus	Description
authType	string: CustomKeys	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	CustomKeys	Egyéni kulcsok hitelesítő objektuma
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Objektum

Name	Típus	Description
authType	string: ManagedIdentity	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

NoneAuthTypeWorkspaceConnectionProperties

Objektum

Name	Típus	Description
authType	string: None	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

OAuth2AuthTypeWorkspaceConnectionProperties

Objektum

Name	Típus	Description
authType	string: OAuth2	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionOAuth2	A ClientId és a ClientSecret megadása kötelező. Más tulajdonságok nem kötelezőek az egyes OAuth2-szolgáltatók implementációjától függően.
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

PATAuthTypeWorkspaceConnectionProperties

Objektum

Name	Típus	Description
authType	string: PAT	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

SASAuthTypeWorkspaceConnectionProperties

Objektum

Name	Típus	Description
authType	string: SAS	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Objektum

Name	Típus	Description
authType	string: ServicePrincipal	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Objektum

Name	Típus	Description
authType	string: UsernamePassword	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string (date-time)
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ValueFormat

Enumerálás

a munkaterület kapcsolati értékének formátuma

Érték	Description
JSON

WorkspaceConnectionAccessKey

Objektum

Name	Típus	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Objektum

Name	Típus	Description
key	string

WorkspaceConnectionApiKey

Objektum

Api-kulcsobjektum a munkaterület kapcsolati hitelesítő adataihoz.

Name	Típus	Description
key	string

WorkspaceConnectionManagedIdentity

Objektum

Name	Típus	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

Objektum

A ClientId és a ClientSecret megadása kötelező. Más tulajdonságok nem kötelezőek az egyes OAuth2-szolgáltatók implementációjától függően.

Name	Típus	Description
authUrl	string (url)	A Concur-kapcsolat kategóriája megköveteli
clientId	string (uuid)	Ügyfélazonosító UUID formátumban
clientSecret	string
developerToken	string	A GoogleAdWords kapcsolatkategóriája megköveteli
password	string
refreshToken	string	A GoogleBigQuery, a GoogleAdWords, a Hubspot, a QuickBooks, a Square, a Xero, a Zoho által megkövetelt, ahol a felhasználónak offline állapotba kell helyeznie a RefreshToken szolgáltatást
tenantId	string	A QuickBooks és a Xero kapcsolati kategóriák kötelezőek
username	string	Concur, ServiceNow auth kiszolgáló AccessToken engedélyezési típusa "Jelszó", amely megköveteli UsernamePassword

WorkspaceConnectionPersonalAccessToken

Objektum

Name	Típus	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Objektum

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Objektum

Name	Típus	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Objektum

Name	Típus	Description
sas	string

WorkspaceConnectionUsernamePassword

Objektum

Name	Típus	Description
password	string
securityToken	string	Nem kötelező, az olyan kapcsolatok, mint a SalesForce, a UsernamePassword mellett további biztonságot is igényelnek
username	string