Managed Clusters - Run Command
Envoie une commande à exécuter sur le cluster managé.
AKS crée un pod pour exécuter la commande. Cela est principalement utile pour les clusters privés. Pour plus d’informations, consultez AKS Run Command.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand?api-version=2024-02-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
resource
|
path | True |
string |
Nom de la ressource de cluster managé. Regex pattern: |
subscription
|
path | True |
string uuid |
ID de l’abonnement cible. La valeur doit être un UUID. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
command | True |
string |
Commande à exécuter. |
clusterToken |
string |
AuthToken émis pour l’application serveur AKS AAD. |
|
context |
string |
Fichier zip codé en base64 contenant les fichiers requis par la commande . |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
commande terminée avec un modèle asynchrone, suivi par en-tête d’emplacement. !!! c’est pour autorest uniquement, vous n’obtenez jamais 200 de cette API !! |
|
202 Accepted |
Accepté Headers Location: string |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. Si le cluster n’existe pas, 404 (Introuvable) est retourné. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
submitNewCommand
Sample Request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/runCommand?api-version=2024-02-01
{
"command": "kubectl apply -f ns.yaml",
"context": "",
"clusterToken": ""
}
Sample Response
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-02-01
{
"id": "def7b3ea71bd4f7e9d226ddbc0f00ad9",
"properties": {
"provisioningState": "succeeded",
"exitCode": 0,
"startedAt": "2021-02-17T00:28:20Z",
"finishedAt": "2021-02-17T00:28:33Z",
"logs": "namespace dummy created"
}
}
Définitions
Nom | Description |
---|---|
Cloud |
Réponse d’erreur du service conteneur. |
Cloud |
Réponse d’erreur du service conteneur. |
Run |
Une demande de commande d’exécution |
Run |
résultat de la commande d’exécution. |
CloudError
Réponse d’erreur du service conteneur.
Nom | Type | Description |
---|---|---|
error |
Détails sur l’erreur. |
CloudErrorBody
Réponse d’erreur du service conteneur.
Nom | Type | Description |
---|---|---|
code |
string |
Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation. |
details |
Liste des détails supplémentaires sur l’erreur. |
|
message |
string |
Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur. |
target |
string |
Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur. |
RunCommandRequest
Une demande de commande d’exécution
Nom | Type | Description |
---|---|---|
clusterToken |
string |
AuthToken émis pour l’application serveur AKS AAD. |
command |
string |
Commande à exécuter. |
context |
string |
Fichier zip codé en base64 contenant les fichiers requis par la commande . |
RunCommandResult
résultat de la commande d’exécution.
Nom | Type | Description |
---|---|---|
id |
string |
ID de commande. |
properties.exitCode |
integer |
Code de sortie de la commande |
properties.finishedAt |
string |
Heure à laquelle la commande s’est terminée. |
properties.logs |
string |
Sortie de commande. |
properties.provisioningState |
string |
état d’approvisionnement |
properties.reason |
string |
Explication de la raison pour laquelle provisioningState a échoué (le cas échéant). |
properties.startedAt |
string |
Heure de démarrage de la commande. |