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

名前	/	必須	型	説明
connectionName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	ワークスペース接続のフレンドリ名
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Azure Machine Learning ワークスペースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

定義

名前	説明
AADAuthTypeWorkspaceConnectionProperties	この接続の種類は、該当する Azure サービスの AAD 認証を対象とします
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	この接続の種類は、Azure Storage のアカウント キー接続を対象とします
ApiKeyAuthWorkspaceConnectionProperties	この接続の種類は、一般的な ApiKey 認証接続カテゴリを対象とします。例: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (型判別機能として) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (型識別子として) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (型識別子として) Credentials:= {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
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	ワークスペース接続資格情報の API キー オブジェクト。
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId と ClientSecret が必要です。 その他のプロパティは、各 OAuth2 プロバイダーの実装に応じて省略可能です。
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Object

この接続の種類は、該当する Azure サービスの AAD 認証を対象とします

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

AccessKeyAuthTypeWorkspaceConnectionProperties

Object

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

AccountKeyAuthTypeWorkspaceConnectionProperties

Object

この接続の種類は、Azure Storage のアカウント キー接続を対象とします

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

ApiKeyAuthWorkspaceConnectionProperties

Object

この接続の種類は、一般的な ApiKey 認証接続カテゴリを対象とします。例: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (型判別機能として) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (型識別子として) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (型識別子として) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

ApiType、ApiVersion、Kind、およびその他のメタデータ フィールドにメタデータ プロパティ バッグを使用する

名前	型	説明
authType	string: ApiKey	接続ターゲットの認証の種類
category	ConnectionCategory	接続のカテゴリ
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionApiKey	ワークスペース接続資格情報の API キー オブジェクト。
expiryTime	string (date-time)
group	ConnectionGroup	接続カテゴリに基づくグループ化
isSharedToAll	boolean
metadata	object	この接続のユーザー メタデータを格納する
sharedUserList	string[]
target	string
value	string	ワークスペース接続の値の詳細。
valueFormat	ValueFormat	ワークスペースの接続値の形式

ConnectionAuthType

列挙

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

値	説明
AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
None
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword

ConnectionCategory

列挙

接続のカテゴリ

値	説明
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

列挙

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

値	説明
Azure
AzureAI
Database
File
GenericProtocol
NoSQL
ServicesAndApps

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

CustomKeys

Object

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

名前	型	説明
keys	object

CustomKeysWorkspaceConnectionProperties

Object

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

名前	型	説明
authType	string: CustomKeys	接続ターゲットの認証の種類
category	ConnectionCategory	接続のカテゴリ
createdByWorkspaceArmId	string (arm-id)
credentials	CustomKeys	カスタム キー資格情報オブジェクト
expiryTime	string (date-time)
group	ConnectionGroup	接続カテゴリに基づくグループ化
isSharedToAll	boolean
metadata	object	この接続のユーザー メタデータを格納する
sharedUserList	string[]
target	string
value	string	ワークスペース接続の値の詳細。
valueFormat	ValueFormat	ワークスペースの接続値の形式

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Object

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

NoneAuthTypeWorkspaceConnectionProperties

Object

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

OAuth2AuthTypeWorkspaceConnectionProperties

Object

名前	型	説明
authType	string: OAuth2	接続ターゲットの認証の種類
category	ConnectionCategory	接続のカテゴリ
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionOAuth2	ClientId と ClientSecret が必要です。 その他のプロパティは、各 OAuth2 プロバイダーの実装に応じて省略可能です。
expiryTime	string (date-time)
group	ConnectionGroup	接続カテゴリに基づくグループ化
isSharedToAll	boolean
metadata	object	この接続のユーザー メタデータを格納する
sharedUserList	string[]
target	string
value	string	ワークスペース接続の値の詳細。
valueFormat	ValueFormat	ワークスペースの接続値の形式

PATAuthTypeWorkspaceConnectionProperties

Object

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

SASAuthTypeWorkspaceConnectionProperties

Object

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

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Object

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

systemData

Object

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

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

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Object

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

ValueFormat

列挙

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

値	説明
JSON

WorkspaceConnectionAccessKey

Object

名前	型	説明
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Object

名前	型	説明
key	string

WorkspaceConnectionApiKey

Object

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

名前	型	説明
key	string

WorkspaceConnectionManagedIdentity

Object

名前	型	説明
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

Object

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

名前	型	説明
authUrl	string (url)	Concur 接続カテゴリで必須
clientId	string (uuid)	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

Object

名前	型	説明
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Object

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

Object

名前	型	説明
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Object

名前	型	説明
sas	string

WorkspaceConnectionUsernamePassword

Object

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