Share via

Workspaces - List Keys

Service:
Machine Learning
API Version:
2025-09-01

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=2025-09-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
workspaceName
 path True

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

Name of Azure Machine Learning workspace.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

ListWorkspaceKeysResult

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

ErrorResponse

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=2025-09-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
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ListNotebookKeysResult
ListWorkspaceKeysResult
Password
RegistryListCredentialsResult

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

ListNotebookKeysResult

Object
Name Type Description
primaryAccessKey

string

secondaryAccessKey

string

ListWorkspaceKeysResult

Object
Name Type Description
appInsightsInstrumentationKey

string

containerRegistryCredentials

RegistryListCredentialsResult

notebookAccessKeys

ListNotebookKeysResult

userStorageKey

string

userStorageResourceId

string

Password

Object
Name Type Description
name

string

value

string

RegistryListCredentialsResult

Object
Name Type Description
location

string

passwords

Password[]

username

string