Managed Clusters - Run Command

Odwołanie

Usługa:: AKS

Wersja interfejsu API:: 2024-09-01

Przesyła polecenie do uruchomienia względem klastra zarządzanego.
Usługa AKS utworzy zasobnik, aby uruchomić polecenie . Jest to szczególnie przydatne w przypadku klastrów prywatnych. Aby uzyskać więcej informacji, zobacz polecenia uruchamiania usługi AKS.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand?api-version=2024-09-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
resourceName	path	True	string	Nazwa zasobu klastra zarządzanego. Wzorzec wyrażenia regularnego: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
command	True	string	Polecenie do uruchomienia.
clusterToken		string	Certyfikat AuthToken wystawiony dla aplikacji serwera usługi AAD usługi AKS.
context		string	Zakodowany w formacie base64 plik zip zawierający pliki wymagane przez polecenie .

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RunCommandResult	Polecenie zostało zakończone za pomocą wzorca asynchronicznego, śledzenie według nagłówka lokalizacji. !!! Jest to tylko dla autorestu, nigdy nie otrzymujesz 200 z tego interfejsu API !!
202 Accepted		Akceptowane Nagłówki Location: string
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. Jeśli klaster nie istnieje, zostanie zwrócony błąd 404 (nie znaleziono).

Nazwa

Typ

Opis

200 OK

RunCommandResult

Polecenie zostało zakończone za pomocą wzorca asynchronicznego, śledzenie według nagłówka lokalizacji. !!! Jest to tylko dla autorestu, nigdy nie otrzymujesz 200 z tego interfejsu API !!

202 Accepted

Akceptowane

Nagłówki

Location: string

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. Jeśli klaster nie istnieje, zostanie zwrócony błąd 404 (nie znaleziono).

Zabezpieczenia

azure_auth

Przepływ protokołu 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

submitNewCommand

Przykładowe żądanie

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/runCommand?api-version=2024-09-01

{
  "command": "kubectl apply -f ns.yaml",
  "context": "",
  "clusterToken": ""
}


import com.azure.resourcemanager.containerservice.models.RunCommandRequest;

/**
 * Samples for ManagedClusters RunCommand.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/
     * RunCommandRequest.json
     */
    /**
     * Sample code: submitNewCommand.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void submitNewCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getManagedClusters().runCommand("rg1", "clustername1",
            new RunCommandRequest().withCommand("kubectl apply -f ns.yaml").withContext("")
                .withClusterToken("fakeTokenPlaceholder"),
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python run_command_request.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_clusters.begin_run_command(
        resource_group_name="rg1",
        resource_name="clustername1",
        request_payload={"clusterToken": "", "command": "kubectl apply -f ns.yaml", "context": ""},
    ).result()
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandRequest.json
if __name__ == "__main__":
    main()

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

package armcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandRequest.json
func ExampleManagedClustersClient_BeginRunCommand() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewManagedClustersClient().BeginRunCommand(ctx, "rg1", "clustername1", armcontainerservice.RunCommandRequest{
		ClusterToken: to.Ptr(""),
		Command:      to.Ptr("kubectl apply -f ns.yaml"),
		Context:      to.Ptr(""),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.RunCommandResult = armcontainerservice.RunCommandResult{
	// 	ID: to.Ptr("def7b3ea71bd4f7e9d226ddbc0f00ad9"),
	// 	Properties: &armcontainerservice.CommandResultProperties{
	// 		ExitCode: to.Ptr[int32](0),
	// 		FinishedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-02-17T00:28:33.000Z"); return t}()),
	// 		Logs: to.Ptr("namespace dummy created"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StartedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-02-17T00:28:20.000Z"); return t}()),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).
 *
 * @summary AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandRequest.json
 */
async function submitNewCommand() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const requestPayload = {
    clusterToken: "",
    command: "kubectl apply -f ns.yaml",
    context: "",
  };
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.beginRunCommandAndWait(
    resourceGroupName,
    resourceName,
    requestPayload,
  );
  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

Przykładowa odpowiedź

Kod stanu:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-09-01

Kod stanu:: 200

{
  "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9",
  "properties": {
    "provisioningState": "succeeded",
    "exitCode": 0,
    "startedAt": "2021-02-17T00:28:20Z",
    "finishedAt": "2021-02-17T00:28:33Z",
    "logs": "namespace dummy created"
  }
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi Container Service.
CloudErrorBody	Odpowiedź na błąd z usługi Container Service.
RunCommandRequest	Żądanie polecenia uruchomienia
RunCommandResult	uruchom wynik polecenia.

CloudError

Odpowiedź na błąd z usługi Container Service.

Nazwa	Typ	Opis
error	CloudErrorBody	Szczegółowe informacje o błędzie.

CloudErrorBody

Odpowiedź na błąd z usługi Container Service.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

RunCommandRequest

Żądanie polecenia uruchomienia

Nazwa	Typ	Opis
clusterToken	string	Certyfikat AuthToken wystawiony dla aplikacji serwera usługi AAD usługi AKS.
command	string	Polecenie do uruchomienia.
context	string	Zakodowany w formacie base64 plik zip zawierający pliki wymagane przez polecenie .

RunCommandResult

uruchom wynik polecenia.

Nazwa	Typ	Opis
id	string	Identyfikator polecenia.
properties.exitCode	integer	Kod zakończenia polecenia
properties.finishedAt	string	Czas zakończenia polecenia.
properties.logs	string	Dane wyjściowe polecenia.
properties.provisioningState	string	stan aprowizacji
properties.reason	string	Wyjaśnienie przyczyny niepowodzenia parametru provisioningState (jeśli tak).
properties.startedAt	string	Czas uruchomienia polecenia.

Udostępnij za pośrednictwem

Managed Clusters - Run Command

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

submitNewCommand

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CloudError

CloudErrorBody

RunCommandRequest

RunCommandResult

Dodatkowe zasoby