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=2024-04-01

URI Parameters

Name In Required Type Description
computeName
path True

string

Name of the Azure Machine Learning compute.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

workspaceName
path True

string

Name of Azure Machine Learning workspace.

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

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK ComputeSecrets:

Success.

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 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=2024-04-01

Sample response

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

Definitions

Name Description
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.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

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

ComputeInstance

string

DataFactory

string

DataLakeAnalytics

string

Databricks

string

HDInsight

string

Kubernetes

string

SynapseSpark

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.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

VirtualMachineSecrets

Secrets related to a Machine Learning compute based on AKS.

Name Type Description
administratorAccount

VirtualMachineSshCredentials

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