Workspaces - List Keys

リファレンス

Service:: Machine Learning

API Version:: 2024-04-01

このワークスペースに関連付けられているすべてのキーをListsします。これには、ストレージアカウントのキー、コンテナーレジストリのアプリの分析情報、パスワードが含まれます

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

URI パラメーター

名前	/	必須	型	説明
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	ListWorkspaceKeysResult	要求が成功しました。要求は整形式であり、適切に受信されました。
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	ユーザーアカウントの借用

例

List Workspace Keys

Sample Request

HTTP

POST https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/listKeys?api-version=2024-04-01

Sample Response

Status code:: 200

{
  "userStorageKey": null,
  "userStorageResourceId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr",
  "appInsightsInstrumentationKey": null,
  "containerRegistryCredentials": {
    "location": null,
    "username": "testdemoworkjmjmeykp",
    "passwords": [
      {
        "name": "password",
        "value": "<value>"
      },
      {
        "name": "password2",
        "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t"
      }
    ]
  },
  "notebookAccessKeys": {
    "primaryAccessKey": null,
    "secondaryAccessKey": null
  }
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ListNotebookKeysResult
ListWorkspaceKeysResult
Password
RegistryListCredentialsResult

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

ListNotebookKeysResult

名前	型	説明
primaryAccessKey	string
secondaryAccessKey	string

ListWorkspaceKeysResult

名前	型	説明
appInsightsInstrumentationKey	string
containerRegistryCredentials	RegistryListCredentialsResult
notebookAccessKeys	ListNotebookKeysResult
userStorageKey	string
userStorageResourceId	string

Password

名前	型	説明
name	string
value	string

RegistryListCredentialsResult

名前	型	説明
location	string
passwords	Password[]
username	string