Compute - List Keys

Usługa:

Machine Learning

Wersja interfejsu API:

2024-04-01

Pobiera wpisy tajne związane z obliczeniami usługi Machine Learning (klucze magazynu, poświadczenia usługi itp.).

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
computeName	path	True	string	Nazwa zasobów obliczeniowych usługi Azure Machine Learning.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
workspaceName	path	True	string	Nazwa obszaru roboczego usługi Azure Machine Learning. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ComputeSecrets: AksComputeSecrets VirtualMachineSecrets DatabricksComputeSecrets	Powodzenie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List AKS Compute Keys

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
AksComputeSecrets	Wpisy tajne związane z obliczeniami usługi Machine Learning na podstawie usługi AKS.
ComputeType	Typ obliczeń
DatabricksComputeSecrets	Wpisy tajne związane z obliczeniami usługi Machine Learning na podstawie usługi Databricks.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
VirtualMachineSecrets	Wpisy tajne związane z obliczeniami usługi Machine Learning na podstawie usługi AKS.
VirtualMachineSshCredentials	Administracja poświadczenia dla maszyny wirtualnej

AksComputeSecrets

Wpisy tajne związane z obliczeniami usługi Machine Learning na podstawie usługi AKS.

Nazwa	Typ	Opis
adminKubeConfig	string	Zawartość pliku kubeconfig, którego można użyć do nawiązania połączenia z klastrem Kubernetes.
computeType	string: AKS	Typ obliczeń
imagePullSecretName	string	Klucz tajny ściągania rejestru obrazów.
userKubeConfig	string	Zawartość pliku kubeconfig, którego można użyć do nawiązania połączenia z klastrem Kubernetes.

ComputeType

Typ obliczeń

Nazwa	Typ	Opis
AKS	string
AmlCompute	string
ComputeInstance	string
DataFactory	string
DataLakeAnalytics	string
Databricks	string
HDInsight	string
Kubernetes	string
SynapseSpark	string
VirtualMachine	string

DatabricksComputeSecrets

Wpisy tajne związane z obliczeniami usługi Machine Learning na podstawie usługi Databricks.

Nazwa	Typ	Opis
computeType	string: Databricks	Typ obliczeń
databricksAccessToken	string	token dostępu dla konta usługi databricks.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

VirtualMachineSecrets

Wpisy tajne związane z obliczeniami usługi Machine Learning na podstawie usługi AKS.

Nazwa	Typ	Opis
administratorAccount	VirtualMachineSshCredentials	Administracja poświadczenia dla maszyny wirtualnej.
computeType	string: VirtualMachine	Typ obliczeń

VirtualMachineSshCredentials

Administracja poświadczenia dla maszyny wirtualnej

Nazwa	Typ	Opis
password	string	Hasło konta administratora
privateKeyData	string	Dane klucza prywatnego
publicKeyData	string	Dane klucza publicznego
username	string	Nazwa użytkownika konta administratora