Workspaces - List Keys

Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry

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

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

Name of the resource group in which workspace is located.

subscriptionId
path True
  • string

Azure subscription identifier.

workspaceName
path True
  • string

Name of Azure Machine Learning workspace.

api-version
query True
  • string

Version of Azure Machine Learning resource provider API.

Responses

Name Type Description
200 OK

The request was successful; the request was well-formed and received properly.

Other Status Codes

Error response describing why the operation failed

Security

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 impersonate your user account

Examples

List Workspace Keys

Sample Request

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

Sample Response

{
  "userStorageKey": "r5rKCJ018TLk+bdAi/9YaVzgcQ0nkLsUqGyUN03KsdCFtqG0SjFGPV8+vT1frWqkvBL0bGoPpLc1BlZSSaZmOA==",
  "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": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw"
      },
      {
        "name": "password2",
        "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t"
      }
    ]
  }
}

Definitions

ErrorDetail

Error detail information.

ErrorResponse

Error response information.

ListWorkspaceKeysResult
MachineLearningServiceError

Wrapper for error response to follow ARM guidelines.

Password
RegistryListCredentialsResult

ErrorDetail

Error detail information.

Name Type Description
code
  • string

Error code.

message
  • string

Error message.

ErrorResponse

Error response information.

Name Type Description
code
  • string

Error code.

details

An array of error detail objects.

message
  • string

Error message.

ListWorkspaceKeysResult

Name Type Description
appInsightsInstrumentationKey
  • string
containerRegistryCredentials
userStorageKey
  • string
userStorageResourceId
  • string

MachineLearningServiceError

Wrapper for error response to follow ARM guidelines.

Name Type Description
error

The error response.

Password

Name Type Description
name
  • string
value
  • string

RegistryListCredentialsResult

Name Type Description
location
  • string
passwords
username
  • string