Compute - List Keys

Servicio:

Machine Learning

Versión de la API:

2024-04-01

Obtiene secretos relacionados con el proceso de Machine Learning (claves de almacenamiento, credenciales de servicio, etc.).

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
computeName	path	True	string	Nombre del proceso de Azure Machine Learning.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
workspaceName	path	True	string	Nombre del área de trabajo de Azure Machine Learning. Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	ComputeSecrets: AksComputeSecrets VirtualMachineSecrets DatabricksComputeSecrets	Correcto.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

List AKS Compute Keys

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for Compute ListKeys.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/
     * examples/Compute/listKeys.json
     */
    /**
     * Sample code: List AKS Compute Keys.
     * 
     * @param manager Entry point to MachineLearningManager.
     */
    public static void listAKSComputeKeys(com.azure.resourcemanager.machinelearning.MachineLearningManager manager) {
        manager.computes().listKeysWithResponse("testrg123", "workspaces123", "compute123",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armmachinelearning_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearning/armmachinelearning/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9778042723206fbc582306dcb407bddbd73df005/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/examples/Compute/listKeys.json
func ExampleComputeClient_ListKeys() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewComputeClient().ListKeys(ctx, "testrg123", "workspaces123", "compute123", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armmachinelearning.ComputeClientListKeysResponse{
	// 	                            ComputeSecretsClassification: &armmachinelearning.AksComputeSecrets{
	// 		AdminKubeConfig: to.Ptr("admin kube config..."),
	// 		ImagePullSecretName: to.Ptr("the image pull secret name"),
	// 		UserKubeConfig: to.Ptr("user kube config..."),
	// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
	// 	},
	// 	                        }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureMachineLearningServicesManagementClient } = require("@azure/arm-machinelearning");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
 *
 * @summary Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
 * x-ms-original-file: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/examples/Compute/listKeys.json
 */
async function listAksComputeKeys() {
  const subscriptionId =
    process.env["MACHINELEARNING_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["MACHINELEARNING_RESOURCE_GROUP"] || "testrg123";
  const workspaceName = "workspaces123";
  const computeName = "compute123";
  const credential = new DefaultAzureCredential();
  const client = new AzureMachineLearningServicesManagementClient(credential, subscriptionId);
  const result = await client.computeOperations.listKeys(
    resourceGroupName,
    workspaceName,
    computeName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.MachineLearning.Models;
using Azure.ResourceManager.MachineLearning;

// Generated from example definition: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/examples/Compute/listKeys.json
// this example is just showing the usage of "Compute_ListKeys" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MachineLearningComputeResource created on azure
// for more information of creating MachineLearningComputeResource, please refer to the document of MachineLearningComputeResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string workspaceName = "workspaces123";
string computeName = "compute123";
ResourceIdentifier machineLearningComputeResourceId = MachineLearningComputeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, computeName);
MachineLearningComputeResource machineLearningCompute = client.GetMachineLearningComputeResource(machineLearningComputeResourceId);

// invoke the operation
MachineLearningComputeSecrets result = await machineLearningCompute.GetKeysAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
AksComputeSecrets	Secretos relacionados con un proceso de Machine Learning basado en AKS.
ComputeType	El tipo de proceso
DatabricksComputeSecrets	Secretos relacionados con un proceso de Machine Learning basado en Databricks.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
VirtualMachineSecrets	Secretos relacionados con un proceso de Machine Learning basado en AKS.
VirtualMachineSshCredentials	Administración credenciales para la máquina virtual

AksComputeSecrets

Secretos relacionados con un proceso de Machine Learning basado en AKS.

Nombre	Tipo	Description
adminKubeConfig	string	Contenido del archivo kubeconfig que se puede usar para conectarse al clúster de Kubernetes.
computeType	string: AKS	El tipo de proceso
imagePullSecretName	string	Secreto de extracción del Registro de imágenes.
userKubeConfig	string	Contenido del archivo kubeconfig que se puede usar para conectarse al clúster de Kubernetes.

ComputeType

El tipo de proceso

Nombre	Tipo	Description
AKS	string
AmlCompute	string
ComputeInstance	string
DataFactory	string
DataLakeAnalytics	string
Databricks	string
HDInsight	string
Kubernetes	string
SynapseSpark	string
VirtualMachine	string

DatabricksComputeSecrets

Secretos relacionados con un proceso de Machine Learning basado en Databricks.

Nombre	Tipo	Description
computeType	string: Databricks	El tipo de proceso
databricksAccessToken	string	token de acceso para la cuenta de Databricks.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

VirtualMachineSecrets

Secretos relacionados con un proceso de Machine Learning basado en AKS.

Nombre	Tipo	Description
administratorAccount	VirtualMachineSshCredentials	Administración credenciales para la máquina virtual.
computeType	string: VirtualMachine	El tipo de proceso

VirtualMachineSshCredentials

Administración credenciales para la máquina virtual

Nombre	Tipo	Description
password	string	Contraseña de la cuenta de administrador
privateKeyData	string	Datos de clave privada
publicKeyData	string	Datos de clave pública
username	string	Nombre de usuario de la cuenta de administrador