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 パラメーター

名前	/	必須	型	説明
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 バージョン。

応答

名前	型	説明
200 OK	WorkspaceConnectionPropertiesV2BasicResource	要求は成功しました。要求は整形式であり、適切に受信されました。
Other Status Codes	ErrorResponse	エラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
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"
  }
}

定義

名前	説明
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 (型識別子として) Credentials:= {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 認証を対象とします

名前	型	説明
authType	string: AAD	接続ターゲットの認証の種類
category	ConnectionCategory	接続のカテゴリ
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	接続カテゴリに基づくグループ化
isSharedToAll	boolean
metadata	object	この接続のユーザーメタデータを格納する
sharedUserList	string[]
target	string
value	string	ワークスペース接続の値の詳細。
valueFormat	ValueFormat	ワークスペースの接続値の形式

AccessKeyAuthTypeWorkspaceConnectionProperties

名前	型	説明
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 のアカウントキー接続を対象とします

名前	型	説明
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、およびその他のメタデータフィールドにメタデータプロパティバッグを使用する

名前	型	説明
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

接続ターゲットの認証の種類

名前	型	説明
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

接続のカテゴリ

名前	型	説明
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

接続カテゴリに基づくグループ化

名前	型	説明
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

カスタムキー資格情報オブジェクト

名前	型	説明
keys	object

CustomKeysWorkspaceConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (型識別子として) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} ApiVersion およびその他のメタデータフィールドにメタデータプロパティバッグを使用する

名前	型	説明
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

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名前	型	説明
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

名前	型	説明
authType	string: None	接続ターゲットの認証の種類
category	ConnectionCategory	接続のカテゴリ
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	接続カテゴリに基づくグループ化
isSharedToAll	boolean
metadata	object	この接続のユーザーメタデータを格納する
sharedUserList	string[]
target	string
value	string	ワークスペース接続の値の詳細。
valueFormat	ValueFormat	ワークスペースの接続値の形式

OAuth2AuthTypeWorkspaceConnectionProperties

名前	型	説明
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

名前	型	説明
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

名前	型	説明
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

名前	型	説明
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

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UsernamePasswordAuthTypeWorkspaceConnectionProperties

名前	型	説明
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

ワークスペース接続値の形式

名前	型	説明
JSON	string

WorkspaceConnectionAccessKey

名前	型	説明
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionApiKey

ワークスペース接続資格情報の API キーオブジェクト。

名前	型	説明
key	string

WorkspaceConnectionManagedIdentity

名前	型	説明
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId と ClientSecret が必要です。その他のプロパティは、各 OAuth2 プロバイダーの実装に応じて省略可能です。

名前	型	説明
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 許可の種類は 'Password' で、UsernamePassword が必要です

WorkspaceConnectionPersonalAccessToken

名前	型	説明
pat	string

WorkspaceConnectionPropertiesV2BasicResource

名前	型	説明
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

名前	型	説明
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

名前	型	説明
sas	string

WorkspaceConnectionUsernamePassword

名前	型	説明
password	string
securityToken	string	オプション。UsernamePassword に加えて、追加のセキュリティのために SalesForce などの接続で必要です
username	string

Share via