Machine Learning Compute - List Keys

Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).

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

URI Parameters

Name In Required Type Description
computeName
path True
  • string

Name of the Azure Machine Learning compute.

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 ComputeSecrets:

Success.

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 AKS Compute Keys

Sample Request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123/listKeys?api-version=2019-05-01

Sample Response

{
  "computeType": "AKS",
  "userKubeConfig": "user kube config...",
  "adminKubeConfig": "admin kube config...",
  "imagePullSecretName": "the image pull secret name"
}

Definitions

AksComputeSecrets

Secrets related to a Machine Learning compute based on AKS.

ComputeType

The type of compute

DatabricksComputeSecrets

Secrets related to a Machine Learning compute based on Databricks.

ErrorDetail

Error detail information.

ErrorResponse

Error response information.

MachineLearningServiceError

Wrapper for error response to follow ARM guidelines.

VirtualMachineSecrets

Secrets related to a Machine Learning compute based on AKS.

VirtualMachineSshCredentials

Admin credentials for virtual machine

AksComputeSecrets

Secrets related to a Machine Learning compute based on AKS.

Name Type Description
adminKubeConfig
  • string

Content of kubeconfig file that can be used to connect to the Kubernetes cluster.

computeType string:
  • AKS

The type of compute

imagePullSecretName
  • string

Image registry pull secret.

userKubeConfig
  • string

Content of kubeconfig file that can be used to connect to the Kubernetes cluster.

ComputeType

The type of compute

Name Type Description
AKS
  • string
AmlCompute
  • string
DataFactory
  • string
DataLakeAnalytics
  • string
Databricks
  • string
HDInsight
  • string
VirtualMachine
  • string

DatabricksComputeSecrets

Secrets related to a Machine Learning compute based on Databricks.

Name Type Description
computeType string:
  • Databricks

The type of compute

databricksAccessToken
  • string

access token for databricks account.

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.

MachineLearningServiceError

Wrapper for error response to follow ARM guidelines.

Name Type Description
error

The error response.

VirtualMachineSecrets

Secrets related to a Machine Learning compute based on AKS.

Name Type Description
administratorAccount

Admin credentials for virtual machine.

computeType string:
  • VirtualMachine

The type of compute

VirtualMachineSshCredentials

Admin credentials for virtual machine

Name Type Description
password
  • string

Password of admin account

privateKeyData
  • string

Private key data

publicKeyData
  • string

Public key data

username
  • string

Username of admin account