Workspace Connections - List Secrets

Service:

Machine Learning

API Version:

2024-04-01

기계 학습 작업 영역 연결의 모든 비밀을 나열합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
connectionName	path	True	string	작업 영역 연결의 이름 Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
workspaceName	path	True	string	Azure Machine Learning 작업 영역의 이름입니다. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	요청이 성공했습니다. 요청이 제대로 구성되고 제대로 수신되었습니다.
Other Status Codes	ErrorResponse	오류

보안

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

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

정의

Name	Description
AADAuthTypeWorkspaceConnectionProperties	이 연결 형식은 해당 Azure 서비스에 대한 AAD 인증을 다룹니다.
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	이 연결 유형은 Azure Storage에 대한 계정 키 연결을 다룹니다.
ApiKeyAuthWorkspaceConnectionProperties	이 연결 형식은 일반적인 ApiKey 인증 연결 범주를 다룹니다. 예: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey(형식 판별자) 자격 증명:= {ApiKey} as 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	리소스를 만든 ID 유형입니다.
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
WorkspaceConnectionApiKey	작업 영역 연결 자격 증명에 대한 Api 키 개체입니다.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId 및 ClientSecret이 필요합니다. 다른 속성은 각 OAuth2 공급자의 구현에 따라 선택 사항입니다.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

이 연결 형식은 해당 Azure 서비스에 대한 AAD 인증을 다룹니다.

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

Name	형식	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 Storage에 대한 계정 키 연결을 다룹니다.

Name	형식	Description
authType	string: AccountKey	연결 대상의 인증 유형
category	ConnectionCategory	연결 범주
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	연결 범주에 따라 그룹화
isSharedToAll	boolean
metadata	object	이 연결에 대한 사용자 메타데이터 저장
sharedUserList	string[]
target	string
value	string	작업 영역 연결의 값 세부 정보입니다.
valueFormat	ValueFormat	작업 영역 연결 값에 대한 형식

ApiKeyAuthWorkspaceConnectionProperties

이 연결 형식은 일반적인 ApiKey 인증 연결 범주를 다룹니다. 예: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey(형식 판별자) 자격 증명:= {ApiKey} as 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 및 기타 메타데이터 필드에 메타데이터 속성 모음 사용

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

연결 대상의 인증 유형

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

연결 범주

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

연결 범주에 따라 그룹화

Name	형식	Description
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

사용자 지정 키 자격 증명 개체

Name	형식	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (형식 판별자로) 자격 증명:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} ApiVersion 및 기타 메타데이터 필드에 메타데이터 속성 모음 사용

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

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

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

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

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

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

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

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

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

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

작업 영역 연결 값에 대한 형식

Name	형식	Description
JSON	string

WorkspaceConnectionAccessKey

Name	형식	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionApiKey

작업 영역 연결 자격 증명에 대한 Api 키 개체입니다.

Name	형식	Description
key	string

WorkspaceConnectionManagedIdentity

Name	형식	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId 및 ClientSecret이 필요합니다. 다른 속성은 각 OAuth2 공급자의 구현에 따라 선택 사항입니다.

Name	형식	Description
authUrl	string	Concur 연결 범주에 필요
clientId	string	UUID 형식의 클라이언트 ID
clientSecret	string
developerToken	string	GoogleAdWords 연결 범주에 필요
password	string
refreshToken	string	사용자가 RefreshToken을 오프라인으로 전환해야 하는 GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho에 필요합니다.
tenantId	string	QuickBooks 및 Xero 연결 범주에 필요
username	string	Concur, ServiceNow 인증 서버 AccessToken 허용 유형은 UsernamePassword가 필요한 '암호'입니다.

WorkspaceConnectionPersonalAccessToken

Name	형식	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /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

Name	형식	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Name	형식	Description
sas	string

WorkspaceConnectionUsernamePassword

Name	형식	Description
password	string
securityToken	string	선택 사항이며 UsernamePassword 외에 추가 보안을 위해 SalesForce와 같은 연결에 필요합니다.
username	string