Workspace Connections - List Secrets

參考

服務:: Machine Learning

API 版本:: 2024-10-01

列出機器學習工作區連線的所有秘密。

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

URI 參數

名稱	位於	必要	類型	Description
connectionName	path	True	string	工作區聯機的易記名稱 Regex 模式: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
workspaceName	path	True	string	Azure Machine Learning 工作區的名稱。 Regex 模式: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	要求成功;要求格式正確，且已正確接收。
Other Status Codes	ErrorResponse	錯誤

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

GetWorkspaceConnection

範例要求

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

範例回覆

狀態碼:: 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"
  }
}

定義

名稱	Description
AADAuthTypeWorkspaceConnectionProperties	此連線類型涵蓋任何適用的 Azure 服務的 AAD 驗證
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	此連線類型涵蓋 Azure 記憶體的帳戶金鑰連線
ApiKeyAuthWorkspaceConnectionProperties	此聯機類型涵蓋一般 ApiKey 驗證聯機類別，例如：AzureOpenAI：Category：= AzureOpenAI AuthType：= ApiKey （作為類型歧視性認證：= {ApiKey} 作為 Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target：= {ApiBase} CognitiveService： Category：= CognitiveService AuthType：= ApiKey （類型歧視性）認證：= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target：= ServiceRegion={serviceRegion} CognitiveSearch： Category：= CognitiveSearch AuthType：= ApiKey （作為類型歧視性）認證：= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target：= {Endpoint} 針對 ApiType、ApiVersion、Kind 和其他元數據欄位使用元數據屬性包
ConnectionAuthType	線上目標的驗證類型
ConnectionCategory	線上的類別
ConnectionGroup	以連線類別為基礎的群組
createdByType	建立資源的身分識別類型。
CustomKeys	自訂金鑰認證物件
CustomKeysWorkspaceConnectionProperties	Category：= CustomKeys AuthType：= CustomKeys （作為類型歧視性）認證：= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target：= {any value} 使用 ApiVersion 和其他元數據字段的元數據包屬性
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	與建立和上次修改資源相關的元數據。
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	工作區連接值的格式
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	工作區連線認證的 API 金鑰物件。
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	需要 ClientId 和 ClientSecret。根據每個 OAuth2 提供者的實作而定，其他屬性是選擇性的。
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

此連線類型涵蓋任何適用的 Azure 服務的 AAD 驗證

名稱	類型	Description
authType	string: AAD	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

AccessKeyAuthTypeWorkspaceConnectionProperties

名稱	類型	Description
authType	string: AccessKey	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

AccountKeyAuthTypeWorkspaceConnectionProperties

此連線類型涵蓋 Azure 記憶體的帳戶金鑰連線

名稱	類型	Description
authType	string: AccountKey	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

ApiKeyAuthWorkspaceConnectionProperties

此聯機類型涵蓋一般 ApiKey 驗證聯機類別，例如：AzureOpenAI：Category：= AzureOpenAI AuthType：= ApiKey （作為類型歧視性認證：= {ApiKey} 作為 Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target：= {ApiBase}

CognitiveService： Category：= CognitiveService AuthType：= ApiKey （類型歧視性）認證：= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target：= ServiceRegion={serviceRegion}

CognitiveSearch： Category：= CognitiveSearch AuthType：= ApiKey （作為類型歧視性）認證：= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target：= {Endpoint}

針對 ApiType、ApiVersion、Kind 和其他元數據欄位使用元數據屬性包

名稱	類型	Description
authType	string: ApiKey	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	工作區連線認證的 API 金鑰物件。
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

ConnectionAuthType

線上目標的驗證類型

名稱	類型	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

線上的類別

名稱	類型	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

以連線類別為基礎的群組

名稱	類型	Description
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

自訂金鑰認證物件

名稱	類型	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Category：= CustomKeys AuthType：= CustomKeys （作為類型歧視性）認證：= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target：= {any value} 使用 ApiVersion 和其他元數據字段的元數據包屬性

名稱	類型	Description
authType	string: CustomKeys	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	CustomKeys	自訂金鑰認證物件
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名稱	類型	Description
authType	string: ManagedIdentity	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

NoneAuthTypeWorkspaceConnectionProperties

名稱	類型	Description
authType	string: None	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

OAuth2AuthTypeWorkspaceConnectionProperties

名稱	類型	Description
authType	string: OAuth2	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	需要 ClientId 和 ClientSecret。根據每個 OAuth2 提供者的實作而定，其他屬性是選擇性的。
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

PATAuthTypeWorkspaceConnectionProperties

名稱	類型	Description
authType	string: PAT	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

SASAuthTypeWorkspaceConnectionProperties

名稱	類型	Description
authType	string: SAS	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

ServicePrincipalAuthTypeWorkspaceConnectionProperties

名稱	類型	Description
authType	string: ServicePrincipal	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UsernamePasswordAuthTypeWorkspaceConnectionProperties

名稱	類型	Description
authType	string: UsernamePassword	線上目標的驗證類型
category	ConnectionCategory	線上的類別
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	以連線類別為基礎的群組
isSharedToAll	boolean
metadata	object	儲存此連線的用戶元數據
sharedUserList	string[]
target	string
value	string	工作區聯機的值詳細數據。
valueFormat	ValueFormat	工作區連接值的格式

ValueFormat

工作區連接值的格式

名稱	類型	Description
JSON	string

WorkspaceConnectionAccessKey

名稱	類型	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

名稱	類型	Description
key	string

WorkspaceConnectionApiKey

工作區連線認證的 API 金鑰物件。

名稱	類型	Description
key	string

WorkspaceConnectionManagedIdentity

名稱	類型	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

需要 ClientId 和 ClientSecret。根據每個 OAuth2 提供者的實作而定，其他屬性是選擇性的。

名稱	類型	Description
authUrl	string	Concur 連線類別的必要專案
clientId	string	UUID 格式的用戶端識別碼
clientSecret	string
developerToken	string	GoogleAdWords 連線類別的必要專案
password	string
refreshToken	string	GoogleBigQuery、GoogleAdWords、Hubspot、QuickBooks、Square、Xero、Zoho 所需，使用者需要讓 RefreshToken 脫機
tenantId	string	QuickBooks 和 Xero 連線類別的必要專案
username	string	Concur，ServiceNow 驗證伺服器 AccessToken 授與類型為 'Password'，需要 UsernamePassword

WorkspaceConnectionPersonalAccessToken

名稱	類型	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

WorkspaceConnectionServicePrincipal

名稱	類型	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

名稱	類型	Description
sas	string

WorkspaceConnectionUsernamePassword

名稱	類型	Description
password	string
securityToken	string	除了 UsernamePassword 以外，SalesForce 這類連線還需要額外的安全性
username	string

共用方式為